auth_oauth2\privacy\provider Class Reference

Privacy provider for auth_oauth2. More...

Inheritance diagram for auth_oauth2\privacy\provider:

Static Public Member Functions
static	delete_data_for_all_users_in_context (\context $context)
	Delete all user data for this context. More...
static	delete_data_for_user (approved_contextlist $contextlist)
	Delete all user data for this user only. 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 oauth2 information for the list of contexts and this user. More...
static	get_contexts_for_userid (int $userid)
	Return all contexts for this userid. More...
static	get_metadata (collection $collection)
	Get information about the user data stored by this plugin. 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 (int $userid)
	This does the deletion of user data for the auth_oauth2. More...

Detailed Description

Privacy provider for auth_oauth2.

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 auth_oauth2\privacy\provider::delete_data_for_all_users_in_context ( \context  $context )

static

Delete all user data for this context.

Parameters

context

$context

The context to delete data for.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_user()

static auth_oauth2\privacy\provider::delete_data_for_user ( approved_contextlist  $contextlist )

static

Delete all user data for this user only.

Parameters

approved_contextlist

$contextlist

The list of approved contexts for a user.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_users()

static auth_oauth2\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 auth_oauth2\privacy\provider::delete_user_data ( int  $userid )

staticprotected

This does the deletion of user data for the auth_oauth2.

Parameters

int

$userid

The user ID

export_user_data()

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

static

Export all oauth2 information for the list of contexts and this user.

Parameters

approved_contextlist

$contextlist

The list of approved contexts for a user.

Implements core_privacy\local\request\core_user_data_provider.

get_contexts_for_userid()

static auth_oauth2\privacy\provider::get_contexts_for_userid ( int  $userid )

static

Return all contexts for this userid.

In this situation the user context.

Parameters

int

$userid

The user ID.

Return values

contextlist

The list of context IDs.

Implements core_privacy\local\request\core_user_data_provider.

get_metadata()

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

static

Get information about the user data stored by this plugin.

Parameters

collection

$collection

An object for storing metadata.

Return values

collection

The metadata.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

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

• auth/oauth2/classes/privacy/provider.php