core_enrol\privacy\provider Class Reference

Privacy Subsystem for core_enrol implementing metadata and plugin providers. More...

Inheritance diagram for core_enrol\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. 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 meta data about this system. More...
static	get_subcontext (array $subcontext)
	Get the subcontext for export. More...
static	get_users_in_context (userlist $userlist)
	Get the list of users within a specific context. More...

Static Protected Member Functions
static	delete_user_data (string $sql, array $params)
	Delete data from $tablename with the IDs returned by $sql query. More...

Detailed Description

Privacy Subsystem for core_enrol implementing metadata and plugin providers.

Copyright

2018 Carlos Escobedo carlo.nosp@m.s@mo.nosp@m.odle..nosp@m.com

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_enrol\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 specific context to delete data for.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static core_enrol\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_enrol\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.

delete_user_data()

static core_enrol\privacy\provider::delete_user_data ( string  $sql, array  $params  )

staticprotected

Delete data from $tablename with the IDs returned by $sql query.

Parameters

string	$sql	SQL query for getting the IDs of the uer enrolments entries to delete.
array	$params	SQL params for the query.

export_user_data()

static core_enrol\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_enrol\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 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_enrol\privacy\provider::get_metadata ( collection  $collection )

static

Returns meta data about this system.

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

static core_enrol\privacy\provider::get_subcontext ( array  $subcontext )

static

Get the subcontext for export.

Parameters

array

$subcontext

Any additional subcontext to use.

Return values

array

The array containing the full subcontext, i.e. [enrolments, subcontext]

get_users_in_context()

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

• mnet/service/enrol/classes/privacy/provider.php