Interface customfield_provider, all customfield plugins need to implement it. More...

Inheritance diagram for core_customfield\privacy\customfield_provider:

Static Public Member Functions
static	before_delete_data (string $dataidstest, array $params, array $contextids)
	Allows plugins to delete everything they store related to the data (usually files) More...

static	before_delete_fields (string $fieldidstest, array $params, array $contextids)
	Allows plugins to delete everything they store related to the field configuration (usually files) More...

static	export_customfield_data (data_controller $data, stdClass $exportdata, array $subcontext)
	Preprocesses data object that is going to be exported. More...

Detailed Description

Interface customfield_provider, all customfield plugins need to implement it.

Member Function Documentation

static core_customfield\privacy\customfield_provider::before_delete_data	(	string	$dataidstest,
		array	$params,
		array	$contextids
	)

static

Allows plugins to delete everything they store related to the data (usually files)

If plugin does not store any related files or other information, implement as an empty function

Parameters

string	$dataidstest	select query for data id (note that it may also return data for other field types)
array	$params	named parameters for the select query
array	$contextids	list of affected data contexts

Return values

mixed

static core_customfield\privacy\customfield_provider::before_delete_fields	(	string	$fieldidstest,
		array	$params,
		array	$contextids
	)

static

Allows plugins to delete everything they store related to the field configuration (usually files)

The implementation should not delete data or anything related to the data, since "before_delete_data" is invoked separately.

If plugin does not store any related files or other information, implement as an empty function

Parameters

string	$fieldidstest	select query for field id (note that it may also return fields of other types)
array	$params	named parameters for the select query
int[]	$contextids	list of affected configuration contexts

static core_customfield\privacy\customfield_provider::export_customfield_data	(	data_controller	$data,
		stdClass	$exportdata,
		array	$subcontext
	)

static

Preprocesses data object that is going to be exported.

Minimum implementation: writer::with_context($data->get_context())->export_data($subcontext, $exportdata);

Parameters

data_controller	$data
stdClass	$exportdata	generated object to be exported
array	$subcontext	subcontext to use when exporting

Return values

mixed

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