Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
tool_mfa\privacy\provider Class Reference

Privacy provider. More...

Inheritance diagram for tool_mfa\privacy\provider:

Static Public Member Functions

static delete_data_for_all_users_in_context (\context $context)
 Deletes data for all users in context.
 
static delete_data_for_user (approved_contextlist $contextlist)
 Deletes all data in all provided contexts for user.
 
static delete_data_for_users (approved_userlist $userlist)
 Given a userlist, deletes all data in all provided contexts for the users.
 
static export_user_data (approved_contextlist $contextlist)
 Exports all data stored in provided contexts for user.
 
static get_contexts_for_userid (int $userid)
 Get the list of contexts that contain user information for the given user.
 
static get_metadata (collection $collection)
 Returns metadata about this plugin's privacy policy.
 
static get_users_in_context (userlist $userlist)
 Gets the list of users who have data with a context.
 

Detailed Description

Privacy provider.

Member Function Documentation

◆ delete_data_for_all_users_in_context()

static tool_mfa\privacy\provider::delete_data_for_all_users_in_context ( \context $context)
static

Deletes data for all users in context.

Parameters
context$contextThe context to delete for.
Return values
void

◆ delete_data_for_user()

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

Deletes all data in all provided contexts for user.

Parameters
approved_contextlist$contextlistthe list of contexts to delete for.
Return values
void

◆ delete_data_for_users()

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

Given a userlist, deletes all data in all provided contexts for the users.

Parameters
approved_userlist$userlistthe list of users to delete data for
Return values
void

◆ export_user_data()

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

Exports all data stored in provided contexts for user.

Secrets should not be exported as they are transient.

Parameters
approved_contextlist$contextlistthe list of contexts to export for.
Return values
void

◆ get_contexts_for_userid()

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

Get the list of contexts that contain user information for the given user.

Parameters
int$useridthe userid to search.
Return values
contextlistthe contexts in which data is contained.

◆ get_metadata()

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

Returns metadata about this plugin's privacy policy.

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 tool_mfa\privacy\provider::get_users_in_context ( userlist $userlist)
static

Gets the list of users who have data with a context.

Secrets context is a subset of this table.

Parameters
userlist$userlistthe userlist containing users who have data in this context.
Return values
void

The documentation for this class was generated from the following file: