The primary renderer for the calendar. More...

Inheritance diagram for core_calendar_renderer:

Public Member Functions
	__call ($method, $arguments)
	Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.

	add_event_button ($courseid, $unused1=null, $unused2=null, $unused3=null, $unused4=null)
	Creates a button to add a new event.

	add_pretend_calendar_block (block_contents $bc, $pos=BLOCK_POS_RIGHT)
	Adds a pretent calendar block.

	complete_layout ()
	Creates the remainder of the layout.

	course_filter_selector (moodle_url $returnurl, $label=null, $courseid=null, int $calendarinstanceid=null)
	Displays a course filter selector.

	event (calendar_event $event, $showactions=true)
	Displays an event.

	event_filter ()
	Render the event filter region.

	fake_block_threemonths (calendar_information $calendar)
	Produces the content for the three months block (pretend block)

	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.

	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.

	has_started ()
	Returns true is output has already started, and false if not.

	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image.

	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder.

	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it.

	render_from_template ($templatename, $context)
	Renders a template by name with the given context.

	render_import_result (array $result)
	Render the calendar import result.

	render_no_calendar_subscriptions ()
	Render the subscriptions blank state appearance.

	render_subscriptions_header ()
	Render the subscriptions header.

	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo.

	should_display_navbar_logo ()
	Whether we should display the logo in the navbar.

	start_layout ()
	Starts the standard layout for the page.

	subscription_details ($unused, $subscriptions, $unused2='')
	Renders a table containing information about calendar subscriptions.

Static Public Member Functions
static	prepare_classes ($classes)
	Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Protected Member Functions
	get_mustache ()
	Return an instance of the mustache class.

	render_subscription_update_interval (stdClass $subscription)
	Render subscription update interval form.

	subscription_action_links ()
	Creates a form to perform actions on a given subscription.

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.

renderer_base core_renderer	$output
	A reference to the current renderer.

moodle_page	$page
	The Moodle page the renderer has been created to assist with.

string	$target
	The requested rendering target.

array	$templatecache = []
	$templatecache The mustache template cache.

Detailed Description

The primary renderer for the calendar.

Member Function Documentation

◆ __call()

plugin_renderer_base::__call	(		$method,
			$arguments )

inherited

Magic method used to pass calls otherwise meant for the standard renderer to it to ensure we don't go causing unnecessary grief.

Parameters

string	$method
array	$arguments

Return values

mixed

◆ add_action_handler()

renderer_base::add_action_handler	(	component_action	$action,
			$id = null )

inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters

component_action	$action
string	$id

Return values

string id of element, either original submitted or random new if not supplied

◆ add_event_button()

core_calendar_renderer::add_event_button	(	$courseid,
		$unused1 = null,
		$unused2 = null,
		$unused3 = null,
		$unused4 = null )

Creates a button to add a new event.

Parameters

int	$courseid
int	$unused1
int	$unused2
int	$unused3
int	$unused4

Return values

string

◆ add_pretend_calendar_block()

core_calendar_renderer::add_pretend_calendar_block	(	block_contents	$bc,
			$pos = BLOCK_POS_RIGHT )

Adds a pretent calendar block.

Parameters

block_contents	$bc
mixed	$pos	BLOCK_POS_RIGHT \| BLOCK_POS_LEFT

◆ complete_layout()

core_calendar_renderer::complete_layout ( )

Creates the remainder of the layout.

Return values

string

◆ course_filter_selector()

core_calendar_renderer::course_filter_selector	(	moodle_url	$returnurl,
			$label = null,
			$courseid = null,
		int	$calendarinstanceid = null )

Displays a course filter selector.

Parameters

moodle_url	$returnurl	The URL that the user should be taken too upon selecting a course.
string	$label	The label to use for the course select.
int	$courseid	The id of the course to be selected.
int \| null	$calendarinstanceid	The instance ID of the calendar we're generating this course filter for.

Return values

string

◆ event()

core_calendar_renderer::event	(	calendar_event	$event,
			$showactions = true )

Displays an event.

Deprecated: since 3.9

Parameters

calendar_event	$event
bool	$showactions

Return values

string

◆ event_filter()

core_calendar_renderer::event_filter ( )

Render the event filter region.

Return values

string

◆ fake_block_threemonths()

core_calendar_renderer::fake_block_threemonths ( calendar_information $calendar )

Produces the content for the three months block (pretend block)

This includes the previous month, the current month, and the next month

Deprecated: since 4.0 MDL-72810.

Todo: MDL-73117 This will be deleted in Moodle 4.4.

Parameters

calendar_information $calendar

Return values

string

◆ get_compact_logo_url()

renderer_base::get_compact_logo_url	(		$maxwidth = 300,
			$maxheight = 300 )

inherited

Return the site's compact logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

◆ get_logo_url()

renderer_base::get_logo_url	(		$maxwidth = null,
			$maxheight = 200 )

inherited

Return the site's logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

◆ get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since: 2.9

Return values

Mustache_Engine

◆ has_started()

renderer_base::has_started ( )

inherited

Returns true is output has already started, and false if not.

Return values

boolean true if the header has been printed.

◆ image_url()

renderer_base::image_url	(		$imagename,
			$component = 'moodle' )

inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

◆ pix_url()

renderer_base::pix_url	(		$imagename,
			$component = 'moodle' )

inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated: since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

◆ prepare_classes()

static renderer_base::prepare_classes ( $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed $classes Space-separated string or array of classes

Return values

string HTML class attribute value

◆ render()

plugin_renderer_base::render ( renderable $widget )

inherited

Renders the provided widget and returns the HTML to display it.

Parameters

renderable $widget instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in core_courseformat\output\section_renderer, and tool_policy\output\renderer.

◆ render_from_template()

renderer_base::render_from_template	(		$templatename,
			$context )

inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since: 2.9

Parameters

array | stdClass $context Context containing data for the template.

Return values

string|boolean

◆ render_import_result()

core_calendar_renderer::render_import_result ( array $result )

Render the calendar import result.

Parameters

array $result Import result

Return values

string|null

◆ render_no_calendar_subscriptions()

core_calendar_renderer::render_no_calendar_subscriptions ( )

Render the subscriptions blank state appearance.

Return values

string

◆ render_subscription_update_interval()

core_calendar_renderer::render_subscription_update_interval ( stdClass $subscription )

protected

Render subscription update interval form.

Parameters

stdClass $subscription

Return values

string

◆ render_subscriptions_header()

core_calendar_renderer::render_subscriptions_header ( )

Render the subscriptions header.

Return values

string

◆ should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated: since Moodle 4.0

Todo: final deprecation. To be removed in Moodle 4.4 MDL-73165.

Parameters

int $headinglevel The heading level we want to check against.

Return values

bool

◆ should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

◆ start_layout()

core_calendar_renderer::start_layout ( )

Starts the standard layout for the page.

Return values

string

◆ subscription_action_links()

core_calendar_renderer::subscription_action_links ( )

protected

Creates a form to perform actions on a given subscription.

Return values

string

◆ subscription_details()

core_calendar_renderer::subscription_details	(	$unused,
		$subscriptions,
		$unused2 = '' )

Renders a table containing information about calendar subscriptions.

Parameters

int	$unused
array	$subscriptions
string	$unused2

Return values

string

Member Data Documentation

◆ $output

renderer_base core_renderer plugin_renderer_base::$output

protectedinherited

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer

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

calendar/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __call()

◆ add_action_handler()

◆ add_event_button()

◆ add_pretend_calendar_block()

◆ complete_layout()

◆ course_filter_selector()

◆ event()

◆ event_filter()

◆ fake_block_threemonths()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ has_started()

◆ image_url()

◆ pix_url()

◆ prepare_classes()

◆ render()

◆ render_from_template()

◆ render_import_result()

◆ render_no_calendar_subscriptions()

◆ render_subscription_update_interval()

◆ render_subscriptions_header()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ start_layout()

◆ subscription_action_links()

◆ subscription_details()

Member Data Documentation

◆ $output