assignsubmission_comments\privacy\provider Class Reference

Privacy class for requesting user data. More...

Inheritance diagram for assignsubmission_comments\privacy\provider:

Static Public Member Functions
static	delete_submission_for_context (assign_plugin_request_data $requestdata)
	Delete all the comments made for this context. More...
static	delete_submission_for_userid (assign_plugin_request_data $exportdata)
	A call to this method should delete user data (where practical) using the userid and submission. More...
static	delete_submissions (assign_plugin_request_data $deletedata)
	Deletes all submissions for the submission ids / userids provided in a context. More...
static	export_submission_user_data (assign_plugin_request_data $exportdata)
	Export all user data for this plugin. More...
static	get_context_for_userid_within_submission (int $userid, contextlist $contextlist)
	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. More...
static	get_metadata (collection $collection)
	Return meta data about this plugin. More...
static	get_student_user_ids (\mod_assign\privacy\useridlist $useridlist)
	Due to the fact that we can't rely on the queries in the mod_assign provider we have to add some additional sql. More...
static	get_student_user_ids (useridlist $useridlist)
	Returns student user ids related to the provided teacher ID. More...
static	get_userids_from_context (\core_privacy\local\request\userlist $userlist)
	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. More...
static	get_userids_from_context (userlist $userlist)
	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. More...

Detailed Description

Privacy class for requesting user data.

Copyright

2018 Adrian Greeve adria.nosp@m.n@mo.nosp@m.odle..nosp@m.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

delete_submission_for_context()

static assignsubmission_comments\privacy\provider::delete_submission_for_context ( assign_plugin_request_data  $requestdata )

static

Delete all the comments made for this context.

Parameters

assign_plugin_request_data

$requestdata

Data to fulfill the deletion request.

Implements mod_assign\privacy\assignsubmission_provider.

delete_submission_for_userid()

static assignsubmission_comments\privacy\provider::delete_submission_for_userid ( assign_plugin_request_data  $exportdata )

static

A call to this method should delete user data (where practical) using the userid and submission.

Parameters

assign_plugin_request_data

$exportdata

Details about the user and context to focus the deletion.

Implements mod_assign\privacy\assignsubmission_provider.

delete_submissions()

static assignsubmission_comments\privacy\provider::delete_submissions ( assign_plugin_request_data  $deletedata )

static

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

  Parameters

  assign_plugin_request_data

  $deletedata

  A class that contains the relevant information required for deletion.

Implements mod_assign\privacy\assignsubmission_user_provider.

export_submission_user_data()

static assignsubmission_comments\privacy\provider::export_submission_user_data ( assign_plugin_request_data  $exportdata )

static

Export all user data for this plugin.

Parameters

assign_plugin_request_data

$exportdata

Data used to determine which context and user to export and other useful information to help with exporting.

Implements mod_assign\privacy\assignsubmission_provider.

get_context_for_userid_within_submission()

static assignsubmission_comments\privacy\provider::get_context_for_userid_within_submission ( int  $userid, contextlist  $contextlist  )

static

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.

Parameters

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

Implements mod_assign\privacy\assignsubmission_provider.

get_metadata()

static assignsubmission_comments\privacy\provider::get_metadata ( collection  $collection )

static

Return meta data about this plugin.

Parameters

collection

$collection

A list of information to add to.

Return values

collection

Return the collection after adding to it.

Implements core_privacy\local\metadata\provider.

get_student_user_ids() [1/2]

static assignsubmission_comments\privacy\provider::get_student_user_ids ( \mod_assign\privacy\useridlist  $useridlist )

static

Due to the fact that we can't rely on the queries in the mod_assign provider we have to add some additional sql.

Parameters

mod_assign\privacy\useridlist

$useridlist

An object for obtaining user IDs of students.

get_student_user_ids() [2/2]

static mod_assign\privacy\assignsubmission_provider::get_student_user_ids ( useridlist  $useridlist )

staticinherited

Returns student user ids related to the provided teacher ID.

If it is possible that a student ID will not be returned by the sql query in mod_assign\privacy\provider::find_grader_info() Then you need to provide some sql to retrive those student IDs. This is highly likely if you had to fill in get_context_for_userid_within_submission above.

Parameters

useridlist

$useridlist

A user ID list object that you can append your user IDs to.

get_userids_from_context() [1/2]

static assignsubmission_comments\privacy\provider::get_userids_from_context ( \core_privacy\local\request\userlist  $userlist )

static

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.

Parameters

core_privacy\local\request\userlist

$userlist

The userlist object

get_userids_from_context() [2/2]

static mod_assign\privacy\assignsubmission_user_provider::get_userids_from_context ( userlist  $userlist )

staticinherited

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.

Parameters

userlist

$userlist

The userlist object

---

The documentation for this class was generated from the following file:

• mod/assign/submission/comments/classes/privacy/provider.php