core_calendar\external\week_exporter Class Reference

Class for displaying the week view. More...

Inheritance diagram for core_calendar\external\week_exporter:

Public Member Functions
	__construct (\calendar_information $calendar, $days, $prepadding, $postpadding, $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_related ()
	Returns a list of objects that are related.

Protected Attributes
calendar_information	$calendar
	$calendar The calendar being displayed.
array	$days = []
	$days An array of day_exporter objects.
int	$postpadding = 0
	$postpadding The number of post-padding days at the start of the week.
int	$prepadding = 0
	$prepadding The number of pre-padding days at the start of the week.

Detailed Description

Class for displaying the week 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\week_exporter::__construct	(	\calendar_information	$calendar,
			$days,
			$prepadding,
			$postpadding,
			$related )

Constructor.

Parameters

calendar_information	$calendar	The calendar information for the period being displayed
mixed	$days	An array of day_exporter objects.
int	$prepadding	The number of pre-padding days at the start of the week.
int	$postpadding	The number of post-padding days at the start of the week.
array	$related	Related objects.

Member Function Documentation

define_other_properties()

static core_calendar\external\week_exporter::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

define_related()

static core_calendar\external\week_exporter::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

get_other_values()

core_calendar\external\week_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.

---

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

• calendar/classes/external/week_exporter.php