 |
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
|
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
User external functions. More...
Static Public Member Functions | |
| static | call_external_function ($function, $args, $ajaxonly=false) |
| Call an external function validating all params/returns correctly. | |
| static | clean_returnvalue (external_description $description, $response) |
| Clean response If a response attribute is unknown from the description, we just ignore the attribute. | |
| static | create_users ($users) |
| Create one or more users. | |
| static | create_users_parameters () |
| Returns description of method parameters. | |
| static | create_users_returns () |
| Returns description of method result value. | |
| static | delete_users ($userids) |
| Delete users. | |
| static | delete_users_parameters () |
| Returns description of method parameters. | |
| static | delete_users_returns () |
| Returns description of method result value. | |
| static | external_function_info ($function, $strictness=MUST_EXIST) |
| Returns detailed function information. | |
| static | get_users_by_field ($field, $values) |
| Get user information for a unique field. | |
| static | get_users_by_field_parameters () |
| Returns description of method parameters. | |
| static | set_context_restriction ($context) |
| Set context restriction for all following subsequent function calls. | |
| static | set_timeout ($seconds=360) |
| This method has to be called before every operation that takes a longer time to finish! | |
| static | update_user_preferences ($userid=0, $emailstop=null, $preferences=array()) |
| Update the user's preferences. | |
| static | update_user_preferences_parameters () |
| Returns description of method parameters. | |
| static | update_user_preferences_returns () |
| Returns description of method result value. | |
| static | update_users ($users) |
| Update users. | |
| static | update_users_parameters () |
| Returns description of method parameters. | |
| static | update_users_returns () |
| Returns description of method result value. | |
| static | validate_context ($context) |
| Makes sure user may execute functions in this context. | |
| static | validate_parameters (external_description $description, $params) |
| Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. | |
Static Protected Member Functions | |
| static | get_context_from_params ($param) |
| Get context from passed parameters. | |
| static | get_context_parameters () |
| Returns a prepared structure to use a context parameters. | |
User external functions.
|
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 |
Create one or more users.
| invalid_parameter_exception |
| array | $users | An array of users to create. |
| array | An array of arrays |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
static |
Delete users.
| moodle_exception |
| array | $userids |
| null |
|
static |
Returns description of method parameters.
| 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 |
| coding_exception | for any property and/or method that is missing or invalid |
|
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 |
Get user information for a unique field.
| coding_exception | |
| invalid_parameter_exception |
| string | $field | |
| array | $values |
| array | An array of arrays containg user profiles. |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
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 |
|
static |
Update the user's preferences.
| int | $userid | |
| bool | null | $emailstop | |
| array | $preferences |
| null |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
static |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
staticinherited |
|
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 |
1.11.0