Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_role\privacy\provider Class Reference

Privacy provider for core_role. More...

Inheritance diagram for core_role\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\subsystem\provider core_privacy\local\request\subsystem\plugin_provider core_privacy\local\request\user_preference_provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\core_user_data_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\core_data_provider core_privacy\local\request\userlist_provider core_privacy\local\request\core_data_provider core_privacy\local\request\data_provider core_privacy\local\request\data_provider core_privacy\local\request\data_provider

Static Public Member Functions

static delete_data_for_all_users_in_context (\context $context)
 Delete all user data for this context.
 
static delete_data_for_user (approved_contextlist $contextlist)
 Delete all user data for this user only.
 
static delete_data_for_users (approved_userlist $userlist)
 Delete multiple users within a single context.
 
static delete_user_role_to_cohort (int $userid)
 Delete user entries in role_assignments related to the feature Assign user roles to cohort feature.
 
static export_user_data (approved_contextlist $contextlist)
 Export all user data for the specified user, in the specified contexts.
 
static export_user_preferences (int $userid)
 Export all user preferences for the plugin.
 
static export_user_role_to_cohort (int $userid)
 Exports the data relating to tool_cohortroles component on role assignments by Assign user roles to cohort feature.
 
static get_contexts_for_userid (int $userid)
 Return all contexts for this userid.
 
static get_metadata (collection $collection)
 Get information about the user data stored by this plugin.
 
static get_users_in_context (userlist $userlist)
 Get the list of users within a specific context.
 

Static Protected Member Functions

static get_permissions_name ()
 Get all the permissions name in a simple array.
 
static get_roles_name ()
 Get all the localised roles name in a simple array.
 

Detailed Description

Privacy provider for core_role.

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

Delete all user data for this context.

Parameters
context$contextThe context to delete data for.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_user()

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

Delete all user data for this user only.

Parameters
approved_contextlist$contextlistThe list of approved contexts for a user.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_users()

static core_role\privacy\provider::delete_data_for_users ( approved_userlist $userlist)
static

Delete multiple users within a single context.

Parameters
approved_userlist$userlistThe approved context and user information to delete information for.

Implements core_privacy\local\request\core_userlist_provider.

◆ delete_user_role_to_cohort()

static core_role\privacy\provider::delete_user_role_to_cohort ( int $userid)
static

Delete user entries in role_assignments related to the feature Assign user roles to cohort feature.

Parameters
int$useridThe user ID.

◆ export_user_data()

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

Export all user data for the specified user, in the specified contexts.

Parameters
approved_contextlist$contextlistThe list of approved contexts for a user.

Implements core_privacy\local\request\core_user_data_provider.

◆ export_user_preferences()

static core_role\privacy\provider::export_user_preferences ( int $userid)
static

Export all user preferences for the plugin.

Parameters
int$useridThe userid of the user whose data is to be exported.

Implements core_privacy\local\request\user_preference_provider.

◆ export_user_role_to_cohort()

static core_role\privacy\provider::export_user_role_to_cohort ( int $userid)
static

Exports the data relating to tool_cohortroles component on role assignments by Assign user roles to cohort feature.

Parameters
int$useridThe user ID.

◆ get_contexts_for_userid()

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

Return all contexts for this userid.

Parameters
int$useridThe user ID.
Return values
contextlistThe list of context IDs.

Implements core_privacy\local\request\core_user_data_provider.

◆ get_metadata()

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

Get information about the user data stored by this plugin.

Parameters
collection$collectionAn object for storing metadata.
Return values
collectionThe metadata.

Implements core_privacy\local\metadata\provider.

◆ get_permissions_name()

static core_role\privacy\provider::get_permissions_name ( )
staticprotected

Get all the permissions name in a simple array.

Return values
arrayArray of permissions name.

◆ get_roles_name()

static core_role\privacy\provider::get_roles_name ( )
staticprotected

Get all the localised roles name in a simple array.

Return values
arrayArray of name of the roles by roleid.

◆ get_users_in_context()

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

Get the list of users within a specific context.

Parameters
userlist$userlistThe 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: