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

Privacy Subsystem implementation for block_html. More...

Inheritance diagram for block_html\privacy\provider:
core_privacy\local\metadata\provider core_privacy\local\request\core_userlist_provider core_privacy\local\request\plugin\provider core_privacy\local\request\userlist_provider core_privacy\local\request\core_user_data_provider core_privacy\local\request\core_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 export_user_data (approved_contextlist $contextlist)
 Export all user data for the specified user, in the specified contexts.
 
static get_contexts_for_userid (int $userid)
 Get the list of contexts that contain user information for the specified user.
 
static get_metadata (collection $collection)
 Returns information about how block_html stores its data.
 
static get_users_in_context (userlist $userlist)
 Get the list of users who have data within a context.
 

Static Protected Member Functions

static get_instance_from_context (\context_block $context)
 Get the block instance record for the specified context.
 

Detailed Description

Privacy Subsystem implementation for block_html.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ delete_data_for_all_users_in_context()

static block_html\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 block_html\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 block_html\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.

◆ export_user_data()

static block_html\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_userid()

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

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

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

Implements core_privacy\local\request\core_user_data_provider.

◆ get_instance_from_context()

static block_html\privacy\provider::get_instance_from_context ( \context_block $context)
staticprotected

Get the block instance record for the specified context.

Parameters
context_block$contextThe context to fetch
Return values
stdClass

◆ get_metadata()

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

Returns information about how block_html stores its data.

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 block_html\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: