core_calendar\external\calendar_event_exporter Class Reference

Class for displaying a calendar event. More...

Inheritance diagram for core_calendar\external\calendar_event_exporter:

Public Member Functions
	export (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...
	get_calendar_event_type ()
	Return the normalised event type. More...

Static Public Member Functions
static	format_properties ($properties)
	Recursively formats a given property definition with the default fields required. More...
static	get_create_structure ()
	Returns the create structure. More...
static	get_read_structure ()
	Returns the read structure. More...
static	get_update_structure ()
	Returns the update structure. More...
static	properties_definition ()
	Get the properties definition of this exporter used for create, and update structures. More...
static	read_properties_definition ()
	Get the read properties definition of this exporter. More...

Protected Member Functions
	get_course_timestamp_limits ($event)
	Return the set of minimum and maximum date timestamp values for the given event. More...
	get_format_parameters ($property)
	Get the format parameters. More...
	get_module_timestamp_limits ($event)
	Return the set of minimum and maximum date timestamp values for the given event. More...
	get_module_timestamp_max_limit (\DateTimeInterface $starttime, $max)
	Get the correct maximum midnight day limit based on the event start time and the module's maximum timestamp limit. More...
	get_module_timestamp_min_limit (\DateTimeInterface $starttime, $min)
	Get the correct minimum midnight day limit based on the event start time and the module's minimum timestamp limit. More...
	get_other_values (renderer_base $output)
	Get the additional values to inject while exporting. More...
	get_timestamp_max_limit (\DateTimeInterface $starttime, $max)
	Get the correct maximum midnight day limit based on the event start time and the maximum timestamp limit of what the event belongs to. More...
	get_timestamp_min_limit (\DateTimeInterface $starttime, $min)
	Get the correct minimum midnight day limit based on the event start time and the minimum timestamp limit of what the event belongs to. More...

Static Protected Member Functions
static	define_other_properties ()
	Return the list of additional properties. More...
static	define_properties ()
	Return the list of properties. More...
static	define_related ()
	Returns a list of objects that are related. More...
static	get_context_structure ()
	Get the context structure. More...
static	get_format_field ($definitions, $property)
	Get the format field name. More...
static	get_format_structure ($property, $definition, $required=VALUE_REQUIRED)
	Get the format structure. More...
static	get_read_structure_from_properties ($properties, $required=VALUE_REQUIRED, $default=null)
	Returns the read structure from a set of properties (recursive). More...

Protected Attributes
stdClass array	$data = null
	The data of this exporter.
event_interface	$event
	$event
array	$related = array()
	$related List of related objects used to avoid DB queries.

Detailed Description

Class for displaying a calendar event.

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

Member Function Documentation

define_other_properties()

static core_calendar\external\calendar_event_exporter::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

Reimplemented from core_calendar\external\event_exporter_base.

define_properties()

static core_calendar\external\event_exporter_base::define_properties ( )

staticprotectedinherited

Return the list of properties.

Return values

array

Reimplemented from core\external\exporter.

define_related()

static core_calendar\external\calendar_event_exporter::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

Reimplemented from core_calendar\external\event_exporter_base.

export()

core\external\exporter::export ( renderer_base  $output )

finalinherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means raw records are generated as in to_record, but all strings are correctly passed through external_format_text (or external_format_string).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass

format_properties()

static core\external\exporter::format_properties (   $properties )

staticfinalinherited

Recursively formats a given property definition with the default fields required.

Parameters

array

$properties

List of properties to format

Return values

array

Formatted array

get_calendar_event_type()

core_calendar\external\calendar_event_exporter::get_calendar_event_type

(

)

Return the normalised event type.

Activity events are normalised to be course events.

Return values

string

get_context_structure()

static core\external\exporter::get_context_structure ( )

staticfinalprotectedinherited

Get the context structure.

Return values

external_single_structure

get_course_timestamp_limits()

core_calendar\external\calendar_event_exporter::get_course_timestamp_limits (   $event )

protected

Return the set of minimum and maximum date timestamp values for the given event.

Parameters

event_interface

$event

Return values

array

get_create_structure()

static core\external\exporter::get_create_structure ( )

staticfinalinherited

Returns the create structure.

Return values

external_single_structure

get_format_field()

static core\external\exporter::get_format_field (   $definitions,   $property  )

staticfinalprotectedinherited

Get the format field name.

Parameters

array	$definitions	List of properties definitions.
string	$property	The name of the property that may have a format field.

Return values

bool|string

False, or the name of the format property.

get_format_parameters()

core\external\exporter::get_format_parameters (   $property )

finalprotectedinherited

Get the format parameters.

This method returns the parameters to use with the functions external_format_text(), and external_format_string(). To override the default parameters, you can define a protected method called 'get_format_parameters_for_<propertyName>'. For example, 'get_format_parameters_for_description', if your property is 'description'.

Your method must return an array containing any of the following keys:

• context: The context to use. Defaults to $this->related['context'] if defined, else throws an exception.
• component: The component to use with external_format_text(). Defaults to null.
• filearea: The filearea to use with external_format_text(). Defaults to null.
• itemid: The itemid to use with external_format_text(). Defaults to null.
• options: An array of options accepted by external_format_text() or external_format_string(). Defaults to [].
• striplinks: Whether to strip the links with external_format_string(). Defaults to true.

Parameters

string

$property

The property to get the parameters for.

Return values

array

get_format_structure()

static core\external\exporter::get_format_structure (   $property,   $definition,   $required = VALUE_REQUIRED  )

staticfinalprotectedinherited

Get the format structure.

Parameters

string	$property	The name of the property on which the format applies.
array	$definition	The definition of the format property.
int	$required	Constant VALUE_*.

Return values

external_format_value

get_module_timestamp_limits()

core_calendar\external\calendar_event_exporter::get_module_timestamp_limits (   $event )

protected

Return the set of minimum and maximum date timestamp values for the given event.

Parameters

event_interface

$event

Return values

array

get_module_timestamp_max_limit()

core_calendar\external\calendar_event_exporter::get_module_timestamp_max_limit ( \DateTimeInterface  $starttime,   $max  )

protected

Get the correct maximum midnight day limit based on the event start time and the module's maximum timestamp limit.

Deprecated:

since Moodle 3.6. Please use get_timestamp_max_limit().

Todo:

final deprecation. To be removed in Moodle 4.0

Parameters

DateTimeInterface	$starttime	The event start time
array	$max	The module's maximum limit for the event

Return values

array

Returns an array with maxdaytimestamp and maxdayerror keys.

get_module_timestamp_min_limit()

core_calendar\external\calendar_event_exporter::get_module_timestamp_min_limit ( \DateTimeInterface  $starttime,   $min  )

protected

Get the correct minimum midnight day limit based on the event start time and the module's minimum timestamp limit.

Deprecated:

since Moodle 3.6. Please use get_timestamp_min_limit().

Todo:

final deprecation. To be removed in Moodle 4.0

Parameters

DateTimeInterface	$starttime	The event start time
array	$min	The module's minimum limit for the event

Return values

array

Returns an array with mindaytimestamp and mindayerror keys.

get_other_values()

core_calendar\external\calendar_event_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.

Reimplemented from core_calendar\external\event_exporter_base.

get_read_structure()

static core\external\exporter::get_read_structure ( )

staticfinalinherited

Returns the read structure.

Return values

external_single_structure

get_read_structure_from_properties()

static core\external\exporter::get_read_structure_from_properties (   $properties,   $required = VALUE_REQUIRED,   $default = null  )

staticfinalprotectedinherited

Returns the read structure from a set of properties (recursive).

Parameters

array	$properties	The properties.
int	$required	Whether is required.
mixed	$default	The default value.

Return values

external_single_structure

get_timestamp_max_limit()

core_calendar\external\calendar_event_exporter::get_timestamp_max_limit ( \DateTimeInterface  $starttime,   $max  )

protected

Get the correct maximum midnight day limit based on the event start time and the maximum timestamp limit of what the event belongs to.

Parameters

DateTimeInterface	$starttime	The event start time
array	$max	The module's maximum limit for the event

Return values

array

Returns an array with maxdaytimestamp and maxdayerror keys.

get_timestamp_min_limit()

core_calendar\external\calendar_event_exporter::get_timestamp_min_limit ( \DateTimeInterface  $starttime,   $min  )

protected

Get the correct minimum midnight day limit based on the event start time and the minimum timestamp limit of what the event belongs to.

Parameters

DateTimeInterface	$starttime	The event start time
array	$min	The module's minimum limit for the event

Return values

array

Returns an array with mindaytimestamp and mindayerror keys.

get_update_structure()

static core\external\exporter::get_update_structure ( )

staticfinalinherited

Returns the update structure.

This structure can never be included at the top level for an external function signature because it contains optional parameters.

Return values

external_single_structure

properties_definition()

static core\external\exporter::properties_definition ( )

staticfinalinherited

Get the properties definition of this exporter used for create, and update structures.

The read structures are returned by: self::read_properties_definition().

Return values

array

Keys are the property names, and value their definition.

read_properties_definition()

static core\external\exporter::read_properties_definition ( )

staticfinalinherited

Get the read properties definition of this exporter.

Read properties combines the default properties from the model (persistent or stdClass) with the properties defined by self::define_other_properties().

Return values

array

Keys are the property names, and value their definition.

---

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

• calendar/classes/external/calendar_event_exporter.php