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
	get_calendar_event_type ()
	Return the normalised event type.

Protected Member Functions
	get_course_timestamp_limits ($event)
	Return the set of minimum and maximum date timestamp values for the given event.
	get_module_timestamp_limits ($event)
	Return the set of minimum and maximum date timestamp values for the given event.
	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.
	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.
	get_other_values (renderer_base $output)
	Get the additional values to inject while exporting.
	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.
	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.

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.

Protected Attributes
event_interface	$event
	$event

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

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.

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_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

core_calendar\local\event\entities\event_interface

$event

Return values

array

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

core_calendar\local\event\entities\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 3.10

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 3.10

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_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.

---

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

• calendar/classes/external/calendar_event_exporter.php