Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
/mod/assign/submission/comments/classes/privacy/ -> provider.php (source)

[Source view]

Privacy class for requesting user data.

Copyright: 2018 Adrian Greeve <adrian@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 164 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (8 methods):
  get_metadata()
  get_context_for_userid_within_submission()
  get_student_user_ids()
  get_userids_from_context()
  export_submission_user_data()
  delete_submission_for_context()
  delete_submission_for_userid()
  delete_submissions()


Class: provider  - X-Ref

Privacy class for requesting user data.

get_metadata(collection $collection)   X-Ref
Return meta data about this plugin.

param: collection $collection A list of information to add to.
return: collection Return the collection after adding to it.

get_context_for_userid_within_submission(int $userid, contextlist $contextlist)   X-Ref
It is possible to make a comment as a teacher without creating an entry in the submission table, so this is required
to find those entries.

param: int $userid The user ID that we are finding contexts for.
param: contextlist $contextlist A context list to add sql and params to for contexts.

get_student_user_ids(\mod_assign\privacy\useridlist $useridlist)   X-Ref
Due to the fact that we can't rely on the queries in the mod_assign provider we have to add some additional sql.

param: \mod_assign\privacy\useridlist $useridlist An object for obtaining user IDs of students.

get_userids_from_context(\core_privacy\local\request\userlist $userlist)   X-Ref
If you have tables that contain userids and you can generate entries in your tables without creating an
entry in the assign_submission table then please fill in this method.

param: \core_privacy\local\request\userlist $userlist The userlist object

export_submission_user_data(assign_plugin_request_data $exportdata)   X-Ref
Export all user data for this plugin.

param: assign_plugin_request_data $exportdata Data used to determine which context and user to export and other useful

delete_submission_for_context(assign_plugin_request_data $requestdata)   X-Ref
Delete all the comments made for this context.

param: assign_plugin_request_data $requestdata Data to fulfill the deletion request.

delete_submission_for_userid(assign_plugin_request_data $exportdata)   X-Ref
A call to this method should delete user data (where practical) using the userid and submission.

param: assign_plugin_request_data $exportdata Details about the user and context to focus the deletion.

delete_submissions(assign_plugin_request_data $deletedata)   X-Ref
Deletes all submissions for the submission ids / userids provided in a context.
assign_plugin_request_data contains:
- context
- assign object
- submission ids (pluginids)
- user ids

param: assign_plugin_request_data $deletedata A class that contains the relevant information required for deletion.