core_xapi\privacy\provider Class Reference

Privacy implementation for core xAPI Library. More...

Inheritance diagram for core_xapi\privacy\provider:

Static Public Member Functions
static	add_contexts_for_userid (core_privacy\local\request\contextlist $contextlist, int $userid, string $component)
	Provide a list of contexts which have xAPI for the user, in the respective area (component/itemtype combination).
static	add_userids_for_context (\core_privacy\local\request\userlist $userlist)
	Add users to a userlist who have xAPI within the specified context.
static	delete_states_for_all_users (\context $context, string $component)
	Delete all xAPI states for all users in the specified contexts, and component area.
static	delete_states_for_user (approved_contextlist $contextlist, string $component, int $itemid=0)
	Delete all xAPI states for the specified user, in the specified contexts.
static	delete_states_for_userlist (\core_privacy\local\request\approved_userlist $userlist, int $itemid=0)
	Delete all xAPI states for the specified users in the specified context, component area and item type.
static	get_metadata (collection $collection)
	Return the fields which contain personal data.
static	get_xapi_states_for_user (int $userid, string $component, int $itemid)
	Get xAPI states data for the specified user in the specified component and item ID.

Detailed Description

Privacy implementation for core xAPI Library.

Copyright

2020 Ferran Recio

License

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

Member Function Documentation

add_contexts_for_userid()

static core_xapi\privacy\provider::add_contexts_for_userid ( core_privacy\local\request\contextlist $contextlist, int $userid, string $component )

static

Provide a list of contexts which have xAPI for the user, in the respective area (component/itemtype combination).

This method is to be called by consumers of the xAPI subsystem (plugins), in their get_contexts_for_userid() method, to add the contexts for items which may have xAPI data, but would normally not be reported as having user data by the plugin responsible for them.

Parameters

core_privacy\local\request\contextlist	$contextlist
int	$userid	The id of the user in scope.
string	$component	the frankenstyle component name.

add_userids_for_context()

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

static

Add users to a userlist who have xAPI within the specified context.

Parameters

core_privacy\local\request\userlist

$userlist

The userlist to add the users to.

Return values

void

delete_states_for_all_users()

static core_xapi\privacy\provider::delete_states_for_all_users ( \context $context, string $component )

static

Delete all xAPI states for all users in the specified contexts, and component area.

Parameters

context	$context	The context to which deletion is scoped.
string	$component	The component name.

Exceptions

dml_exception

if any errors are encountered during deletion.

delete_states_for_user()

static core_xapi\privacy\provider::delete_states_for_user ( approved_contextlist $contextlist, string $component, int $itemid = 0 )

static

Delete all xAPI states for the specified user, in the specified contexts.

Parameters

approved_contextlist	$contextlist	The approved contexts and user information to delete information for.
string	$component	The component name.
int	$itemid	Optional itemid associated with component.

Exceptions

coding_exception
dml_exception

delete_states_for_userlist()

static core_xapi\privacy\provider::delete_states_for_userlist ( \core_privacy\local\request\approved_userlist $userlist, int $itemid = 0 )

static

Delete all xAPI states for the specified users in the specified context, component area and item type.

Parameters

core_privacy\local\request\approved_userlist	$userlist	The approved contexts and user information to delete information for.
int	$itemid	Optional itemid associated with component.

Exceptions

dml_exception

if any errors are encountered during deletion.

get_metadata()

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

static

Return the fields which contain personal data.

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

static core_xapi\privacy\provider::get_xapi_states_for_user ( int $userid, string $component, int $itemid )

static

Get xAPI states data for the specified user in the specified component and item ID.

Parameters

int	$userid	The id of the user in scope.
string	$component	The component name.
int	$itemid	The item ID.

Return values

array|null

---

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

• lib/xapi/classes/privacy/provider.php