core_user\privacy\provider Class Reference

Privacy class for requesting user data. More...

Inheritance diagram for core_user\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_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 information about the user data stored in this component.
static	get_users_in_context (userlist $userlist)
	Get the list of users within a specific context.

Static Protected Member Functions
static	delete_user_data (int $userid, context $context)
	Deletes non vital information about a user.
static	export_course_requests (int $userid, context $context)
	Exports information about course requests this user made.
static	export_lastaccess (int $userid, context $context)
	Export information about the last time a user accessed a course.
static	export_password_history (int $userid, context $context)
	Get details about the user's password history.
static	export_password_resets (int $userid, context $context)
	Exports information about password resets.
static	export_user (\stdClass $user, context $context)
	Export core user data.
static	export_user_devices (int $userid, context $context)
	Exports information about the user's mobile devices.
static	export_user_session_data (int $userid, context $context)
	Exports information about the user's session.

Detailed Description

Privacy class for requesting user data.

Copyright

2018 Adrian Greeve adria.nosp@m.n@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_for_all_users_in_context()

static core_user\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_user\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_user\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.

delete_user_data()

static core_user\privacy\provider::delete_user_data ( int $userid, context $context )

staticprotected

Deletes non vital information about a user.

Parameters

int	$userid	The user ID to delete
context	$context	The user context

export_course_requests()

static core_user\privacy\provider::export_course_requests ( int $userid, context $context )

staticprotected

Exports information about course requests this user made.

Parameters

int	$userid	The user ID.
context	$context	The context object

export_lastaccess()

static core_user\privacy\provider::export_lastaccess ( int $userid, context $context )

staticprotected

Export information about the last time a user accessed a course.

Parameters

int	$userid	The user ID.
context	$context	The user context.

export_password_history()

static core_user\privacy\provider::export_password_history ( int $userid, context $context )

staticprotected

Get details about the user's password history.

Parameters

int	$userid	The user ID that we are getting the password history for.
context	$context	the user context.

export_password_resets()

static core_user\privacy\provider::export_password_resets ( int $userid, context $context )

staticprotected

Exports information about password resets.

Parameters

int	$userid	The user ID
context	$context	Context for this user.

export_user()

static core_user\privacy\provider::export_user ( \stdClass $user, context $context )

staticprotected

Export core user data.

Parameters

stdClass	$user	The user object.
context	$context	The user context.

export_user_data()

static core_user\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_devices()

static core_user\privacy\provider::export_user_devices ( int $userid, context $context )

staticprotected

Exports information about the user's mobile devices.

Parameters

int	$userid	The user ID.
context	$context	Context for this user.

export_user_preferences()

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

export_user_session_data()

static core_user\privacy\provider::export_user_session_data ( int $userid, context $context )

staticprotected

Exports information about the user's session.

Parameters

int	$userid	The user ID.
context	$context	The context for this user.

get_contexts_for_userid()

static core_user\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_user\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_user\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/classes/privacy/provider.php