Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
- Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
- PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/admin/tool/dataprivacy/classes/ -> external.php (source)
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]
Class containing the external API functions functions for the Data Privacy tool.
| Copyright: | 2018 Jun Pataleta |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 1648 lines (57 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
external:: (64 methods):
cancel_data_request_parameters()
cancel_data_request()
cancel_data_request_returns()
contact_dpo_parameters()
contact_dpo()
contact_dpo_returns()
mark_complete_parameters()
mark_complete()
mark_complete_returns()
get_data_request_parameters()
get_data_request()
get_data_request_returns()
approve_data_request_parameters()
approve_data_request()
approve_data_request_returns()
bulk_approve_data_requests_parameters()
bulk_approve_data_requests()
bulk_approve_data_requests_returns()
deny_data_request_parameters()
deny_data_request()
deny_data_request_returns()
bulk_deny_data_requests_parameters()
bulk_deny_data_requests()
bulk_deny_data_requests_returns()
get_users_parameters()
get_users()
get_users_returns()
create_purpose_form_parameters()
create_purpose_form()
create_purpose_form_returns()
delete_purpose_parameters()
delete_purpose()
delete_purpose_returns()
create_category_form_parameters()
create_category_form()
create_category_form_returns()
delete_category_parameters()
delete_category()
delete_category_returns()
set_contextlevel_form_parameters()
set_contextlevel_form()
set_contextlevel_form_returns()
set_context_form_parameters()
set_context_form()
set_context_form_returns()
tree_extra_branches_parameters()
tree_extra_branches()
tree_extra_branches_returns()
confirm_contexts_for_deletion_parameters()
confirm_contexts_for_deletion()
confirm_contexts_for_deletion_returns()
set_context_defaults_parameters()
set_context_defaults()
set_context_defaults_returns()
get_category_options_parameters()
get_category_options()
get_category_options_returns()
get_purpose_options_parameters()
get_purpose_options()
get_purpose_options_returns()
get_activity_options_parameters()
get_activity_options()
get_activity_options_returns()
get_tree_node_structure()
Class external.
The external API for the Data Privacy tool.
The external API for the Data Privacy tool.
| cancel_data_request_parameters() X-Ref |
| Parameter description for cancel_data_request(). return: external_function_parameters |
| cancel_data_request($requestid) X-Ref |
| Cancel a data request. param: int $requestid The request ID. return: array |
| cancel_data_request_returns() X-Ref |
| Parameter description for cancel_data_request(). return: external_description |
| contact_dpo_parameters() X-Ref |
| Parameter description for contact_dpo(). return: external_function_parameters |
| contact_dpo($message) X-Ref |
| Make a general enquiry to a DPO. param: string $message The message to be sent to the DPO. return: array |
| contact_dpo_returns() X-Ref |
| Parameter description for contact_dpo(). return: external_description |
| mark_complete_parameters() X-Ref |
| Parameter description for mark_complete(). return: external_function_parameters |
| mark_complete($requestid) X-Ref |
| Mark a user's general enquiry's status as complete. param: int $requestid The request ID of the general enquiry. return: array |
| mark_complete_returns() X-Ref |
| Parameter description for mark_complete(). return: external_description |
| get_data_request_parameters() X-Ref |
| Parameter description for get_data_request(). return: external_function_parameters |
| get_data_request($requestid) X-Ref |
| Fetch the details of a user's data request. param: int $requestid The request ID. return: array |
| get_data_request_returns() X-Ref |
| Parameter description for get_data_request(). return: external_description |
| approve_data_request_parameters() X-Ref |
| Parameter description for approve_data_request(). return: external_function_parameters |
| approve_data_request($requestid) X-Ref |
| Approve a data request. param: int $requestid The request ID. return: array |
| approve_data_request_returns() X-Ref |
| Parameter description for approve_data_request(). return: external_description |
| bulk_approve_data_requests_parameters() X-Ref |
| Parameter description for bulk_approve_data_requests(). return: external_function_parameters |
| bulk_approve_data_requests($requestids) X-Ref |
| Bulk approve bulk data request. param: array $requestids Array consisting the request ID's. return: array |
| bulk_approve_data_requests_returns() X-Ref |
| Parameter description for bulk_approve_data_requests(). return: external_description |
| deny_data_request_parameters() X-Ref |
| Parameter description for deny_data_request(). return: external_function_parameters |
| deny_data_request($requestid) X-Ref |
| Deny a data request. param: int $requestid The request ID. return: array |
| deny_data_request_returns() X-Ref |
| Parameter description for deny_data_request(). return: external_description |
| bulk_deny_data_requests_parameters() X-Ref |
| Parameter description for bulk_deny_data_requests(). return: external_function_parameters |
| bulk_deny_data_requests($requestids) X-Ref |
| Bulk deny data requests. param: array $requestids Array consisting of request ID's. return: array |
| bulk_deny_data_requests_returns() X-Ref |
| Parameter description for bulk_deny_data_requests(). return: external_description |
| get_users_parameters() X-Ref |
| Parameter description for get_data_request(). return: external_function_parameters |
| get_users($query) X-Ref |
| Fetch the details of a user's data request. param: string $query The search request. return: array |
| get_users_returns() X-Ref |
| Parameter description for get_users(). return: external_description |
| create_purpose_form_parameters() X-Ref |
| Parameter description for create_purpose_form(). return: external_function_parameters |
| create_purpose_form($jsonformdata) X-Ref |
| Creates a data purpose from form data. param: string $jsonformdata return: array |
| create_purpose_form_returns() X-Ref |
| Returns for create_purpose_form(). return: external_single_structure |
| delete_purpose_parameters() X-Ref |
| Parameter description for delete_purpose(). return: external_function_parameters |
| delete_purpose($id) X-Ref |
| Deletes a data purpose. param: int $id The ID. return: array |
| delete_purpose_returns() X-Ref |
| Parameter description for delete_purpose(). return: external_single_structure |
| create_category_form_parameters() X-Ref |
| Parameter description for create_category_form(). return: external_function_parameters |
| create_category_form($jsonformdata) X-Ref |
| Creates a data category from form data. param: string $jsonformdata return: array |
| create_category_form_returns() X-Ref |
| Returns for create_category_form(). return: external_single_structure |
| delete_category_parameters() X-Ref |
| Parameter description for delete_category(). return: external_function_parameters |
| delete_category($id) X-Ref |
| Deletes a data category. param: int $id The ID. return: array |
| delete_category_returns() X-Ref |
| Parameter description for delete_category(). return: external_single_structure |
| set_contextlevel_form_parameters() X-Ref |
| Parameter description for set_contextlevel_form(). return: external_function_parameters |
| set_contextlevel_form($jsonformdata) X-Ref |
| Creates a data category from form data. param: string $jsonformdata return: array |
| set_contextlevel_form_returns() X-Ref |
| Returns for set_contextlevel_form(). return: external_single_structure |
| set_context_form_parameters() X-Ref |
| Parameter description for set_context_form(). return: external_function_parameters |
| set_context_form($jsonformdata) X-Ref |
| Creates a data category from form data. param: string $jsonformdata return: array |
| set_context_form_returns() X-Ref |
| Returns for set_context_form(). return: external_single_structure |
| tree_extra_branches_parameters() X-Ref |
| Parameter description for tree_extra_branches(). return: external_function_parameters |
| tree_extra_branches($contextid, $element) X-Ref |
| Returns tree extra branches. param: int $contextid param: string $element return: array |
| tree_extra_branches_returns() X-Ref |
| Returns for tree_extra_branches(). return: external_single_structure |
| confirm_contexts_for_deletion_parameters() X-Ref |
| Parameters for confirm_contexts_for_deletion(). return: external_function_parameters |
| confirm_contexts_for_deletion($ids) X-Ref |
| Confirm a given array of expired context record IDs param: int[] $ids Array of record IDs from the expired contexts table. return: array |
| confirm_contexts_for_deletion_returns() X-Ref |
| Returns for confirm_contexts_for_deletion(). return: external_single_structure |
| set_context_defaults_parameters() X-Ref |
| Parameters for set_context_defaults(). return: external_function_parameters |
| set_context_defaults($contextlevel, $category, $purpose, $activity, $override) X-Ref |
| Updates the default category and purpose for a given context level (and optionally, a plugin). param: int $contextlevel The context level. param: int $category The ID matching the category. param: int $purpose The ID matching the purpose record. param: int $activity The name of the activity that we're making a defaults configuration for. param: bool $override Whether to override the purpose/categories of existing instances to these defaults. return: array |
| set_context_defaults_returns() X-Ref |
| Returns for set_context_defaults(). return: external_single_structure |
| get_category_options_parameters() X-Ref |
| Parameters for get_category_options(). return: external_function_parameters |
| get_category_options($includeinherit, $includenotset) X-Ref |
| Fetches a list of data category options containing category IDs as keys and the category name for the value. param: bool $includeinherit Whether to include the "Inherit" option. param: bool $includenotset Whether to include the "Not set" option. return: array |
| get_category_options_returns() X-Ref |
| Returns for get_category_options(). return: external_single_structure |
| get_purpose_options_parameters() X-Ref |
| Parameters for get_purpose_options(). return: external_function_parameters |
| get_purpose_options($includeinherit, $includenotset) X-Ref |
| Fetches a list of data storage purposes containing purpose IDs as keys and the purpose name for the value. param: bool $includeinherit Whether to include the "Inherit" option. param: bool $includenotset Whether to include the "Not set" option. return: array |
| get_purpose_options_returns() X-Ref |
| Returns for get_purpose_options(). return: external_single_structure |
| get_activity_options_parameters() X-Ref |
| Parameters for get_activity_options(). return: external_function_parameters |
| get_activity_options($nodefaults) X-Ref |
| Fetches a list of activity options for setting data registry defaults. param: boolean $nodefaults If false, it will fetch all of the activities. Otherwise, it will only fetch the activities return: array |
| get_activity_options_returns() X-Ref |
| Returns for get_category_options(). return: external_single_structure |
| get_tree_node_structure($allowchildbranches = true) X-Ref |
| Gets the structure of a tree node (link + child branches). param: bool $allowchildbranches return: array |
