Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
assignsubmission_onlinetext\privacy\provider Class Reference

Privacy class for requesting user data. More...

Inheritance diagram for assignsubmission_onlinetext\privacy\provider:
core_privacy\local\metadata\provider mod_assign\privacy\assignsubmission_provider mod_assign\privacy\assignsubmission_user_provider core_privacy\local\request\plugin\subplugin_provider core_privacy\local\request\plugin\subplugin_provider core_privacy\local\request\shared_userlist_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\userlist_provider core_privacy\local\request\data_provider core_privacy\local\request\data_provider

Static Public Member Functions

static delete_submission_for_context (assign_plugin_request_data $requestdata)
 Any call to this method should delete all user data for the context defined in the deletion_criteria.
 
static delete_submission_for_userid (assign_plugin_request_data $deletedata)
 A call to this method should delete user data (where practicle) from the userid and context.
 
static delete_submissions (assign_plugin_request_data $deletedata)
 Deletes all submissions for the submission ids / userids provided in a context.
 
static export_submission_user_data (assign_plugin_request_data $exportdata)
 Export all user data for this plugin.
 
static get_context_for_userid_within_submission (int $userid, contextlist $contextlist)
 This is covered by mod_assign provider and the query on assign_submissions.
 
static get_metadata (collection $collection)
 Return meta data about this plugin.
 
static get_student_user_ids (\mod_assign\privacy\useridlist $useridlist)
 This is also covered by the mod_assign provider and it's queries.
 
static get_student_user_ids (useridlist $useridlist)
 Returns student user ids related to the provided teacher ID.
 
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.
 
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.
 

Detailed Description

Privacy class for requesting user data.

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

Member Function Documentation

◆ delete_submission_for_context()

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

Any call to this method should delete all user data for the context defined in the deletion_criteria.

Parameters
assign_plugin_request_data$requestdataData useful for deleting user data from this sub-plugin.

Implements mod_assign\privacy\assignsubmission_provider.

◆ delete_submission_for_userid()

static assignsubmission_onlinetext\privacy\provider::delete_submission_for_userid ( assign_plugin_request_data $deletedata)
static

A call to this method should delete user data (where practicle) from the userid and context.

Parameters
assign_plugin_request_data$deletedataDetails about the user and context to focus the deletion.

Implements mod_assign\privacy\assignsubmission_provider.

◆ delete_submissions()

static assignsubmission_onlinetext\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$deletedataA class that contains the relevant information required for deletion.

Implements mod_assign\privacy\assignsubmission_user_provider.

◆ export_submission_user_data()

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

Export all user data for this plugin.

Parameters
assign_plugin_request_data$exportdataData 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_onlinetext\privacy\provider::get_context_for_userid_within_submission ( int $userid,
contextlist $contextlist )
static

This is covered by mod_assign provider and the query on assign_submissions.

Parameters
int$useridThe user ID that we are finding contexts for.
contextlist$contextlistA context list to add sql and params to for contexts.

Implements mod_assign\privacy\assignsubmission_provider.

◆ get_metadata()

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

Return meta data about this plugin.

Parameters
collection$collectionA list of information to add to.
Return values
collectionReturn the collection after adding to it.

Implements core_privacy\local\metadata\provider.

◆ get_student_user_ids() [1/2]

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

This is also covered by the mod_assign provider and it's queries.

Parameters
mod_assign\privacy\useridlist$useridlistAn 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$useridlistA user ID list object that you can append your user IDs to.

◆ get_userids_from_context() [1/2]

static assignsubmission_onlinetext\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$userlistThe 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$userlistThe userlist object

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