logstore_standard\privacy\provider Class Reference

Data provider class. More...

Inheritance diagram for logstore_standard\privacy\provider:

Static Public Member Functions
static	add_contexts_for_userid (contextlist $contextlist, $userid)
	Add contexts that contain user information for the specified user.
static	add_userids_for_context (\core_privacy\local\request\userlist $userlist)
	Add user IDs that contain user information for 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_userlist (\core_privacy\local\request\approved_userlist $userlist)
	Delete all data for a list of users in the specified context.
static	export_user_data (approved_contextlist $contextlist)
	Export all user data for the specified user, in the specified contexts.
static	get_metadata (collection $collection)
	Returns metadata.

Static Protected Member Functions
static	get_database_and_table ()
	Get the database object.
static	get_export_subcontext ()
	Get the path to export the logs to.

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

add_contexts_for_userid()

static logstore_standard\privacy\provider::add_contexts_for_userid ( contextlist $contextlist, $userid )

static

Add contexts that contain user information for the specified user.

Parameters

contextlist	$contextlist	The contextlist to add the contexts to.
int	$userid	The user to find the contexts for.

Return values

void

Implements tool_log\local\privacy\logstore_provider.

add_userids_for_context()

static logstore_standard\privacy\provider::add_userids_for_context ( \core_privacy\local\request\userlist $userlist )

static

Add user IDs that contain user information for the specified context.

Parameters

core_privacy\local\request\userlist

$userlist

The userlist to add the users to.

Return values

void

Implements tool_log\local\privacy\logstore_userlist_provider.

delete_data_for_all_users_in_context()

static tool_log\local\privacy\logstore_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.

Return values

void

delete_data_for_user()

static tool_log\local\privacy\logstore_provider::delete_data_for_user ( approved_contextlist $contextlist )

staticinherited

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.

Return values

void

delete_data_for_userlist()

static tool_log\local\privacy\logstore_userlist_provider::delete_data_for_userlist ( \core_privacy\local\request\approved_userlist $userlist )

staticinherited

Delete all data for a list of users in the specified context.

Parameters

core_privacy\local\request\approved_userlist

$userlist

The specific context and users to delete data for.

Return values

void

export_user_data()

static tool_log\local\privacy\logstore_provider::export_user_data ( approved_contextlist $contextlist )

staticinherited

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

Parameters

approved_contextlist

$contextlist

The approved contexts to export information for.

Return values

void

get_database_and_table()

static logstore_standard\privacy\provider::get_database_and_table ( )

staticprotected

Get the database object.

Return values

array

Containing moodle_database, string, or null values.

get_export_subcontext()

static logstore_standard\privacy\provider::get_export_subcontext ( )

staticprotected

Get the path to export the logs to.

Return values

array

get_metadata()

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

---

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

• admin/tool/log/store/standard/classes/privacy/provider.php