core_files\privacy\provider Class Reference

Data provider class. More...

Inheritance diagram for core_files\privacy\provider:

Static Public Member Functions
static	delete_data_for_all_users_in_context (\context $context)
	Delete all use data which matches the specified deletion_criteria. 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 metadata. More...
static	get_users_in_context (userlist $userlist)
	Get the list of users within a specific context. More...

Detailed Description

Data provider class.

This only describes the files table, all components must handle the file exporting and deletion themselves.

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

delete_data_for_all_users_in_context()

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

static

Delete all use data which matches the specified deletion_criteria.

Parameters

context

$context

A user context.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static core_files\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_files\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_files\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_files\privacy\provider::get_contexts_for_userid ( int  $userid )

static

Get the list of contexts that contain user information for the specified user.

This is currently just the user context.

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

get_users_in_context()

static core_files\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:

• repository/coursefiles/classes/privacy/provider.php