mod_lesson\privacy\provider Class Reference

Data provider class. More...

Inheritance diagram for mod_lesson\privacy\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_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 all user data for the specified user, in the specified contexts.
static	export_user_preferences (int $userid)
	Export all user preferences for the plugin.
static	get_contexts_for_userid (int $userid)
	Get the list of contexts that contain user information for the specified user.
static	get_metadata (collection $collection)
	Returns metadata.
static	get_users_in_context (userlist $userlist)
	Get the list of users who have data within a context.

Static Protected Member Functions
static	get_lesson_id_from_context (context_module $context)
	Get a survey ID from its context.
static	get_lesson_ids_to_cmids_from_cmids (array $cmids)
	Return a dict of lesson 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.
static	transform_attempt (stdClass $data, context_module $context)
	Transform an attempt.

Detailed Description

Data provider class.

Copyright

2018 Frédéric Massart

Author

Frédéric Massart fred@.nosp@m.bran.nosp@m.chup..nosp@m.tech

License

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

Member Function Documentation

delete_data_for_all_users_in_context() [1/2]

static core_privacy\local\request\core_user_data_provider::delete_data_for_all_users_in_context ( \context $context )

staticinherited

Delete all data for all users in the specified context.

Parameters

context

$context

The specific context to delete data for.

Implemented in auth_lti\privacy\provider, auth_mnet\privacy\provider, auth_oauth2\privacy\provider, block_comments\privacy\provider, block_html\privacy\provider, block_recent_activity\privacy\provider, block_recentlyaccesseditems\privacy\provider, block_rss_client\privacy\provider, block_tag_flickr\privacy\provider, cachestore_redis\privacy\provider, cachestore_session\privacy\provider, core_adminpresets\privacy\provider, core_analytics\privacy\provider, core_backup\privacy\provider, core_calendar\privacy\provider, core_cohort\privacy\provider, core_contentbank\privacy\provider, core_course\privacy\provider, core_enrol\privacy\provider, core_files\privacy\provider, core_grading\privacy\provider, core_group\privacy\provider, core_message\privacy\provider, core_notes\privacy\provider, core_payment\privacy\provider, core_portfolio\privacy\provider, core_question\privacy\provider, core_repository\privacy\provider, core_role\privacy\provider, core_rss\privacy\provider, core_tag\privacy\provider, core_user\privacy\provider, editor_atto\privacy\provider, enrol_cohort\privacy\provider, enrol_flatfile\privacy\provider, enrol_lti\privacy\provider, enrol_meta\privacy\provider, enrol_paypal\privacy\provider, fileconverter_googledrive\privacy\provider, ltiservice_basicoutcomes\privacy\provider, ltiservice_gradebookservices\privacy\provider, ltiservice_memberships\privacy\provider, message_airnotifier\privacy\provider, message_email\privacy\provider, mnetservice_enrol\privacy\provider, mod_assign\privacy\provider, mod_bigbluebuttonbn\privacy\provider, mod_choice\privacy\provider, mod_data\privacy\provider, mod_feedback\privacy\provider, mod_forum\privacy\provider, mod_glossary\privacy\provider, mod_h5pactivity\privacy\provider, mod_lti\privacy\provider, mod_quiz\privacy\provider, mod_scorm\privacy\provider, mod_workshop\privacy\provider, profilefield_checkbox\privacy\provider, profilefield_datetime\privacy\provider, profilefield_menu\privacy\provider, profilefield_social\privacy\provider, profilefield_text\privacy\provider, profilefield_textarea\privacy\provider, qbank_comment\privacy\provider, quizaccess_seb\privacy\provider, report_stats\privacy\provider, repository_dropbox\privacy\provider, repository_flickr\privacy\provider, repository_flickr_public\privacy\provider, repository_googledocs\privacy\provider, repository_merlot\privacy\provider, repository_onedrive\privacy\provider, repository_wikimedia\privacy\provider, repository_youtube\privacy\provider, search_simpledb\privacy\provider, search_solr\privacy\provider, tiny_autosave\privacy\provider, tool_cohortroles\privacy\provider, tool_mobile\privacy\provider, tool_monitor\privacy\provider, and tool_policy\privacy\provider.

delete_data_for_all_users_in_context() [2/2]

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

static

Delete all data for all users in the specified context.

Parameters

context

$context

The specific context to delete data for.

delete_data_for_user()

static mod_lesson\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

$contextlist

The approved contexts and user information to delete information for.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_users()

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

static

Delete multiple users within a single context.

Parameters

approved_userlist

$userlist

The approved context and user information to delete information for.

Implements core_privacy\local\request\core_userlist_provider.

export_user_data()

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

static

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

Parameters

approved_contextlist

$contextlist

The approved contexts to export information for.

Implements core_privacy\local\request\core_user_data_provider.

export_user_preferences()

static mod_lesson\privacy\provider::export_user_preferences ( int $userid )

static

Export all user preferences for the plugin.

Parameters

int

$userid

The userid of the user whose data is to be exported.

Implements core_privacy\local\request\user_preference_provider.

get_contexts_for_userid()

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

static

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

Parameters

int

$userid

The user to search.

Return values

contextlist\$contextlist

The contextlist containing the list of contexts used in this plugin.

Implements core_privacy\local\request\core_user_data_provider.

get_lesson_id_from_context()

static mod_lesson\privacy\provider::get_lesson_id_from_context ( context_module $context )

staticprotected

Get a survey ID from its context.

Parameters

context_module

$context

The module context.

Return values

int

get_lesson_ids_to_cmids_from_cmids()

static mod_lesson\privacy\provider::get_lesson_ids_to_cmids_from_cmids ( array $cmids )

staticprotected

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

Parameters

array

$cmids

The course module IDs.

Return values

array

In the form of [$lessonid => $cmid].

get_metadata()

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

static

Returns metadata.

Parameters

collection

$collection

The initialised collection to add items to.

Return values

collection

A listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

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

static

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

Parameters

userlist

$userlist

The 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_lesson\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	$recordset	The recordset.
string	$splitkey	The record key to determine when to export.
mixed	$initial	The initial data to reduce from.
callable	$reducer	The function to return the dataset, receives current dataset, and the current record.
callable	$export	The function to export the dataset, receives the last value from $splitkey and the dataset.

Return values

void

transform_attempt()

static mod_lesson\privacy\provider::transform_attempt ( stdClass $data, context_module $context )

staticprotected

Transform an attempt.

Parameters

stdClass	$data	Data from the database, as per the exporting method.
context_module	$context	The module context.

Return values

array

---

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

• mod/lesson/classes/privacy/provider.php