Search moodle.org's
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/log/store/legacy/classes/privacy/ -> provider.php (source)

[Source view]

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: 255 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (8 methods):
  get_metadata()
  add_contexts_for_userid()
  add_userids_for_context()
  export_user_data()
  delete_data_for_all_users_in_context()
  delete_data_for_user()
  delete_data_for_userlist()
  get_sql_where_from_contexts()


Class: provider  - X-Ref

Data provider class.

get_metadata(collection $collection)   X-Ref
Returns metadata.

param: collection $collection The initialised collection to add items to.
return: collection A listing of user data stored through this system.

add_contexts_for_userid(contextlist $contextlist, $userid)   X-Ref
Add contexts that contain user information for the specified user.

param: contextlist $contextlist The contextlist to add the contexts to.
param: int $userid The user to find the contexts for.
return: void

add_userids_for_context(\core_privacy\local\request\userlist $userlist)   X-Ref
Add user IDs that contain user information for the specified context.

param: \core_privacy\local\request\userlist $userlist The userlist to add the users to.
return: void

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.

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_userlist(\core_privacy\local\request\approved_userlist $userlist)   X-Ref
Delete all data for a list of users in the specified context.

param: \core_privacy\local\request\approved_userlist $userlist The specific context and users to delete data for.
return: void

get_sql_where_from_contexts(array $contexts)   X-Ref
Get an SQL where statement from a list of contexts.

param: array $contexts The contexts.
return: array [$sql, $params]