Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
core_calendar\external\day_exporter Class Reference
Inheritance diagram for core_calendar\external\day_exporter:
core_calendar\external\week_day_exporter

Public Member Functions

 __construct (\calendar_information $calendar, $data, $related)
 Constructor.
 

Protected Member Functions

 get_navigation ()
 Get the calendar navigation controls.
 
 get_next_day_timestamp ($daytimestamp)
 Get the next day timestamp.
 
 get_other_values (renderer_base $output)
 Get the additional values to inject while exporting.
 
 get_previous_day_timestamp ($daytimestamp)
 Get the previous day timestamp.
 
 get_view_link_title ()
 Get the title for view link.
 

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

calendar_information $calendar
 $calendar The calendar being displayed.
 
moodle_url $url
 

Constructor & Destructor Documentation

◆ __construct()

core_calendar\external\day_exporter::__construct ( \calendar_information $calendar,
$data,
$related )

Constructor.

Parameters
calendar_information$calendarThe calendar information for the period being displayed
mixed$dataEither an stdClass or an array of values.
array$relatedRelated objects.

Reimplemented in core_calendar\external\week_day_exporter.

Member Function Documentation

◆ define_other_properties()

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

Return the list of additional properties.

Return values
array

Reimplemented in core_calendar\external\week_day_exporter.

◆ define_properties()

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

Return the list of properties.

Return values
array

Reimplemented in core_calendar\external\week_day_exporter.

◆ define_related()

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

Returns a list of objects that are related.

Return values
array

Reimplemented in core_calendar\external\week_day_exporter.

◆ get_navigation()

core_calendar\external\day_exporter::get_navigation ( )
protected

Get the calendar navigation controls.

Return values
stringThe html code to the calendar top navigation.

◆ get_next_day_timestamp()

core_calendar\external\day_exporter::get_next_day_timestamp ( $daytimestamp)
protected

Get the next day timestamp.

Parameters
int$daytimestampThe current day timestamp.
Return values
intThe next day timestamp.

◆ get_other_values()

core_calendar\external\day_exporter::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\week_day_exporter.

◆ get_previous_day_timestamp()

core_calendar\external\day_exporter::get_previous_day_timestamp ( $daytimestamp)
protected

Get the previous day timestamp.

Parameters
int$daytimestampThe current day timestamp.
Return values
intThe previous day timestamp.

◆ get_view_link_title()

core_calendar\external\day_exporter::get_view_link_title ( )
protected

Get the title for view link.

Return values
string

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