Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/auth/oauth2/classes/privacy/ -> provider.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401]

Privacy class for requesting user data for auth_oauth2.

Copyright: 2018 Carlos Escobedo <carlos@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 210 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

provider:: (8 methods):
  get_metadata()
  get_contexts_for_userid()
  get_users_in_context()
  export_user_data()
  delete_data_for_all_users_in_context()
  delete_data_for_users()
  delete_data_for_user()
  delete_user_data()


Class: provider  - X-Ref

Privacy provider for auth_oauth2

get_metadata(collection $collection)   X-Ref
Get information about the user data stored by this plugin.

param: collection $collection An object for storing metadata.
return: collection The metadata.

get_contexts_for_userid(int $userid)   X-Ref
Return all contexts for this userid. In this situation the user context.

param: int $userid The user ID.
return: contextlist The list of context IDs.

get_users_in_context(userlist $userlist)   X-Ref
Get the list of users within a specific context.

param: userlist $userlist The userlist containing the list of users who have data in this context/plugin combination.

export_user_data(approved_contextlist $contextlist)   X-Ref
Export all oauth2 information for the list of contexts and this user.

param: approved_contextlist $contextlist The list of approved contexts for a user.

delete_data_for_all_users_in_context(\context $context)   X-Ref
Delete all user data for this context.

param: \context $context The context to delete data for.

delete_data_for_users(approved_userlist $userlist)   X-Ref
Delete multiple users within a single context.

param: approved_userlist $userlist The approved context and user information to delete information for.

delete_data_for_user(approved_contextlist $contextlist)   X-Ref
Delete all user data for this user only.

param: approved_contextlist $contextlist The list of approved contexts for a user.

delete_user_data(int $userid)   X-Ref
This does the deletion of user data for the auth_oauth2.

param: int $userid The user ID