core_auth_external Class Reference

Inheritance diagram for core_auth_external:

Static Public Member Functions
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly. More...
static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...
static	confirm_user ($username, $secret)
	Confirm a user account. More...
static	confirm_user_parameters ()
	Describes the parameters for confirm_user. More...
static	confirm_user_returns ()
	Describes the confirm_user return value. More...
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...
static	is_age_digital_consent_verification_enabled ()
	Checks if age digital consent verification is enabled. More...
static	is_age_digital_consent_verification_enabled_parameters ()
	Describes the parameters for is_age_digital_consent_verification_enabled. More...
static	is_age_digital_consent_verification_enabled_returns ()
	Describes the is_age_digital_consent_verification_enabled return value. More...
static	is_minor ($age, $country)
	Requests a check if a user is digital minor. More...
static	is_minor_parameters ()
	Describes the parameters for the digital minor check. More...
static	is_minor_returns ()
	Describes the is_minor return value. More...
static	request_password_reset ($username='', $email='')
	Requests a password reset. More...
static	request_password_reset_parameters ()
	Describes the parameters for request_password_reset. More...
static	request_password_reset_returns ()
	Describes the request_password_reset return value. More...
static	resend_confirmation_email ($username, $password, $redirect='')
	Requests resend the confirmation email. More...
static	resend_confirmation_email_parameters ()
	Describes the parameters for resend_confirmation_email. More...
static	resend_confirmation_email_returns ()
	Describes the resend_confirmation_email return value. More...
static	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls. More...
static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish! More...
static	validate_context ($context)
	Makes sure user may execute functions in this context. More...
static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters. More...
static	get_context_parameters ()
	Returns a prepared structure to use a context parameters. More...

Member Function Documentation

call_external_function()

static external_api::call_external_function (   $function,   $args,   $ajaxonly = false  )

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array

containing keys for error (bool), exception and data.

clean_returnvalue()

static external_api::clean_returnvalue ( external_description  $description,   $response  )

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed

response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author

2010 Jerome Mouneyrac

Since

Moodle 2.0

confirm_user()

static core_auth_external::confirm_user (   $username,   $secret  )

static

Confirm a user account.

Parameters

string	$username	user name
string	$secret	confirmation secret (random string) used for validating the confirm request

Return values

array

warnings and success status (true if the user was confirmed, false if he was already confirmed)

Since

Moodle 3.2

Exceptions

moodle_exception

confirm_user_parameters()

static core_auth_external::confirm_user_parameters ( )

static

Describes the parameters for confirm_user.

Return values

external_function_parameters

Since

Moodle 3.2

confirm_user_returns()

static core_auth_external::confirm_user_returns ( )

static

Describes the confirm_user return value.

Return values

external_single_structure

Since

Moodle 3.2

external_function_info()

static external_api::external_function_info (   $function,   $strictness = MUST_EXIST  )

staticinherited

Returns detailed function information.

Parameters

string | object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

description or false if not found or exception thrown

Since

Moodle 2.0

get_context_from_params()

static external_api::get_context_from_params (   $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper::get_all_levels() for a list of valid context levels.

Parameters

array

$param

Since

Moodle 2.6

Exceptions

invalid_parameter_exception

Return values

context

get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in tool_lp\external, and core_competency\external.

is_age_digital_consent_verification_enabled()

static core_auth_external::is_age_digital_consent_verification_enabled ( )

static

Checks if age digital consent verification is enabled.

Return values

array

status (true if digital consent verification is enabled, false otherwise.)

Since

Moodle 3.3

Exceptions

moodle_exception

is_age_digital_consent_verification_enabled_parameters()

static core_auth_external::is_age_digital_consent_verification_enabled_parameters ( )

static

Describes the parameters for is_age_digital_consent_verification_enabled.

Return values

external_function_parameters

Since

Moodle 3.3

is_age_digital_consent_verification_enabled_returns()

static core_auth_external::is_age_digital_consent_verification_enabled_returns ( )

static

Describes the is_age_digital_consent_verification_enabled return value.

Return values

external_single_structure

Since

Moodle 3.3

is_minor()

static core_auth_external::is_minor (   $age,   $country  )

static

Requests a check if a user is digital minor.

Parameters

int	$age	User age
string	$country	Country of residence

Return values

array

status (true if the user is a minor, false otherwise)

Since

Moodle 3.4

Exceptions

moodle_exception

is_minor_parameters()

static core_auth_external::is_minor_parameters ( )

static

Describes the parameters for the digital minor check.

Return values

external_function_parameters

Since

Moodle 3.4

is_minor_returns()

static core_auth_external::is_minor_returns ( )

static

Describes the is_minor return value.

Return values

external_single_structure

Since

Moodle 3.4

request_password_reset()

static core_auth_external::request_password_reset (   $username = '',   $email = ''  )

static

Requests a password reset.

Parameters

string	$username	user name
string	$email	user email

Return values

array

warnings and success status (including notices and errors while processing)

Since

Moodle 3.4

Exceptions

moodle_exception

request_password_reset_parameters()

static core_auth_external::request_password_reset_parameters ( )

static

Describes the parameters for request_password_reset.

Return values

external_function_parameters

Since

Moodle 3.4

request_password_reset_returns()

static core_auth_external::request_password_reset_returns ( )

static

Describes the request_password_reset return value.

Return values

external_single_structure

Since

Moodle 3.4

resend_confirmation_email()

static core_auth_external::resend_confirmation_email (   $username,   $password,   $redirect = ''  )

static

Requests resend the confirmation email.

Parameters

string	$username	user name
string	$password	plain text password
string	$redirect	redirect the user to this site url after confirmation

Return values

array

warnings and success status

Since

Moodle 3.6

Exceptions

moodle_exception

resend_confirmation_email_parameters()

static core_auth_external::resend_confirmation_email_parameters ( )

static

Describes the parameters for resend_confirmation_email.

Return values

external_function_parameters

Since

Moodle 3.6

resend_confirmation_email_returns()

static core_auth_external::resend_confirmation_email_returns ( )

static

Describes the resend_confirmation_email return value.

Return values

external_single_structure

Since

Moodle 3.6

set_context_restriction()

static external_api::set_context_restriction (   $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass

$context

the context restriction

Since

Moodle 2.0

set_timeout()

static external_api::set_timeout (   $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int

$seconds

max expected time the next operation needs

Since

Moodle 2.0

validate_context()

static external_api::validate_context (   $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass

$context

Since

Moodle 2.0

validate_parameters()

static external_api::validate_parameters ( external_description  $description,   $params  )

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed

params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since

Moodle 2.0

---

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

• auth/classes/external.php