Moodle APIs
3.8
Moodle 3.8.6 (Build: 20201109)
|
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... | |
|
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.
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. |
array | containing keys for error (bool), exception and data. |
|
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.
external_description | $description | description of the return values |
mixed | $response | the actual response |
mixed | response with added defaults for optional items, invalid_response_exception thrown if any problem found |
|
static |
Confirm a user account.
string | $username | user name |
string | $secret | confirmation secret (random string) used for validating the confirm request |
array | warnings and success status (true if the user was confirmed, false if he was already confirmed) |
moodle_exception |
|
static |
Describes the parameters for confirm_user.
external_function_parameters |
|
static |
|
staticinherited |
Returns detailed function information.
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 |
stdClass | description or false if not found or exception thrown |
|
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.
array | $param |
invalid_parameter_exception |
context |
|
staticprotectedinherited |
Returns a prepared structure to use a context parameters.
external_single_structure |
Reimplemented in core_competency\external, and tool_lp\external.
|
static |
Checks if age digital consent verification is enabled.
array | status (true if digital consent verification is enabled, false otherwise.) |
moodle_exception |
|
static |
Describes the parameters for is_age_digital_consent_verification_enabled.
external_function_parameters |
|
static |
Describes the is_age_digital_consent_verification_enabled return value.
external_single_structure |
|
static |
Requests a check if a user is digital minor.
int | $age | User age |
string | $country | Country of residence |
array | status (true if the user is a minor, false otherwise) |
moodle_exception |
|
static |
Describes the parameters for the digital minor check.
external_function_parameters |
|
static |
|
static |
Requests a password reset.
string | $username | user name |
string | user email |
array | warnings and success status (including notices and errors while processing) |
moodle_exception |
|
static |
Describes the parameters for request_password_reset.
external_function_parameters |
|
static |
Describes the request_password_reset return value.
external_single_structure |
|
static |
Requests resend the confirmation email.
string | $username | user name |
string | $password | plain text password |
string | $redirect | redirect the user to this site url after confirmation |
array | warnings and success status |
moodle_exception |
|
static |
Describes the parameters for resend_confirmation_email.
external_function_parameters |
|
static |
Describes the resend_confirmation_email return value.
external_single_structure |
|
staticinherited |
Set context restriction for all following subsequent function calls.
stdClass | $context | the context restriction |
|
staticinherited |
This method has to be called before every operation that takes a longer time to finish!
int | $seconds | max expected time the next operation needs |
|
staticinherited |
Makes sure user may execute functions in this context.
stdClass | $context |
|
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.
external_description | $description | description of parameters |
mixed | $params | the actual parameters |
mixed | params with added defaults for optional items, invalid_parameters_exception thrown if any problem found |