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

Privacy Subsystem implementation for core_payment. More...

Inheritance diagram for core_payment\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_payment_sql (string $paymentsql, array $paymentparams)
 Delete all user data related to the given payments.
 
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_payment_data_for_user_in_context (\context $context, array $subpath, int $userid, string $component, string $paymentarea, int $itemid)
 Export all user data for the specified user, in the specified 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 users who have data within a context.
 
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_payment.

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_payment\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_payment_sql()

static core_payment\privacy\provider::delete_data_for_payment_sql ( string $paymentsql,
array $paymentparams )
static

Delete all user data related to the given payments.

Parameters
string$paymentsqlSQL query that selects payment.id field for the payments
array$paymentparamsArray of parameters for $paymentsql

◆ delete_data_for_user()

static core_payment\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_payment\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_payment_data_for_user_in_context()

static core_payment\privacy\provider::export_payment_data_for_user_in_context ( \context $context,
array $subpath,
int $userid,
string $component,
string $paymentarea,
int $itemid )
static

Export all user data for the specified user, in the specified context.

Parameters
context$contextThe context that the payment belongs to
string[]$subpathSub-path to be used during export
int$useridUser id
string$componentComponent name
string$paymentareaPayment area
int$itemidAn internal identifier that is used by the component

◆ export_user_data()

static core_payment\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 core_payment\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_metadata()

static core_payment\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_payment\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: