mod_assign\privacy\assignfeedback_provider Interface Reference

Inheritance diagram for mod_assign\privacy\assignfeedback_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. More...
static	delete_feedback_for_grade (assign_plugin_request_data $requestdata)
	Calling this function should delete all user data associated with this grade. More...
static	export_feedback_user_data (assign_plugin_request_data $exportdata)
	Export feedback data with the available grade and userid information provided. More...
static	get_context_for_userid_within_feedback (int $userid, contextlist $contextlist)
	Retrieves the contextids associated with the provided userid for this subplugin. More...
static	get_student_user_ids (useridlist $useridlist)
	Returns student user ids related to the provided teacher ID. More...

Member Function Documentation

delete_feedback_for_context()

static mod_assign\privacy\assignfeedback_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.

assign_plugin_request_data contains:

• context
• assign object

Parameters

assign_plugin_request_data

$requestdata

Data useful for deleting user data from this sub-plugin.

Implemented in assignfeedback_file\privacy\provider, assignfeedback_editpdf\privacy\provider, and assignfeedback_comments\privacy\provider.

delete_feedback_for_grade()

static mod_assign\privacy\assignfeedback_provider::delete_feedback_for_grade ( assign_plugin_request_data  $requestdata )

static

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

assign_plugin_request_data contains:

• context
• grade object
• user object
• assign object

Parameters

assign_plugin_request_data

$requestdata

Data useful for deleting user data.

Implemented in assignfeedback_file\privacy\provider, assignfeedback_editpdf\privacy\provider, and assignfeedback_comments\privacy\provider.

export_feedback_user_data()

static mod_assign\privacy\assignfeedback_provider::export_feedback_user_data ( assign_plugin_request_data  $exportdata )

static

Export feedback data with the available grade and userid information provided.

assign_plugin_request_data contains:

• context
• grade object
• current path (subcontext)
• user object

Parameters

assign_plugin_request_data

$exportdata

Contains data to help export the user information.

Implemented in assignfeedback_file\privacy\provider, assignfeedback_editpdf\privacy\provider, and assignfeedback_comments\privacy\provider.

get_context_for_userid_within_feedback()

static mod_assign\privacy\assignfeedback_provider::get_context_for_userid_within_feedback ( int  $userid, contextlist  $contextlist  )

static

Retrieves the contextids associated with the provided userid for this subplugin.

NOTE if your subplugin must have an entry in the assign_grade table to work, then this method can be empty.

Parameters

int	$userid	The user ID to get context IDs for.
core_privacy\local\request\contextlist	$contextlist	Use add_from_sql with this object to add your context IDs.

Implemented in assignfeedback_file\privacy\provider, assignfeedback_editpdf\privacy\provider, and assignfeedback_comments\privacy\provider.

get_student_user_ids()

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

static

Returns student user ids related to the provided teacher ID.

If an entry must be present in the assign_grade table for your plugin to work then there is no need to fill in this method. If you filled in get_context_for_userid_within_feedback() then you probably have to fill this in as well.

Parameters

useridlist

$useridlist

A list of user IDs of students graded by this user.

Implemented in assignfeedback_file\privacy\provider, assignfeedback_editpdf\privacy\provider, and assignfeedback_comments\privacy\provider.

---

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

• mod/assign/classes/privacy/assignfeedback_provider.php