core_calendar\external\event_action_exporter Class Reference

Class for displaying a calendar event's action. More...

Inheritance diagram for core_calendar\external\event_action_exporter:

Public Member Functions
	__construct (action_interface $action, $related=[])
	Constructor.

Protected Member Functions
	get_format_parameters_for_name ()
	Magic method returning parameters for formatting 'name' property.
	get_other_values (renderer_base $output)
	Get the additional values to inject while exporting.

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 calendar event's action.

Copyright

2017 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Constructor & Destructor Documentation

__construct()

core_calendar\external\event_action_exporter::__construct	(	action_interface	$action,
			$related = [] )

Constructor.

Parameters

action_interface	$action	The action object.
array	$related	Related data.

Member Function Documentation

define_other_properties()

static core_calendar\external\event_action_exporter::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

define_properties()

static core_calendar\external\event_action_exporter::define_properties ( )

staticprotected

Return the list of properties.

Return values

array

define_related()

static core_calendar\external\event_action_exporter::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

get_format_parameters_for_name()

core_calendar\external\event_action_exporter::get_format_parameters_for_name ( )

protected

Magic method returning parameters for formatting 'name' property.

Return values

bool[]

get_other_values()

core_calendar\external\event_action_exporter::get_other_values ( renderer_base $output )

protected

Get the additional values to inject while exporting.

Parameters

renderer_base

$output

The renderer.

Return values

array

Keys are the property names, values are their values.

---

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

• calendar/classes/external/event_action_exporter.php