core_calendar\external\day_exporter Class Reference

Class for displaying the day view. More...

Inheritance diagram for core_calendar\external\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

Detailed Description

Class for displaying the day view.

Copyright

2017 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

License

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

calendar_information	$calendar	The calendar information for the period being displayed
mixed	$data	Either an stdClass or an array of values.
array	$related	Related 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

string

The 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

$daytimestamp

The current day timestamp.

Return values

int	The 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

$output

The renderer.

Return values

array

Keys 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

$daytimestamp

The current day timestamp.

Return values

int	The 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:

• calendar/classes/external/day_exporter.php