core_payment\privacy\consumer_provider Interface Reference

Inheritance diagram for core_payment\privacy\consumer_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_contextid_for_payment (string $paymentarea, int $itemid)
	Return contextid for the provided payment data.
static	get_users_in_context (userlist $userlist)
	Get the list of users who have data within a context.

Member Function Documentation

delete_data_for_all_users_in_context()

static core_payment\privacy\consumer_provider::delete_data_for_all_users_in_context ( context $context )

static

Delete all data for all users in the specified context.

Parameters

context

$context

The specific context to delete data for.

delete_data_for_user()

static core_payment\privacy\consumer_provider::delete_data_for_user ( approved_contextlist $contextlist )

static

Delete all user data for the specified user, in the specified contexts.

Parameters

approved_contextlist

$contextlist

The approved contexts and user information to delete information for.

Implemented in enrol_fee\privacy\provider.

delete_data_for_users()

static core_payment\privacy\consumer_provider::delete_data_for_users ( approved_userlist $userlist )

static

Delete multiple users within a single context.

Parameters

approved_userlist

$userlist

The approved context and user information to delete information for.

Implemented in enrol_fee\privacy\provider.

export_user_data()

static core_payment\privacy\consumer_provider::export_user_data ( approved_contextlist $contextlist )

static

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

Parameters

approved_contextlist

$contextlist

The approved contexts to export information for.

Implemented in enrol_fee\privacy\provider.

get_contextid_for_payment()

static core_payment\privacy\consumer_provider::get_contextid_for_payment ( string $paymentarea, int $itemid )

static

Return contextid for the provided payment data.

Parameters

string	$paymentarea	Payment area
int	$itemid	The item id

Return values

int|null

Implemented in enrol_fee\privacy\provider.

get_users_in_context()

static core_payment\privacy\consumer_provider::get_users_in_context ( userlist $userlist )

static

Get the list of users who have data within a context.

Parameters

userlist

$userlist

The userlist containing the list of users who have data in this context/plugin combination.

Implemented in enrol_fee\privacy\provider.

---

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

• payment/classes/privacy/consumer_provider.php