Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/blocks/classes/privacy/ -> provider.php (source)
Data provider.
| Author: | Frédéric Massart <fred@branchup.tech> |
| Copyright: | 2018 Frédéric Massart |
| License: | http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later |
| File Size: | 270 lines (10 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
provider:: (8 methods):
get_metadata()
get_contexts_for_userid()
get_users_in_context()
export_user_data()
export_user_preferences()
delete_data_for_all_users_in_context()
delete_data_for_user()
delete_data_for_users()
Data provider class.
| get_metadata(collection $collection) X-Ref |
| Returns metadata. return: collection A listing of user data stored through this system. param: collection $collection The initialised collection to add items to. |
| get_contexts_for_userid(int $userid) X-Ref |
| Get the list of contexts that contain user information for the specified user. return: contextlist $contextlist The contextlist containing the list of contexts used in this plugin. param: int $userid The user to search. |
| get_users_in_context(\core_privacy\local\request\userlist $userlist) X-Ref |
| Get the list of users who have data within a context. param: \core_privacy\local\request\userlist $userlist The userlist containing the list of users who have data in this context/plugin combination. |
| export_user_data(approved_contextlist $contextlist) X-Ref |
| Export all user data for the specified user, in the specified contexts. param: approved_contextlist $contextlist The approved contexts to export information for. |
| export_user_preferences(int $userid) X-Ref |
| Export all user preferences for the plugin. param: int $userid The userid of the user whose data is to be exported. |
| delete_data_for_all_users_in_context(context $context) X-Ref |
| Delete all data for all users in the specified context. param: context $context The specific context to delete data for. |
| delete_data_for_user(approved_contextlist $contextlist) X-Ref |
| Delete all user data for the specified user, in the specified contexts. param: approved_contextlist $contextlist The approved contexts and user information to delete information for. |
| delete_data_for_users(\core_privacy\local\request\approved_userlist $userlist) X-Ref |
| Delete multiple users within a single context. param: \core_privacy\local\request\approved_userlist $userlist The approved context and user information to delete |
