auth_email_external Class Reference

Inheritance diagram for auth_email_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	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information. More...
static	get_signup_settings ()
	Get the signup required settings and profile fields. More...
static	get_signup_settings_parameters ()
	Describes the parameters for get_signup_settings. More...
static	get_signup_settings_returns ()
	Describes the get_signup_settings 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	signup_user ($username, $password, $firstname, $lastname, $email, $city='', $country='', $recaptchachallengehash='', $recaptcharesponse='', $customprofilefields=array(), $redirect='')
	Get the signup required settings and profile fields. More...
static	signup_user_parameters ()
	Describes the parameters for signup_user. More...
static	signup_user_returns ()
	Describes the signup_user return value. 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	check_signup_enabled ()
	Check if registration is enabled in this site. More...
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.

check_signup_enabled()

static auth_email_external::check_signup_enabled ( )

staticprotected

Check if registration is enabled in this site.

Exceptions

moodle_exception

Since

Moodle 3.2

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

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 core_competency\external, and tool_lp\external.

get_signup_settings()

static auth_email_external::get_signup_settings ( )

static

Get the signup required settings and profile fields.

Return values

array

settings and possible warnings

Since

Moodle 3.2

Exceptions

moodle_exception

get_signup_settings_parameters()

static auth_email_external::get_signup_settings_parameters ( )

static

Describes the parameters for get_signup_settings.

Return values

external_function_parameters

Since

Moodle 3.2

get_signup_settings_returns()

static auth_email_external::get_signup_settings_returns ( )

static

Describes the get_signup_settings return value.

Return values

external_single_structure

Since

Moodle 3.2

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

signup_user()

static auth_email_external::signup_user (   $username,   $password,   $firstname,   $lastname,   $email,   $city = '',   $country = '',   $recaptchachallengehash = '',   $recaptcharesponse = '',   $customprofilefields = array(),   $redirect = ''  )

static

Get the signup required settings and profile fields.

Parameters

string	$username	username
string	$password	plain text password
string	$firstname	the first name(s) of the user
string	$lastname	the family name of the user
string	$email	a valid and unique email address
string	$city	home city of the user
string	$country	home country code
string	$recaptchachallengehash	recaptcha challenge hash
string	$recaptcharesponse	recaptcha response
array	$customprofilefields	user custom fields (also known as user profile fields)
string	$redirect	Site url to redirect the user after confirmation

Return values

array

settings and possible warnings

Since

Moodle 3.2

Exceptions

moodle_exception
invalid_parameter_exception

signup_user_parameters()

static auth_email_external::signup_user_parameters ( )

static

Describes the parameters for signup_user.

Return values

external_function_parameters

Since

Moodle 3.2

signup_user_returns()

static auth_email_external::signup_user_returns ( )

static

Describes the signup_user return value.

Return values

external_single_structure

Since

Moodle 3.2

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/email/classes/external.php