Search moodle.org's
Developer Documentation

See Release Notes

  • 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.
/admin/tool/policy/classes/privacy/ -> provider.php (source)

[Source view]

Privacy Subsystem implementation for tool_policy.

Copyright: 2018 Sara Arjona <sara@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 356 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (9 methods):
  get_metadata()
  get_contexts_for_userid()
  get_users_in_context()
  export_user_data()
  delete_data_for_all_users_in_context()
  delete_data_for_user()
  delete_data_for_users()
  export_policy_agreements_for_context()
  export_authored_policies()


Class: provider  - X-Ref

Implementation of the privacy subsystem plugin provider for the policy tool.

get_metadata(collection $collection)   X-Ref
Return the fields which contain personal data.

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 The list of contexts containing user info for the user.
param: int $userid The userid.

get_users_in_context(userlist $userlist)   X-Ref
Get the list of users who have data within a context.

param: 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 personal data for the given approved_contextlist. User and context information is contained within the contextlist.

param: approved_contextlist $contextlist A list of contexts approved for export.

delete_data_for_all_users_in_context(\context $context)   X-Ref
Delete all data for all users in the specified context.

We never delete user agreements to the policies because they are part of privacy data.
We never delete policy versions because they are part of privacy data.

param: \context $context The context to delete in.

delete_data_for_user(approved_contextlist $contextlist)   X-Ref
Delete all user data for the specified user, in the specified contexts.

We never delete user agreements to the policies because they are part of privacy data.
We never delete policy versions because they are part of privacy data.

param: approved_contextlist $contextlist A list of contexts approved for deletion.

delete_data_for_users(approved_userlist $userlist)   X-Ref
Delete multiple users within a single context.

We never delete user agreements to the policies because they are part of privacy data.
We never delete policy versions because they are part of privacy data.

param: approved_userlist       $userlist The approved context and user information to delete information for.

export_policy_agreements_for_context(\context_user $context)   X-Ref
Export all policy agreements relating to the specified user context.

param: \context_user $context The context to export

export_authored_policies(\stdClass $user)   X-Ref
Export all policy agreements that the user authored.

param: stdClass $user The user who has created the policies to export.