core_calendar_renderer Class Reference

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 ()
	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.
	get_page ()
	Returns the moodle page object.
	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

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

(

)

Deprecated

since 4.0 MDL-72810.

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

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

---

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

• calendar/renderer.php