 |
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
|
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
Enrol 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 | external_function_info ($function, $strictness=MUST_EXIST) |
| Returns detailed function information. | |
| static | get_enrolled_users_with_capability ($coursecapabilities, $options) |
| Return users that have the capabilities for each course specified. | |
| static | get_enrolled_users_with_capability_parameters () |
| Returns description of method parameters. | |
| static | get_enrolled_users_with_capability_returns () |
| Returns description of method result value. | |
| static | get_potential_users ($courseid, $enrolid, $search, $searchanywhere, $page, $perpage) |
| Get potential users. | |
| static | get_potential_users_parameters () |
| Returns description of method parameters value. | |
| static | get_users_courses ($userid, $returnusercount=true) |
| Get list of courses user is enrolled in (only active enrolments are returned). | |
| static | get_users_courses_parameters () |
| Returns description of method parameters. | |
| static | get_users_courses_returns () |
| Returns description of method result value. | |
| 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 | 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. | |
Enrol 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 |
|
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 |
Return users that have the capabilities for each course specified.
For each course and capability specified, a list of the users that are enrolled in the course and have that capability are returned.
| array | $coursecapabilities | array of course ids and associated capability names {courseid, {capabilities}} |
| array | An array of arrays describing users for each associated courseid and capability |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
Returns description of method result value.
| external_multiple_structure |
|
static |
Get potential users.
| int | $courseid | Course id |
| int | $enrolid | Enrolment id |
| string | $search | The query |
| boolean | $searchanywhere | Match anywhere in the string |
| int | $page | Page number |
| int | $perpage | Max per page |
| array | An array of users |
|
static |
Returns description of method parameters value.
| external_description |
|
static |
Get list of courses user is enrolled in (only active enrolments are returned).
Please note the current user must be able to access the course, otherwise the course is not included.
| int | $userid | |
| bool | $returnusercount |
| array | of courses |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
Returns description of method result value.
| external_description |
|
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 |
|
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