core_calendar\external\month_exporter Class Reference

Class for displaying the month view. More...

Inheritance diagram for core_calendar\external\month_exporter:

Public Member Functions
	__construct (\calendar_information $calendar, core_calendar\type_base $type, $related)
	Constructor for month_exporter. More...
	export (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...
	set_includenavigation ($include)
	Set whether the navigation should be shown. More...
	set_initialeventsloaded (bool $loaded)
	Set whether the initial events have already been loaded and provided to the exporter. More...
	set_showcoursefilter (bool $show)
	Set whether the course filter selector should be shown. More...

Static Public Member Functions
static	format_properties ($properties)
	Recursively formats a given property definition with the default fields required. More...
static	get_create_structure ()
	Returns the create structure. More...
static	get_read_structure ()
	Returns the read structure. More...
static	get_update_structure ()
	Returns the update structure. More...
static	properties_definition ()
	Get the properties definition of this exporter used for create, and update structures. More...
static	read_properties_definition ()
	Get the read properties definition of this exporter. More...

Protected Member Functions
	get_course_filter_selector (renderer_base $output)
	Get the course filter selector. More...
	get_day_names (renderer_base $output)
	Get the list of day names for display, re-ordered from the first day of the week. More...
	get_days ()
	Get the list of days with the matching date array. More...
	get_default_add_context ()
	Get the default context for use when adding a new event. More...
	get_format_parameters ($property)
	Get the format parameters. More...
	get_month_data ()
	Get the current month timestamp. More...
	get_next_month_data ()
	Get the next month timestamp. More...
	get_other_values (renderer_base $output)
	Get the additional values to inject while exporting. More...
	get_previous_month_data ()
	Get the previous month timestamp. More...
	get_weeks (renderer_base $output)
	Get the list of week days, ordered into weeks and padded according to the value of the first day of the week. More...

Static Protected Member Functions
static	define_other_properties ()
	Return the list of additional properties. More...
static	define_properties ()
	Return the list of properties. More...
static	define_related ()
	Returns a list of objects that are related. More...
static	get_context_structure ()
	Get the context structure. More...
static	get_format_field ($definitions, $property)
	Get the format field name. More...
static	get_format_structure ($property, $definition, $required=VALUE_REQUIRED)
	Get the format structure. More...
static	get_read_structure_from_properties ($properties, $required=VALUE_REQUIRED, $default=null)
	Returns the read structure from a set of properties (recursive). More...

Protected Attributes
calendar_information	$calendar
	$calendar The calendar to be rendered.
stdClass array	$data = null
	The data of this exporter.
int	$firstdayofweek
	$firstdayofweek The first day of the week.
bool	$includenavigation = true
	$includenavigation Whether navigation should be included on the output.
bool	$initialeventsloaded = true
	$initialeventsloaded Whether the events have been loaded for this month.
array	$related = array()
	$related List of related objects used to avoid DB queries.
bool	$showcoursefilter = false
	$showcoursefilter Whether to render the course filter selector as well.
moodle_url	$url
	$url The URL for the events page.

Detailed Description

Class for displaying the month 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\month_exporter::__construct	(	\calendar_information	$calendar,
		core_calendar\type_base	$type,
			$related
	)

Constructor for month_exporter.

Parameters

calendar_information	$calendar	The calendar being represented
core_calendar\type_base	$type	The calendar type (e.g. Gregorian)
array	$related	The related information

Member Function Documentation

define_other_properties()

static core_calendar\external\month_exporter::define_other_properties ( )

staticprotected

Return the list of additional properties.

Return values

array

Reimplemented from core\external\exporter.

define_properties()

static core_calendar\external\month_exporter::define_properties ( )

staticprotected

Return the list of properties.

The format of the array returned by this method has to match the structure defined in (). Howewer you can add a new attribute "description" to describe the parameter for documenting the API.

Note that the type PARAM_TEXT should ONLY be used for strings which need to go through filters (multilang, etc...) and do not have a FORMAT_* associated to them. Typically strings passed through to format_string().

Other filtered strings which use a FORMAT_* constant (hear used with format_text) must be defined as PARAM_RAW.

Return values

array

Reimplemented from core\external\exporter.

define_related()

static core_calendar\external\month_exporter::define_related ( )

staticprotected

Returns a list of objects that are related.

Return values

array

Reimplemented from core\external\exporter.

export()

core\external\exporter::export ( renderer_base  $output )

finalinherited

Function to export the renderer data in a format that is suitable for a mustache template.

This means raw records are generated as in to_record, but all strings are correctly passed through external_format_text (or external_format_string).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass

format_properties()

static core\external\exporter::format_properties (   $properties )

staticfinalinherited

Recursively formats a given property definition with the default fields required.

Parameters

array

$properties

List of properties to format

Return values

array

Formatted array

get_context_structure()

static core\external\exporter::get_context_structure ( )

staticfinalprotectedinherited

Get the context structure.

Return values

external_single_structure

get_course_filter_selector()

core_calendar\external\month_exporter::get_course_filter_selector ( renderer_base  $output )

protected

Get the course filter selector.

Parameters

renderer_base

$output

Return values

string

The html code for the course filter selector.

get_create_structure()

static core\external\exporter::get_create_structure ( )

staticfinalinherited

Returns the create structure.

Return values

external_single_structure

get_day_names()

core_calendar\external\month_exporter::get_day_names ( renderer_base  $output )

protected

Get the list of day names for display, re-ordered from the first day of the week.

Parameters

renderer_base

$output

Return values

day_name_exporter[]

get_days()

core_calendar\external\month_exporter::get_days ( )

protected

Get the list of days with the matching date array.

Return values

array

get_default_add_context()

core_calendar\external\month_exporter::get_default_add_context ( )

protected

Get the default context for use when adding a new event.

Return values

null|context

get_format_field()

static core\external\exporter::get_format_field (   $definitions,   $property  )

staticfinalprotectedinherited

Get the format field name.

Parameters

array	$definitions	List of properties definitions.
string	$property	The name of the property that may have a format field.

Return values

bool|string

False, or the name of the format property.

get_format_parameters()

core\external\exporter::get_format_parameters (   $property )

finalprotectedinherited

Get the format parameters.

This method returns the parameters to use with the functions external_format_text(), and external_format_string(). To override the default parameters, you can define a protected method called 'get_format_parameters_for_<propertyName>'. For example, 'get_format_parameters_for_description', if your property is 'description'.

Your method must return an array containing any of the following keys:

• context: The context to use. Defaults to $this->related['context'] if defined, else throws an exception.
• component: The component to use with external_format_text(). Defaults to null.
• filearea: The filearea to use with external_format_text(). Defaults to null.
• itemid: The itemid to use with external_format_text(). Defaults to null.
• options: An array of options accepted by external_format_text() or external_format_string(). Defaults to [].
• striplinks: Whether to strip the links with external_format_string(). Defaults to true.

Parameters

string

$property

The property to get the parameters for.

Return values

array

get_format_structure()

static core\external\exporter::get_format_structure (   $property,   $definition,   $required = VALUE_REQUIRED  )

staticfinalprotectedinherited

Get the format structure.

Parameters

string	$property	The name of the property on which the format applies.
array	$definition	The definition of the format property.
int	$required	Constant VALUE_*.

Return values

external_format_value

get_month_data()

core_calendar\external\month_exporter::get_month_data ( )

protected

Get the current month timestamp.

Return values

int	The month timestamp.

get_next_month_data()

core_calendar\external\month_exporter::get_next_month_data ( )

protected

Get the next month timestamp.

Return values

int	The next month timestamp.

get_other_values()

core_calendar\external\month_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 from core\external\exporter.

get_previous_month_data()

core_calendar\external\month_exporter::get_previous_month_data ( )

protected

Get the previous month timestamp.

Return values

int	The previous month timestamp.

get_read_structure()

static core\external\exporter::get_read_structure ( )

staticfinalinherited

Returns the read structure.

Return values

external_single_structure

get_read_structure_from_properties()

static core\external\exporter::get_read_structure_from_properties (   $properties,   $required = VALUE_REQUIRED,   $default = null  )

staticfinalprotectedinherited

Returns the read structure from a set of properties (recursive).

Parameters

array	$properties	The properties.
int	$required	Whether is required.
mixed	$default	The default value.

Return values

external_single_structure

get_update_structure()

static core\external\exporter::get_update_structure ( )

staticfinalinherited

Returns the update structure.

This structure can never be included at the top level for an external function signature because it contains optional parameters.

Return values

external_single_structure

get_weeks()

core_calendar\external\month_exporter::get_weeks ( renderer_base  $output )

protected

Get the list of week days, ordered into weeks and padded according to the value of the first day of the week.

Parameters

renderer_base

$output

Return values

array

The list of weeks.

properties_definition()

static core\external\exporter::properties_definition ( )

staticfinalinherited

Get the properties definition of this exporter used for create, and update structures.

The read structures are returned by: self::read_properties_definition().

Return values

array

Keys are the property names, and value their definition.

read_properties_definition()

static core\external\exporter::read_properties_definition ( )

staticfinalinherited

Get the read properties definition of this exporter.

Read properties combines the default properties from the model (persistent or stdClass) with the properties defined by self::define_other_properties().

Return values

array

Keys are the property names, and value their definition.

set_includenavigation()

core_calendar\external\month_exporter::set_includenavigation

(

$include

)

Set whether the navigation should be shown.

Parameters

bool

$include

Return values

$this

set_initialeventsloaded()

core_calendar\external\month_exporter::set_initialeventsloaded

(

bool

$loaded

)

Set whether the initial events have already been loaded and provided to the exporter.

Parameters

bool

$loaded

Return values

$this

set_showcoursefilter()

core_calendar\external\month_exporter::set_showcoursefilter

(

bool

$show

)

Set whether the course filter selector should be shown.

Parameters

bool

$show

Return values

$this

---

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

• calendar/classes/external/month_exporter.php