core_backup\privacy\provider Class Reference

Privacy Subsystem implementation for core_backup. More...

Inheritance diagram for core_backup\privacy\provider:

Static Public Member Functions
static	delete_data_for_all_users_in_context (\context $context)
	Delete all user data which matches 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	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 within a specific context.

Static Protected Member Functions
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 core_backup.

Copyright

2018 Mark Nelson markn.nosp@m.@moo.nosp@m.dle.c.nosp@m.om

License

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

Member Function Documentation

delete_data_for_all_users_in_context()

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

static

Delete all user data which matches the specified context.

Only dealing with the specific context - not it's child contexts.

Parameters

context

$context

A user context.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

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

static

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

Only dealing with the specific context - not it's child 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 core_backup\privacy\provider::delete_data_for_users ( approved_userlist $userlist )

static

Delete multiple users within a single context.

Only dealing with the specific context - not it's child contexts.

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 core_backup\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.

get_contexts_for_userid()

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

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

Implements core_privacy\local\request\core_user_data_provider.

get_metadata()

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

static

Return the fields which contain personal data.

Parameters

collection

$items

a reference to the collection to use to store the metadata.

Return values

collection

the updated collection of metadata items.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

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

static

Get the list of users within a specific 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 core_backup\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

---

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

• backup/util/ui/classes/privacy/provider.php