Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_userkey\privacy\provider Class Reference

Privacy class for requesting user data. More...

Inheritance diagram for core_userkey\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\subsystem\plugin_provider core_privacy\local\request\shared_userlist_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\userlist_provider core_privacy\local\request\data_provider

Static Public Member Functions

static delete_userkeys (string $script, $userid=null, $instance=null)
 Deletes all userkeys for a script.
 
static export_userkeys (\context $context, array $subcontext, string $script, $instance=null)
 Exports the data relating to user keys for the specified scripts and instance, within the specified context/subcontext.
 
static get_metadata (collection $collection)
 Returns meta data about this system.
 
static get_user_contexts_with_script (userlist $userlist, context $context, string $script, int $instance=null)
 Get the list of users within a specific context for this system.
 

Detailed Description

Privacy class for requesting user data.

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

Member Function Documentation

◆ delete_userkeys()

static core_userkey\privacy\provider::delete_userkeys ( string $script,
$userid = null,
$instance = null )
static

Deletes all userkeys for a script.

Parameters
string$scriptThe owner of the data (usually a component name).
int$useridThe owner of the data.
int$instanceThe instance owner of the data.

◆ export_userkeys()

static core_userkey\privacy\provider::export_userkeys ( \context $context,
array $subcontext,
string $script,
$instance = null )
static

Exports the data relating to user keys for the specified scripts and instance, within the specified context/subcontext.

Parameters
context$contextContext owner of the data.
array$subcontextContext owner of the data.
string$scriptThe owner of the data (usually a component name).
int$instanceThe instance owner of the data.

◆ get_metadata()

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

Returns meta data about this system.

Parameters
collection$collectionThe initialised collection to add items to.
Return values
collectionA listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

◆ get_user_contexts_with_script()

static core_userkey\privacy\provider::get_user_contexts_with_script ( userlist $userlist,
context $context,
string $script,
int $instance = null )
static

Get the list of users within a specific context for this system.

Parameters
userlist$userlistThe userlist containing the list of users who have data in this context/plugin combination.
context$contextThe context.
string$scriptThe unique target identifier.
int$instanceThe instance ID.

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