core_badges\external\badgeclass_exporter Class Reference

Class for displaying a badge competency. More...

Inheritance diagram for core_badges\external\badgeclass_exporter:

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

Static Public Member Functions
static	map_external_data ($data, $apiversion)
	Map data from a request response to the internal structure.
static	pick_related ()
	List properties passed in $data that should be moved to $related in the constructor.

Protected Member Functions
	get_other_values (renderer_base $output)
	We map from related data passed as data to this exporter to clean exportable values.

Static Protected Member Functions
static	define_other_properties ()
	Return the list of additional properties.
static	define_properties ()
	Return the list of properties.
static	define_related ()
	Returns a list of objects that are related.

Detailed Description

Class for displaying a badge competency.

Copyright

2019 Damyon Wiese

License

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

Constructor & Destructor Documentation

__construct()

core_badges\external\badgeclass_exporter::__construct	(		$data,
			$related = array() )

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

Parameters

mixed	$data	- Either an stdClass or an array of values.
array	$related	- An optional list of pre-loaded objects related to this object.

Member Function Documentation

define_other_properties()

static core_badges\external\badgeclass_exporter::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

define_properties()

static core_badges\external\badgeclass_exporter::define_properties ( )

staticprotected

Return the list of properties.

Return values

array

define_related()

static core_badges\external\badgeclass_exporter::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

get_other_values()

core_badges\external\badgeclass_exporter::get_other_values ( renderer_base $output )

protected

We map from related data passed as data to this exporter to clean exportable values.

Parameters

renderer_base

$output

Return values

array

map_external_data()

static core_badges\external\badgeclass_exporter::map_external_data ( $data, $apiversion )

static

Map data from a request response to the internal structure.

Parameters

stdClass	$data	The remote data.
string	$apiversion	The backpack version used to communicate remotely.

Return values

stdClass

pick_related()

static core_badges\external\badgeclass_exporter::pick_related ( )

static

List properties passed in $data that should be moved to $related in the constructor.

Return values

array

A list of properties to move from $data to $related.

---

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

• badges/classes/external/badgeclass_exporter.php