Interface datafield_provider, all datafield plugins need to implement it. More...

Inheritance diagram for mod_data\privacy\datafield_provider:

Static Public Member Functions
static	delete_data_content ($context, $recordobj, $fieldobj, $contentobj)
	Allows plugins to delete locally stored data.

static	export_data_content ($context, $recordobj, $fieldobj, $contentobj, $defaultvalue)
	Exports data about one record in {data_content} table.

Detailed Description

Interface datafield_provider, all datafield plugins need to implement it.

Copyright: 2018 Marina Glancy

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

Member Function Documentation

◆ delete_data_content()

static mod_data\privacy\datafield_provider::delete_data_content	(	$context,
		$recordobj,
		$fieldobj,
		$contentobj )

static

Allows plugins to delete locally stored data.

Usually datafield plugins do not store anything and this method will be empty.

Parameters

context_module	$context
stdClass	$recordobj	record from DB table {data_records}
stdClass	$fieldobj	record from DB table {data_fields}
stdClass	$contentobj	record from DB table {data_content}

Implemented in datafield_checkbox\privacy\provider, datafield_date\privacy\provider, datafield_file\privacy\provider, datafield_latlong\privacy\provider, datafield_menu\privacy\provider, datafield_multimenu\privacy\provider, datafield_number\privacy\provider, datafield_picture\privacy\provider, datafield_radiobutton\privacy\provider, datafield_text\privacy\provider, datafield_textarea\privacy\provider, and datafield_url\privacy\provider.

◆ export_data_content()

static mod_data\privacy\datafield_provider::export_data_content	(	$context,
		$recordobj,
		$fieldobj,
		$contentobj,
		$defaultvalue )

static

Exports data about one record in {data_content} table.

Datafield plugins providers should implement this method to:

preprocess references to files in the response (examples - textarea, picture, file)
make content more human-readable (example - replace values separators in multimenu, format date in date)
add more information about the field itself (example - list all options for menu, multimenu, radio)

Sample implementation (from datafield_textarea):

$defaultvalue->content = writer::with_context($context) ->rewrite_pluginfile_urls([$recordobj->id, $contentobj->id], 'mod_data', 'content', $contentobj->id, $defaultvalue->content); writer::with_context($context)->export_data([$recordobj->id, $contentobj->id], $defaultvalue);