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

Privacy Subsystem implementation for core_group. More...

Inheritance diagram for core_group\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\subsystem\provider core_privacy\local\request\subsystem\plugin_provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\shared_userlist_provider core_privacy\local\request\core_user_data_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\userlist_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

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 delete_groups_for_all_users (\context $context, string $component, int $itemid=0)
 Deletes all group memberships for a specified context and component.
 
static delete_groups_for_user (approved_contextlist $contextlist, string $component, int $itemid=0)
 Deletes all records for a user from a list of approved contexts.
 
static delete_groups_for_users (approved_userlist $userlist, string $component, int $itemid=0)
 Deletes all records for multiple users within a single context.
 
static export_groups (\context $context, string $component, array $subcontext=[], int $itemid=0)
 Writes user data to the writer for the user to download.
 
static export_user_data (approved_contextlist $contextlist)
 Export all user data for the specified user, in the specified contexts.
 
static get_contexts_for_group_member (int $userid, string $component, int $itemid=0)
 Get the list of contexts that contain group membership for the specified user.
 
static get_contexts_for_userid (int $userid)
 Get the list of users who have data within a context.
 
static get_group_members_in_context (userlist $userlist, string $component, int $itemid=0)
 Add the list of users who are members of some groups in the specified constraints.
 
static get_metadata (collection $collection)
 Returns meta data about this system.
 
static get_users_in_context (userlist $userlist)
 Get the list of users who have data within a context.
 

Detailed Description

Privacy Subsystem implementation for core_group.

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

Delete all data for all users in the specified context.

Parameters
context$contextThe specific context to delete data for.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_user()

static core_group\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$contextlistThe approved contexts and user information to delete information for.

Implements core_privacy\local\request\core_user_data_provider.

◆ delete_data_for_users()

static core_group\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_groups_for_all_users()

static core_group\privacy\provider::delete_groups_for_all_users ( \context $context,
string $component,
int $itemid = 0 )
static

Deletes all group memberships for a specified context and component.

Parameters
context$contextDetails about which context to delete group memberships for.
string$componentComponent to delete. Empty string means no component (manual group memberships).
int$itemidOptional itemid associated with component.

◆ delete_groups_for_user()

static core_group\privacy\provider::delete_groups_for_user ( approved_contextlist $contextlist,
string $component,
int $itemid = 0 )
static

Deletes all records for a user from a list of approved contexts.

Parameters
approved_contextlist$contextlistContains the user ID and a list of contexts to be deleted from.
string$componentComponent to delete from. Empty string means no component (manual memberships).
int$itemidOptional itemid associated with component.

◆ delete_groups_for_users()

static core_group\privacy\provider::delete_groups_for_users ( approved_userlist $userlist,
string $component,
int $itemid = 0 )
static

Deletes all records for multiple users within a single context.

Parameters
approved_userlist$userlistThe approved context and user information to delete information for.
string$componentComponent to delete from. Empty string means no component (manual memberships).
int$itemidOptional itemid associated with component.

◆ export_groups()

static core_group\privacy\provider::export_groups ( \context $context,
string $component,
array $subcontext = [],
int $itemid = 0 )
static

Writes user data to the writer for the user to download.

Parameters
context$contextThe context to export data for.
string$componentThe component that is calling this function. Empty string means no component.
array$subcontextThe sub-context in which to export this data.
int$itemidOptional itemid associated with component.

◆ export_user_data()

static core_group\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 approved contexts to export information for.

Implements core_privacy\local\request\core_user_data_provider.

◆ get_contexts_for_group_member()

static core_group\privacy\provider::get_contexts_for_group_member ( int $userid,
string $component,
int $itemid = 0 )
static

Get the list of contexts that contain group membership for the specified user.

Parameters
int$useridThe user to search.
string$componentThe component to check.
int$itemidOptional itemid associated with component.
Return values
contextlistThe contextlist containing the list of contexts.

◆ get_contexts_for_userid()

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

Get the list of users who have data within a context.

Parameters
int$useridThe user to search.
Return values
contextlistThe contextlist containing the list of contexts used in this plugin.

Implements core_privacy\local\request\core_user_data_provider.

◆ get_group_members_in_context()

static core_group\privacy\provider::get_group_members_in_context ( userlist $userlist,
string $component,
int $itemid = 0 )
static

Add the list of users who are members of some groups in the specified constraints.

Parameters
userlist$userlistThe userlist to add the users to.
string$componentThe component to check.
int$itemidOptional itemid associated with component.

◆ get_metadata()

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

Returns meta data about this system.

Parameters
collection$collectionThe initialised collection to add items to.
Return values
collectionA listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

◆ get_users_in_context()

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

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