Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
Class external. More...
Static Public Member Functions | |
static | approve_data_request ($requestid) |
Approve a data request. | |
static | approve_data_request_parameters () |
Parameter description for approve_data_request(). | |
static | approve_data_request_returns () |
Parameter description for approve_data_request(). | |
static | bulk_approve_data_requests ($requestids) |
Bulk approve bulk data request. | |
static | bulk_approve_data_requests_parameters () |
Parameter description for bulk_approve_data_requests(). | |
static | bulk_approve_data_requests_returns () |
Parameter description for bulk_approve_data_requests(). | |
static | bulk_deny_data_requests ($requestids) |
Bulk deny data requests. | |
static | bulk_deny_data_requests_parameters () |
Parameter description for bulk_deny_data_requests(). | |
static | bulk_deny_data_requests_returns () |
Parameter description for bulk_deny_data_requests(). | |
static | cancel_data_request ($requestid) |
Cancel a data request. | |
static | cancel_data_request_parameters () |
Parameter description for cancel_data_request(). | |
static | cancel_data_request_returns () |
Parameter description for cancel_data_request(). | |
static | confirm_contexts_for_deletion ($ids) |
Confirm a given array of expired context record IDs. | |
static | confirm_contexts_for_deletion_parameters () |
Parameters for confirm_contexts_for_deletion(). | |
static | confirm_contexts_for_deletion_returns () |
Returns for confirm_contexts_for_deletion(). | |
static | contact_dpo ($message) |
Make a general enquiry to a DPO. | |
static | contact_dpo_parameters () |
Parameter description for contact_dpo(). | |
static | contact_dpo_returns () |
Parameter description for contact_dpo(). | |
static | create_category_form ($jsonformdata) |
Creates a data category from form data. | |
static | create_category_form_parameters () |
Parameter description for create_category_form(). | |
static | create_category_form_returns () |
Returns for create_category_form(). | |
static | create_purpose_form ($jsonformdata) |
Creates a data purpose from form data. | |
static | create_purpose_form_parameters () |
Parameter description for create_purpose_form(). | |
static | create_purpose_form_returns () |
Returns for create_purpose_form(). | |
static | delete_category ($id) |
Deletes a data category. | |
static | delete_category_parameters () |
Parameter description for delete_category(). | |
static | delete_category_returns () |
Parameter description for delete_category(). | |
static | delete_purpose ($id) |
Deletes a data purpose. | |
static | delete_purpose_parameters () |
Parameter description for delete_purpose(). | |
static | delete_purpose_returns () |
Parameter description for delete_purpose(). | |
static | deny_data_request ($requestid) |
Deny a data request. | |
static | deny_data_request_parameters () |
Parameter description for deny_data_request(). | |
static | deny_data_request_returns () |
Parameter description for deny_data_request(). | |
static | get_activity_options ($nodefaults) |
Fetches a list of activity options for setting data registry defaults. | |
static | get_activity_options_parameters () |
Parameters for get_activity_options(). | |
static | get_activity_options_returns () |
Returns for get_category_options(). | |
static | get_category_options ($includeinherit, $includenotset) |
Fetches a list of data category options containing category IDs as keys and the category name for the value. | |
static | get_category_options_parameters () |
Parameters for get_category_options(). | |
static | get_category_options_returns () |
Returns for get_category_options(). | |
static | get_data_request ($requestid) |
Fetch the details of a user's data request. | |
static | get_data_request_parameters () |
Parameter description for get_data_request(). | |
static | get_data_request_returns () |
Parameter description for get_data_request(). | |
static | get_purpose_options ($includeinherit, $includenotset) |
Fetches a list of data storage purposes containing purpose IDs as keys and the purpose name for the value. | |
static | get_purpose_options_parameters () |
Parameters for get_purpose_options(). | |
static | get_purpose_options_returns () |
Returns for get_purpose_options(). | |
static | get_users ($query) |
Fetch the details of a user's data request. | |
static | get_users_parameters () |
Parameter description for get_data_request(). | |
static | get_users_returns () |
Parameter description for get_users(). | |
static | mark_complete ($requestid) |
Mark a user's general enquiry's status as complete. | |
static | mark_complete_parameters () |
Parameter description for mark_complete(). | |
static | mark_complete_returns () |
Parameter description for mark_complete(). | |
static | set_context_defaults ($contextlevel, $category, $purpose, $activity, $override) |
Updates the default category and purpose for a given context level (and optionally, a plugin). | |
static | set_context_defaults_parameters () |
Parameters for set_context_defaults(). | |
static | set_context_defaults_returns () |
Returns for set_context_defaults(). | |
static | set_context_form ($jsonformdata) |
Creates a data category from form data. | |
static | set_context_form_parameters () |
Parameter description for set_context_form(). | |
static | set_context_form_returns () |
Returns for set_context_form(). | |
static | set_contextlevel_form ($jsonformdata) |
Creates a data category from form data. | |
static | set_contextlevel_form_parameters () |
Parameter description for set_contextlevel_form(). | |
static | set_contextlevel_form_returns () |
Returns for set_contextlevel_form(). | |
static | tree_extra_branches ($contextid, $element) |
Returns tree extra branches. | |
static | tree_extra_branches_parameters () |
Parameter description for tree_extra_branches(). | |
static | tree_extra_branches_returns () |
Returns for tree_extra_branches(). | |
Class external.
The external API for the Data Privacy tool.
|
static |
Approve a data request.
int | $requestid | The request ID. |
array |
coding_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception | |
moodle_exception |
|
static |
Parameter description for approve_data_request().
external_function_parameters |
|
static |
Parameter description for approve_data_request().
core_external\external_description |
|
static |
Bulk approve bulk data request.
array | $requestids | Array consisting the request ID's. |
array |
coding_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception | |
moodle_exception |
|
static |
Parameter description for bulk_approve_data_requests().
external_function_parameters |
|
static |
Parameter description for bulk_approve_data_requests().
core_external\external_description |
|
static |
Bulk deny data requests.
array | $requestids | Array consisting of request ID's. |
array |
coding_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception | |
moodle_exception |
|
static |
Parameter description for bulk_deny_data_requests().
external_function_parameters |
|
static |
Parameter description for bulk_deny_data_requests().
core_external\external_description |
|
static |
Cancel a data request.
int | $requestid | The request ID. |
array |
invalid_persistent_exception | |
coding_exception | |
invalid_parameter_exception | |
restricted_context_exception |
|
static |
Parameter description for cancel_data_request().
external_function_parameters |
|
static |
Parameter description for cancel_data_request().
core_external\external_description |
|
static |
Confirm a given array of expired context record IDs.
int[] | $ids | Array of record IDs from the expired contexts table. |
array |
coding_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception |
|
static |
Parameters for confirm_contexts_for_deletion().
external_function_parameters |
|
static |
Returns for confirm_contexts_for_deletion().
external_single_structure |
|
static |
Make a general enquiry to a DPO.
string | $message | The message to be sent to the DPO. |
array |
coding_exception | |
invalid_parameter_exception | |
invalid_persistent_exception | |
restricted_context_exception | |
dml_exception | |
moodle_exception |
|
static |
|
static |
Parameter description for contact_dpo().
core_external\external_description |
|
static |
Creates a data category from form data.
string | $jsonformdata |
array |
|
static |
Parameter description for create_category_form().
external_function_parameters |
|
static |
|
static |
Creates a data purpose from form data.
string | $jsonformdata |
array |
|
static |
Parameter description for create_purpose_form().
external_function_parameters |
|
static |
|
static |
Deletes a data category.
int | $id | The ID. |
array |
invalid_persistent_exception | |
coding_exception | |
invalid_parameter_exception |
|
static |
Parameter description for delete_category().
external_function_parameters |
|
static |
Parameter description for delete_category().
external_single_structure |
|
static |
Deletes a data purpose.
int | $id | The ID. |
array |
invalid_persistent_exception | |
coding_exception | |
invalid_parameter_exception |
|
static |
Parameter description for delete_purpose().
external_function_parameters |
|
static |
|
static |
Deny a data request.
int | $requestid | The request ID. |
array |
coding_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception | |
moodle_exception |
|
static |
Parameter description for deny_data_request().
external_function_parameters |
|
static |
Parameter description for deny_data_request().
core_external\external_description |
|
static |
Fetches a list of activity options for setting data registry defaults.
boolean | $nodefaults | If false, it will fetch all of the activities. Otherwise, it will only fetch the activities that don't have defaults yet (e.g. when adding a new activity module defaults). |
array |
|
static |
Parameters for get_activity_options().
external_function_parameters |
|
static |
Returns for get_category_options().
external_single_structure |
|
static |
Fetches a list of data category options containing category IDs as keys and the category name for the value.
bool | $includeinherit | Whether to include the "Inherit" option. |
bool | $includenotset | Whether to include the "Not set" option. |
array |
|
static |
Parameters for get_category_options().
external_function_parameters |
|
static |
Returns for get_category_options().
external_single_structure |
|
static |
Fetch the details of a user's data request.
int | $requestid | The request ID. |
array |
coding_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception | |
moodle_exception |
|
static |
Parameter description for get_data_request().
external_function_parameters |
|
static |
Parameter description for get_data_request().
core_external\external_description |
|
static |
Fetches a list of data storage purposes containing purpose IDs as keys and the purpose name for the value.
bool | $includeinherit | Whether to include the "Inherit" option. |
bool | $includenotset | Whether to include the "Not set" option. |
array |
|
static |
Parameters for get_purpose_options().
external_function_parameters |
|
static |
Returns for get_purpose_options().
external_single_structure |
|
static |
Fetch the details of a user's data request.
string | $query | The search request. |
array |
required_capability_exception | |
dml_exception | |
invalid_parameter_exception | |
restricted_context_exception |
|
static |
Parameter description for get_data_request().
external_function_parameters |
|
static |
Parameter description for get_users().
core_external\external_description |
coding_exception |
|
static |
Mark a user's general enquiry's status as complete.
int | $requestid | The request ID of the general enquiry. |
array |
coding_exception | |
invalid_parameter_exception | |
invalid_persistent_exception | |
restricted_context_exception | |
dml_exception | |
moodle_exception |
|
static |
Parameter description for mark_complete().
external_function_parameters |
|
static |
Parameter description for mark_complete().
core_external\external_description |
|
static |
Updates the default category and purpose for a given context level (and optionally, a plugin).
int | $contextlevel | The context level. |
int | $category | The ID matching the category. |
int | $purpose | The ID matching the purpose record. |
int | $activity | The name of the activity that we're making a defaults configuration for. |
bool | $override | Whether to override the purpose/categories of existing instances to these defaults. |
array |
|
static |
Parameters for set_context_defaults().
external_function_parameters |
|
static |
Returns for set_context_defaults().
external_single_structure |
|
static |
Creates a data category from form data.
string | $jsonformdata |
array |
|
static |
Parameter description for set_context_form().
external_function_parameters |
|
static |
|
static |
Creates a data category from form data.
string | $jsonformdata |
array |
|
static |
Parameter description for set_contextlevel_form().
external_function_parameters |
|
static |
|
static |
Returns tree extra branches.
int | $contextid | |
string | $element |
array |
|
static |
Parameter description for tree_extra_branches().
external_function_parameters |
|
static |