Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
enrol_guest\external\validate_password Class Reference
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.
 

Member Function Documentation

◆ execute()

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$instanceidinstance id of guest enrolment plugin
string$passwordthe course password
Return values
stdClassvalidation result info

◆ execute_parameters()

static enrol_guest\external\validate_password::execute_parameters ( )
static

Webservice parameters.

Return values
external_function_parameters

◆ execute_returns()

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: