core\external\persistent_exporter Class Reference

Abstract exporter based on the persistent model. More...

Inheritance diagram for core\external\persistent_exporter:

Public Member Functions
	__construct (\core\persistent $persistent, $related=array())
	Constructor - saves the persistent object, and the related objects.

Static Protected Member Functions
static	define_class ()
	Returns the specific class the persistent should be an instance of.
static	define_properties ()
	Persistent exporters get their standard properties from the persistent class.

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

Detailed Description

Abstract exporter based on the persistent model.

This automatically fills in the properties of the exporter from those of the persistent.

Copyright

2015 Damyon Wiese

License

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

Constructor & Destructor Documentation

__construct()

core\external\persistent_exporter::__construct	(	\core\persistent	$persistent,
			$related = array() )

Constructor - saves the persistent object, and the related objects.

Parameters

core\persistent	$persistent	The persistent object to export.
array	$related	- An optional list of pre-loaded objects related to this persistent.

Member Function Documentation

define_class()

static core\external\persistent_exporter::define_class ( )

staticprotected

Returns the specific class the persistent should be an instance of.

Return values

string

Reimplemented in core_competency\external\competency_exporter, core_competency\external\competency_framework_exporter, core_competency\external\course_competency_exporter, core_competency\external\course_competency_settings_exporter, core_competency\external\course_module_competency_exporter, core_competency\external\evidence_exporter, core_competency\external\plan_competency_exporter, core_competency\external\plan_exporter, core_competency\external\related_competency_exporter, core_competency\external\template_competency_exporter, core_competency\external\template_exporter, core_competency\external\user_competency_course_exporter, core_competency\external\user_competency_exporter, core_competency\external\user_competency_plan_exporter, core_competency\external\user_evidence_competency_exporter, core_competency\external\user_evidence_exporter, core_reportbuilder\external\custom_report_details_exporter, core_reportbuilder\external\custom_report_exporter, core_reportbuilder\external\system_report_exporter, tool_dataprivacy\external\category_exporter, tool_dataprivacy\external\context_instance_exporter, tool_dataprivacy\external\data_request_exporter, tool_dataprivacy\external\purpose_exporter, and tool_lp\external\user_evidence_summary_exporter.

define_properties()

static core\external\persistent_exporter::define_properties ( )

staticfinalprotected

Persistent exporters get their standard properties from the persistent class.

Return values

array

Keys are the property names, and value their definition.

---

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

• lib/classes/external/persistent_exporter.php