Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
tool_log\local\privacy\logstore_provider Interface Reference

Logstore provider interface. More...

Inheritance diagram for tool_log\local\privacy\logstore_provider:
core_privacy\local\request\plugin\subplugin_provider core_privacy\local\request\shared_data_provider core_privacy\local\request\data_provider logstore_database\privacy\provider logstore_standard\privacy\provider

Static Public Member Functions

static add_contexts_for_userid (contextlist $contextlist, $userid)
 Add contexts that contain user information for the specified user.
 
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 export_user_data (approved_contextlist $contextlist)
 Export all user data for the specified user, in the specified contexts.
 

Detailed Description

Logstore provider interface.

Logstore subplugins providers must implement this interface.

Author
Frédéric Massart fred@.nosp@m.bran.nosp@m.chup..nosp@m.tech
License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ add_contexts_for_userid()

static tool_log\local\privacy\logstore_provider::add_contexts_for_userid ( contextlist $contextlist,
$userid )
static

Add contexts that contain user information for the specified user.

Parameters
contextlist$contextlistThe contextlist to add the contexts to.
int$useridThe user to find the contexts for.
Return values
void

Implemented in logstore_database\privacy\provider, and logstore_standard\privacy\provider.

◆ delete_data_for_all_users_in_context()

static tool_log\local\privacy\logstore_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.
Return values
void

◆ delete_data_for_user()

static tool_log\local\privacy\logstore_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.
Return values
void

◆ export_user_data()

static tool_log\local\privacy\logstore_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.
Return values
void

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