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

Privacy class for requesting user data. More...

Inheritance diagram for assignfeedback_comments\privacy\provider:
core_privacy\local\metadata\provider mod_assign\privacy\assignfeedback_provider mod_assign\privacy\assignfeedback_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_feedback_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_feedback_for_grade (assign_plugin_request_data $requestdata)
 Calling this function should delete all user data associated with this grade entry.
 
static delete_feedback_for_grades (assign_plugin_request_data $deletedata)
 Deletes all feedback for the grade ids / userids provided in a context.
 
static export_feedback_user_data (assign_plugin_request_data $exportdata)
 Export all user data for this plugin.
 
static get_context_for_userid_within_feedback (int $userid, contextlist $contextlist)
 No need to fill in this method as all information can be acquired from the assign_grades table in the mod assign provider.
 
static get_metadata (collection $collection)
 Return meta data about this plugin.
 
static get_student_user_ids (useridlist $useridlist)
 This also does not need to be filled in as this is already collected in the mod assign provider.
 
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_grades table then please fill in this method.
 
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_grades 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_feedback_for_context()

static assignfeedback_comments\privacy\provider::delete_feedback_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\assignfeedback_provider.

◆ delete_feedback_for_grade()

static assignfeedback_comments\privacy\provider::delete_feedback_for_grade ( assign_plugin_request_data $requestdata)
static

Calling this function should delete all user data associated with this grade entry.

Parameters
assign_plugin_request_data$requestdataData useful for deleting user data.

Implements mod_assign\privacy\assignfeedback_provider.

◆ delete_feedback_for_grades()

static assignfeedback_comments\privacy\provider::delete_feedback_for_grades ( assign_plugin_request_data $deletedata)
static

Deletes all feedback for the grade ids / userids provided in a context.

assign_plugin_request_data contains:

  • context
  • assign object
  • grade ids (pluginids)
  • user ids
    Parameters
    assign_plugin_request_data$deletedataA class that contains the relevant information required for deletion.

Implements mod_assign\privacy\assignfeedback_user_provider.

◆ export_feedback_user_data()

static assignfeedback_comments\privacy\provider::export_feedback_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\assignfeedback_provider.

◆ get_context_for_userid_within_feedback()

static assignfeedback_comments\privacy\provider::get_context_for_userid_within_feedback ( int $userid,
contextlist $contextlist )
static

No need to fill in this method as all information can be acquired from the assign_grades table in the mod assign provider.

Parameters
int$useridThe user ID.
contextlist$contextlistThe context list.

Implements mod_assign\privacy\assignfeedback_provider.

◆ get_metadata()

static assignfeedback_comments\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()

static assignfeedback_comments\privacy\provider::get_student_user_ids ( useridlist $useridlist)
static

This also does not need to be filled in as this is already collected in the mod assign provider.

Parameters
useridlist$useridlistA list of user IDs

Implements mod_assign\privacy\assignfeedback_provider.

◆ get_userids_from_context() [1/2]

static assignfeedback_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_grades 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\assignfeedback_user_provider::get_userids_from_context ( \core_privacy\local\request\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_grades table then please fill in this method.

Parameters
core_privacy\local\request\userlist$userlistThe userlist object

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