tool_dataprivacy\external\purpose_exporter Class Reference

Class for exporting field data. More...

Inheritance diagram for tool_dataprivacy\external\purpose_exporter:

Static Public Member Functions
static	get_name ($purposeid)
	Utility function that fetches a purpose name from the given ID.

Protected Member Functions
	get_other_values (renderer_base $output)
	Return other properties.

Static Protected Member Functions
static	define_class ()
	Defines the persistent class.
static	define_other_properties ()
	Return the list of additional properties.
static	define_properties ()
	Persistent exporters get their standard properties from the persistent class.
static	define_related ()
	Returns a list of objects that are related.

Protected Attributes
core persistent	$persistent = null
	The persistent object we will export.

Detailed Description

Class for exporting field data.

Copyright

2018 David Monllao

License

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

Member Function Documentation

define_class()

static tool_dataprivacy\external\purpose_exporter::define_class ( )

staticprotected

Defines the persistent class.

Return values

string

Reimplemented from core\external\persistent_exporter.

define_other_properties()

static tool_dataprivacy\external\purpose_exporter::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

define_properties()

static core\external\persistent_exporter::define_properties ( )

staticfinalprotectedinherited

Persistent exporters get their standard properties from the persistent class.

Return values

array

Keys are the property names, and value their definition.

define_related()

static tool_dataprivacy\external\purpose_exporter::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

get_name()

static tool_dataprivacy\external\purpose_exporter::get_name ( $purposeid )

static

Utility function that fetches a purpose name from the given ID.

Parameters

int

$purposeid

The purpose ID. Could be INHERIT (false, -1), NOT_SET (0), or the actual ID.

Return values

string

The purpose name.

get_other_values()

tool_dataprivacy\external\purpose_exporter::get_other_values ( renderer_base $output )

protected

Return other properties.

Parameters

renderer_base

$output

Return values

array

Exceptions

coding_exception
Exception

---

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

• admin/tool/dataprivacy/classes/external/purpose_exporter.php