Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 39 and 401] [Versions 401 and 402] [Versions 401 and 403]

Contains event class for displaying a calendar event.

Copyright: 2017 Ryan Wyllie <ryan@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 402 lines (15 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: calendar_event_exporter  - X-Ref

Class for displaying a calendar event.

define_other_properties()   X-Ref
Return the list of additional properties.

return: array

get_other_values(renderer_base $output)   X-Ref
Get the additional values to inject while exporting.

param: renderer_base $output The renderer.
return: array Keys are the property names, values are their values.

define_related()   X-Ref
Returns a list of objects that are related.

return: array

get_calendar_event_type()   X-Ref
Return the normalised event type.
Activity events are normalised to be course events.

return: string

get_course_timestamp_limits($event)   X-Ref
Return the set of minimum and maximum date timestamp values
for the given event.

param: event_interface $event
return: array

get_module_timestamp_limits($event)   X-Ref
Return the set of minimum and maximum date timestamp values
for the given event.

param: event_interface $event
return: array

get_timestamp_min_limit(\DateTimeInterface $starttime, $min)   X-Ref
Get the correct minimum midnight day limit based on the event start time
and the minimum timestamp limit of what the event belongs to.

param: DateTimeInterface $starttime The event start time
param: array $min The module's minimum limit for the event
return: array Returns an array with mindaytimestamp and mindayerror keys.

get_timestamp_max_limit(\DateTimeInterface $starttime, $max)   X-Ref
Get the correct maximum midnight day limit based on the event start time
and the maximum timestamp limit of what the event belongs to.

param: DateTimeInterface $starttime The event start time
param: array $max The module's maximum limit for the event
return: array Returns an array with maxdaytimestamp and maxdayerror keys.

get_module_timestamp_min_limit(\DateTimeInterface $starttime, $min)   X-Ref
Get the correct minimum midnight day limit based on the event start time
and the module's minimum timestamp limit.

param: DateTimeInterface $starttime The event start time
param: array $min The module's minimum limit for the event
return: array Returns an array with mindaytimestamp and mindayerror keys.

get_module_timestamp_max_limit(\DateTimeInterface $starttime, $max)   X-Ref
Get the correct maximum midnight day limit based on the event start time
and the module's maximum timestamp limit.

param: DateTimeInterface $starttime The event start time
param: array $max The module's maximum limit for the event
return: array Returns an array with maxdaytimestamp and maxdayerror keys.