Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/mod/lti/classes/privacy/ -> provider.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

Privacy Subsystem implementation for mod_lti.

Copyright: 2018 Mark Nelson <markn@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 465 lines (18 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (12 methods):
  get_metadata()
  get_contexts_for_userid()
  get_users_in_context()
  export_user_data()
  delete_data_for_all_users_in_context()
  delete_data_for_user()
  delete_data_for_users()
  export_user_data_lti_submissions()
  export_user_data_lti_types()
  export_user_data_lti_tool_proxies()
  get_lti_ids_to_cmids_from_cmids()
  recordset_loop_and_export()


Class: provider  - X-Ref

Privacy Subsystem implementation for mod_lti.

get_metadata(collection $items)   X-Ref
Return the fields which contain personal data.

param: collection $items a reference to the collection to use to store the metadata.
return: collection the updated collection of metadata items.

get_contexts_for_userid(int $userid)   X-Ref
Get the list of contexts that contain user information for the specified user.

param: int $userid the userid.
return: contextlist the list of contexts containing user info for the user.

get_users_in_context(userlist $userlist)   X-Ref
Get the list of users who have data within a context.

param: userlist    $userlist   The userlist containing the list of users who have data in this context/plugin combination.

export_user_data(approved_contextlist $contextlist)   X-Ref
Export personal data for the given approved_contextlist. User and context information is contained within the contextlist.

param: approved_contextlist $contextlist a list of contexts approved for export.

delete_data_for_all_users_in_context(\context $context)   X-Ref
Delete all data for all users in the specified context.

param: \context $context the context to delete in.

delete_data_for_user(approved_contextlist $contextlist)   X-Ref
Delete all user data for the specified user, in the specified contexts.

param: approved_contextlist $contextlist a list of contexts approved for deletion.

delete_data_for_users(approved_userlist $userlist)   X-Ref
Delete multiple users within a single context.

param: approved_userlist       $userlist The approved context and user information to delete information for.

export_user_data_lti_submissions(approved_contextlist $contextlist)   X-Ref
Export personal data for the given approved_contextlist related to LTI submissions.

param: approved_contextlist $contextlist a list of contexts approved for export.

export_user_data_lti_types(approved_contextlist $contextlist)   X-Ref
Export personal data for the given approved_contextlist related to LTI types.

param: approved_contextlist $contextlist a list of contexts approved for export.

export_user_data_lti_tool_proxies(approved_contextlist $contextlist)   X-Ref
Export personal data for the given approved_contextlist related to LTI tool proxies.

param: approved_contextlist $contextlist a list of contexts approved for export.

get_lti_ids_to_cmids_from_cmids(array $cmids)   X-Ref
Return a dict of LTI IDs mapped to their course module ID.

param: array $cmids The course module IDs.
return: array In the form of [$ltiid => $cmid].

recordset_loop_and_export(\moodle_recordset $recordset, $splitkey, $initial,callable $reducer, callable $export)   X-Ref
Loop and export from a recordset.

param: \moodle_recordset $recordset The recordset.
param: string $splitkey The record key to determine when to export.
param: mixed $initial The initial data to reduce from.
param: callable $reducer The function to return the dataset, receives current dataset, and the current record.
param: callable $export The function to export the dataset, receives the last value from $splitkey and the dataset.
return: void