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

Privacy Subsystem implementation for mod_lti. More...

Inheritance diagram for mod_lti\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\plugin\provider core_privacy\local\request\userlist_provider core_privacy\local\request\core_user_data_provider core_privacy\local\request\core_data_provider core_privacy\local\request\data_provider

Static Public Member Functions

static delete_data_for_all_users_in_context (\context $context)
 Delete all data for all users in the specified context.
 
static delete_data_for_user (approved_contextlist $contextlist)
 Delete all user data for the specified user, in the specified contexts.
 
static delete_data_for_users (approved_userlist $userlist)
 Delete multiple users within a single context.
 
static export_user_data (approved_contextlist $contextlist)
 Export personal data for the given approved_contextlist.
 
static get_contexts_for_userid (int $userid)
 Get the list of contexts that contain user information for the specified user.
 
static get_metadata (collection $items)
 Return the fields which contain personal data.
 
static get_users_in_context (userlist $userlist)
 Get the list of users who have data within a context.
 

Static Protected Member Functions

static export_user_data_lti_submissions (approved_contextlist $contextlist)
 Export personal data for the given approved_contextlist related to LTI submissions.
 
static export_user_data_lti_tool_proxies (approved_contextlist $contextlist)
 Export personal data for the given approved_contextlist related to LTI tool proxies.
 
static export_user_data_lti_types (approved_contextlist $contextlist)
 Export personal data for the given approved_contextlist related to LTI types.
 
static get_lti_ids_to_cmids_from_cmids (array $cmids)
 Return a dict of LTI IDs mapped to their course module ID.
 
static recordset_loop_and_export (\moodle_recordset $recordset, $splitkey, $initial, callable $reducer, callable $export)
 Loop and export from a recordset.
 

Detailed Description

Privacy Subsystem implementation for mod_lti.

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

Member Function Documentation

◆ delete_data_for_all_users_in_context()

static mod_lti\privacy\provider::delete_data_for_all_users_in_context ( \context $context)
static

Delete all data for all users in the specified context.

Parameters
context$contextthe context to delete in.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_user()

static mod_lti\privacy\provider::delete_data_for_user ( approved_contextlist $contextlist)
static

Delete all user data for the specified user, in the specified contexts.

Parameters
approved_contextlist$contextlista list of contexts approved for deletion.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_users()

static mod_lti\privacy\provider::delete_data_for_users ( approved_userlist $userlist)
static

Delete multiple users within a single context.

Parameters
approved_userlist$userlistThe approved context and user information to delete information for.

Implements core_privacy\local\request\core_userlist_provider.

◆ export_user_data()

static mod_lti\privacy\provider::export_user_data ( approved_contextlist $contextlist)
static

Export personal data for the given approved_contextlist.

User and context information is contained within the contextlist.

Parameters
approved_contextlist$contextlista list of contexts approved for export.

Implements core_privacy\local\request\core_user_data_provider.

◆ export_user_data_lti_submissions()

static mod_lti\privacy\provider::export_user_data_lti_submissions ( approved_contextlist $contextlist)
staticprotected

Export personal data for the given approved_contextlist related to LTI submissions.

Parameters
approved_contextlist$contextlista list of contexts approved for export.

◆ export_user_data_lti_tool_proxies()

static mod_lti\privacy\provider::export_user_data_lti_tool_proxies ( approved_contextlist $contextlist)
staticprotected

Export personal data for the given approved_contextlist related to LTI tool proxies.

Parameters
approved_contextlist$contextlista list of contexts approved for export.

◆ export_user_data_lti_types()

static mod_lti\privacy\provider::export_user_data_lti_types ( approved_contextlist $contextlist)
staticprotected

Export personal data for the given approved_contextlist related to LTI types.

Parameters
approved_contextlist$contextlista list of contexts approved for export.

◆ get_contexts_for_userid()

static mod_lti\privacy\provider::get_contexts_for_userid ( int $userid)
static

Get the list of contexts that contain user information for the specified user.

Parameters
int$useridthe userid.
Return values
contextlistthe list of contexts containing user info for the user.

Implements core_privacy\local\request\core_user_data_provider.

◆ get_lti_ids_to_cmids_from_cmids()

static mod_lti\privacy\provider::get_lti_ids_to_cmids_from_cmids ( array $cmids)
staticprotected

Return a dict of LTI IDs mapped to their course module ID.

Parameters
array$cmidsThe course module IDs.
Return values
arrayIn the form of [$ltiid => $cmid].

◆ get_metadata()

static mod_lti\privacy\provider::get_metadata ( collection $items)
static

Return the fields which contain personal data.

Parameters
collection$itemsa reference to the collection to use to store the metadata.
Return values
collectionthe updated collection of metadata items.

Implements core_privacy\local\metadata\provider.

◆ get_users_in_context()

static mod_lti\privacy\provider::get_users_in_context ( userlist $userlist)
static

Get the list of users who have data within a context.

Parameters
userlist$userlistThe userlist containing the list of users who have data in this context/plugin combination.

Implements core_privacy\local\request\core_userlist_provider.

◆ recordset_loop_and_export()

static mod_lti\privacy\provider::recordset_loop_and_export ( \moodle_recordset $recordset,
$splitkey,
$initial,
callable $reducer,
callable $export )
staticprotected

Loop and export from a recordset.

Parameters
moodle_recordset$recordsetThe recordset.
string$splitkeyThe record key to determine when to export.
mixed$initialThe initial data to reduce from.
callable$reducerThe function to return the dataset, receives current dataset, and the current record.
callable$exportThe function to export the dataset, receives the last value from $splitkey and the dataset.
Return values
void

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