mod_choice\privacy\provider Class Reference

Implementation of the privacy subsystem plugin provider for the choice activity module. More...

Inheritance diagram for mod_choice\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 personal data for the given approved_contextlist.
static	get_contexts_for_userid (int $userid)
	Get the list of contexts that contain user information for the specified user.
static	get_metadata (collection $items)
	Return the fields which contain personal data.
static	get_users_in_context (userlist $userlist)
	Get the list of users who have data within a context.

Static Protected Member Functions
static	export_choice_data_for_user (array $choicedata, context_module $context, stdClass $user)
	Export the supplied personal data for a single choice activity, along with any generic data or area files.

Detailed Description

Implementation of the privacy subsystem plugin provider for the choice activity module.

Copyright

2018 Jun Pataleta

License

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

Member Function Documentation

delete_data_for_all_users_in_context()

static mod_choice\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 context to delete in.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static mod_choice\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

a list of contexts approved for deletion.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_users()

static mod_choice\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_choice_data_for_user()

static mod_choice\privacy\provider::export_choice_data_for_user ( array $choicedata, context_module $context, stdClass $user )

staticprotected

Export the supplied personal data for a single choice activity, along with any generic data or area files.

Parameters

array	$choicedata	the personal data to export for the choice.
context_module	$context	the context of the choice.
stdClass	$user	the user record

export_user_data()

static mod_choice\privacy\provider::export_user_data ( approved_contextlist $contextlist )

static

Export personal data for the given approved_contextlist.

User and context information is contained within the contextlist.

Parameters

approved_contextlist

$contextlist

a list of contexts approved for export.

Implements core_privacy\local\request\core_user_data_provider.

get_contexts_for_userid()

static mod_choice\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 userid.

Return values

contextlist

the list of contexts containing user info for the user.

Implements core_privacy\local\request\core_user_data_provider.

get_metadata()

static mod_choice\privacy\provider::get_metadata ( collection $items )

static

Return the fields which contain personal data.

Parameters

collection

$items

a reference to the collection to use to store the metadata.

Return values

collection

the updated collection of metadata items.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

static mod_choice\privacy\provider::get_users_in_context ( userlist $userlist )

static

Get the list of users who have data within a 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:

• mod/choice/classes/privacy/provider.php