 |
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
|
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
Class core_customfield_external. 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_category ($component, $area, $itemid) |
| Create category function. | |
| static | create_category_parameters () |
| Parameters for create category. | |
| static | create_category_returns () |
| Return for create category. | |
| static | delete_category ($id) |
| Delete category function. | |
| static | delete_category_parameters () |
| Parameters for delete category. | |
| static | delete_category_returns () |
| Return for delete category. | |
| static | delete_field ($id) |
| Delete custom field function. | |
| static | delete_field_parameters () |
| Parameters for delete_field. | |
| static | delete_field_returns () |
| Return for delete_field. | |
| static | external_function_info ($function, $strictness=MUST_EXIST) |
| Returns detailed function information. | |
| static | move_category (int $id, int $beforeid) |
| Reorder categories. | |
| static | move_category_parameters () |
| Return for move category. | |
| static | move_category_returns () |
| Return for move category. | |
| static | move_field ($id, $categoryid, $beforeid) |
| Move/reorder field. | |
| static | move_field_parameters () |
| Parameters for move field. | |
| static | move_field_returns () |
| Return for move field. | |
| static | reload_template ($component, $area, $itemid) |
| Reload template function. | |
| static | reload_template_parameters () |
| Parameters for reload template function. | |
| static | reload_template_returns () |
| Ajax returns on reload template. | |
| 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. | |
Class core_customfield_external.
|
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 category function.
| string | $component | |
| string | $area | |
| int | $itemid |
| mixed |
|
static |
Parameters for create category.
| external_function_parameters |
|
static |
Delete category function.
| int | $id |
|
static |
Parameters for delete category.
| external_function_parameters |
|
static |
Delete custom field function.
| int | $id |
|
static |
Parameters for delete_field.
| external_function_parameters |
|
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 |
Reorder categories.
Move category to the new position
| int | $id | category id |
| int | $beforeid |
|
static |
Return for move category.
| external_function_parameters |
|
static |
Move/reorder field.
Move a field to another category and/or change sortorder of fields
| int | $id | field id |
| int | $categoryid | |
| int | $beforeid |
|
static |
Parameters for move field.
| external_function_parameters |
|
static |
Reload template function.
| string | $component | |
| string | $area | |
| int | $itemid |
| array|object|stdClass |
|
static |
Parameters for reload template function.
| external_function_parameters |
|
static |
Ajax returns on reload template.
| 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 |
|
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