 |
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
|
Moodle PHP Documentation 4.1
Moodle 4.1.11 (Build: 20240610) (c8c84b4af18)
|
Backup 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_async_backup_links_backup ($filename, $contextid, $backupid) |
| Get the data to be used when generating the table row for an asynchronous backup, the table row updates via ajax when backup is complete. | |
| static | get_async_backup_links_backup_parameters () |
| Returns description of method parameters. | |
| static | get_async_backup_links_backup_returns () |
| Returns description of method result value. | |
| static | get_async_backup_links_restore ($backupid, $contextid) |
| Get the data to be used when generating the table row for an asynchronous restore, the table row updates via ajax when restore is complete. | |
| static | get_async_backup_links_restore_parameters () |
| Returns description of method parameters. | |
| static | get_async_backup_links_restore_returns () |
| Returns description of method result value. | |
| static | get_async_backup_progress ($backupids, $contextid) |
| Get asynchronous backup progress. | |
| static | get_async_backup_progress_parameters () |
| Returns description of method parameters. | |
| static | get_async_backup_progress_returns () |
| Returns description of method result value. | |
| static | get_copy_progress ($copies) |
| Get the data to be used when generating the table row for a course copy, the table row updates via ajax when copy is complete. | |
| static | get_copy_progress_parameters () |
| Returns description of method parameters. | |
| static | get_copy_progress_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 | submit_copy_form ($jsonformdata) |
| Submit the course group form. | |
| static | submit_copy_form_parameters () |
| Returns description of method parameters. | |
| static | submit_copy_form_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. | |
Backup 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 |
|
static |
Get the data to be used when generating the table row for an asynchronous backup, the table row updates via ajax when backup is complete.
| string | $filename | The file name of the backup file. |
| int | $contextid | The context the backup relates to. |
| string | $backupid | The backup ID to get the backup settings. |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
static |
Get the data to be used when generating the table row for an asynchronous restore, the table row updates via ajax when restore is complete.
| string | $backupid | The id of the backup record. |
| int | $contextid | The context the restore relates to. |
| array\$results | The array of results. |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
static |
Get asynchronous backup progress.
| string | $backupids | The ids of the backup to get progress for. |
| int | $contextid | The context the backup relates to. |
| array\$results | The array of results. |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
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 the data to be used when generating the table row for a course copy, the table row updates via ajax when copy is complete.
| array | $copies | Array of ids. |
| array\$results | The array of results. |
|
static |
Returns description of method parameters.
| external_function_parameters |
|
static |
|
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 |
Submit the course group form.
| string | $jsonformdata | The data from the form, encoded as a json array. |
| int | new group id. |
|
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