This is the external method validating a guest password. More...

Inheritance diagram for enrol_guest\external\validate_password:

Static Public Member Functions
static	execute (int $instanceid, string $password)
	Perform password validation.

static	execute_parameters ()
	Webservice parameters.

static	execute_returns ()
	Describes the return information.

Detailed Description

This is the external method validating a guest password.

Member Function Documentation

static enrol_guest\external\validate_password::execute	(	int	$instanceid,
		string	$password )

static

Perform password validation.

If password is correct: keep it as user preference. If password is not correct: remove existing user preference (if any)

Exceptions

moodle_exception

Parameters

int	$instanceid	instance id of guest enrolment plugin
string	$password	the course password

Return values

stdClass validation result info

static enrol_guest\external\validate_password::execute_parameters ( )

static

Webservice parameters.

Return values

external_function_parameters

static enrol_guest\external\validate_password::execute_returns ( )

static

Describes the return information.

Return values

external_single_structure

The documentation for this class was generated from the following file: