Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_calendar\external\event_exporter_base Class Reference

Class for displaying a calendar event. More...

Inheritance diagram for core_calendar\external\event_exporter_base:
core_calendar\external\calendar_event_exporter core_calendar\external\event_exporter

Public Member Functions

 __construct (event_interface $event, $related=[])
 Constructor.
 

Protected Member Functions

 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.
 

Protected Attributes

event_interface $event
 $event
 

Detailed Description

Class for displaying a calendar event.

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

Constructor & Destructor Documentation

◆ __construct()

core_calendar\external\event_exporter_base::__construct ( event_interface $event,
$related = [] )

Constructor.

Parameters
event_interface$event
array$relatedThe related data.

Member Function Documentation

◆ define_other_properties()

static core_calendar\external\event_exporter_base::define_other_properties ( )
staticprotected

Return the list of additional properties.

Return values
array

Reimplemented in core_calendar\external\calendar_event_exporter, and core_calendar\external\event_exporter.

◆ define_properties()

static core_calendar\external\event_exporter_base::define_properties ( )
staticprotected

Return the list of properties.

Return values
array

◆ define_related()

static core_calendar\external\event_exporter_base::define_related ( )
staticprotected

Returns a list of objects that are related.

Return values
array

Reimplemented in core_calendar\external\calendar_event_exporter.

◆ get_other_values()

core_calendar\external\event_exporter_base::get_other_values ( renderer_base $output)
protected

Get the additional values to inject while exporting.

Parameters
renderer_base$outputThe renderer.
Return values
arrayKeys are the property names, values are their values.

Reimplemented in core_calendar\external\calendar_event_exporter, and core_calendar\external\event_exporter.


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