core\privacy\provider Class Reference

Privacy class for requesting user data. More...

Inheritance diagram for core\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. More...
static	delete_data_for_user (approved_contextlist $contextlist)
	Delete all user data for the specified user, in the specified contexts. More...
static	delete_data_for_users (approved_userlist $userlist)
	Delete multiple users within a single context. More...
static	export_user_data (approved_contextlist $contextlist)
	Export all user data for the specified user, in the specified contexts. More...
static	get_contexts_for_userid (int $userid)
	Get the list of contexts that contain user information for the specified user. More...
static	get_metadata (collection $collection)
	Returns information about the user data stored in this component. More...
static	get_users_in_context (userlist $userlist)
	Get the list of users who have data within a context. More...

Detailed Description

Privacy class for requesting user data.

Copyright

2018 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

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

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static core\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 core\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 core\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\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_metadata()

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

static

Returns information about the user data stored in this component.

Parameters

collection

$collection

A list of information about this component

Return values

collection

The collection object filled out with information about this component.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

static core\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.

---

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

• lib/classes/privacy/provider.php