profilefield_text\privacy\provider Class Reference

Privacy class for requesting user data. More...

Inheritance diagram for profilefield_text\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 $collection)
	Returns meta data about this system.
static	get_users_in_context (userlist $userlist)
	Get the list of users within a specific context.

Static Protected Member Functions
static	delete_data ($userid)
	Delete data related to a userid.
static	get_records ($userid)
	Get records related to this plugin and user.

Detailed Description

Privacy class for requesting user data.

Copyright

2018 Mihail Geshoski mihai.nosp@m.l@mo.nosp@m.odle..nosp@m.com

License

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

Member Function Documentation

delete_data()

static profilefield_text\privacy\provider::delete_data ( $userid )

staticprotected

Delete data related to a userid.

Parameters

int

$userid

The user ID

delete_data_for_all_users_in_context()

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

static

Delete all user data which matches the specified context.

Parameters

context

$context

A user context.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static profilefield_text\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 profilefield_text\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 profilefield_text\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 profilefield_text\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 profilefield_text\privacy\provider::get_metadata ( collection $collection )

static

Returns meta data about this system.

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_records()

static profilefield_text\privacy\provider::get_records ( $userid )

staticprotected

Get records related to this plugin and user.

Parameters

int

$userid

The user ID

Return values

array

An array of records.

get_users_in_context()

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

---

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

• user/profile/field/text/classes/privacy/provider.php