Privacy Subsystem implementation for core_group.
More...
|
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.
|
|
Privacy Subsystem implementation for core_group.
- Copyright
- 2018 Shamim Rezaie shami.nosp@m.m@mo.nosp@m.odle..nosp@m.com
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ delete_data_for_all_users_in_context()
static core_group\privacy\provider::delete_data_for_all_users_in_context |
( |
\context | $context | ) |
|
|
static |
◆ delete_data_for_user()
◆ delete_data_for_users()
static core_group\privacy\provider::delete_data_for_users |
( |
approved_userlist | $userlist | ) |
|
|
static |
◆ 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 | $context | Details about which context to delete group memberships for. |
string | $component | Component to delete. Empty string means no component (manual group memberships). |
int | $itemid | Optional 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 | $contextlist | Contains the user ID and a list of contexts to be deleted from. |
string | $component | Component to delete from. Empty string means no component (manual memberships). |
int | $itemid | Optional 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 | $userlist | The approved context and user information to delete information for. |
string | $component | Component to delete from. Empty string means no component (manual memberships). |
int | $itemid | Optional 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 | $context | The context to export data for. |
string | $component | The component that is calling this function. Empty string means no component. |
array | $subcontext | The sub-context in which to export this data. |
int | $itemid | Optional itemid associated with component. |
◆ export_user_data()
◆ 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 | $userid | The user to search. |
string | $component | The component to check. |
int | $itemid | Optional itemid associated with component. |
- Return values
-
contextlist | The 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 | $userid | The user to search. |
- Return values
-
contextlist | The 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 | $userlist | The userlist to add the users to. |
string | $component | The component to check. |
int | $itemid | Optional itemid associated with component. |
◆ get_metadata()
static core_group\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_users_in_context()
static core_group\privacy\provider::get_users_in_context |
( |
userlist | $userlist | ) |
|
|
static |
The documentation for this class was generated from the following file:
- group/classes/privacy/provider.php