core_cache\output\renderer Class Reference

Inheritance diagram for core_cache\output\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.
	additional_lock_actions ()
	Renders additional actions for locks, such as Add.
	definition_summaries (array $definitionsummaries, context $context)
	Displays definition summaries.
	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.
	lock_summaries (array $locks)
	Display basic information about lock instances.
	mode_mappings ($applicationstore, $sessionstore, $requeststore, moodle_url $editurl)
	Displays mode mappings.
	notifications (array $notifications=array())
	Renders an array of notifications for the cache configuration screen.
	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.
	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.
	store_instance_summariers (array $storeinstancesummaries, array $storepluginsummaries)
	Displays store summaries.
	store_plugin_summaries (array $storepluginsummaries)
	Displays plugin summaries.
	usage_page (\html_table $maintable, html_table $summarytable, moodleform $samplesform)
	Renders the usage page.
	usage_tables (array $usage)
	Creates the two tables which display on the usage page.

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.

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.

Member Function Documentation

additional_lock_actions()

core_cache\output\renderer::additional_lock_actions

(

)

Renders additional actions for locks, such as Add.

Return values

string

definition_summaries()

core_cache\output\renderer::definition_summaries	(	array	$definitionsummaries,
		context	$context )

Displays definition summaries.

Parameters

array	$definitionsummaries	information about each definition, as returned by core_cache\administration_helper\get_definition_summaries().
context	$context	the system context.

Return values

string

HTML.

lock_summaries()

core_cache\output\renderer::lock_summaries

(

array

$locks

)

Display basic information about lock instances.

Todo

Add some actions so that people can configure lock instances.

Parameters

array

$locks

Return values

string

mode_mappings()

core_cache\output\renderer::mode_mappings	(		$applicationstore,
			$sessionstore,
			$requeststore,
		moodle_url	$editurl )

Displays mode mappings.

Parameters

string	$applicationstore
string	$sessionstore
string	$requeststore
moodle_url	$editurl

Return values

string

HTML

notifications()

core_cache\output\renderer::notifications

(

array

$notifications = array()

)

Renders an array of notifications for the cache configuration screen.

Takes an array of notifications with the form: $notifications = array( array('This is a success message', true), array('This is a failure message', false), );

Parameters

array

$notifications

Return values

string

store_instance_summariers()

core_cache\output\renderer::store_instance_summariers	(	array	$storeinstancesummaries,
		array	$storepluginsummaries )

Displays store summaries.

Parameters

array	$storeinstancesummaries	information about each store instance, as returned by core_cache\administration_helper\get_store_instance_summaries().
array	$storepluginsummaries	information about each store plugin as returned by core_cache\administration_helper\get_store_plugin_summaries().

Return values

string

HTML

store_plugin_summaries()

core_cache\output\renderer::store_plugin_summaries

(

array

$storepluginsummaries

)

Displays plugin summaries.

Parameters

array

$storepluginsummaries

information about each store plugin as returned by core_cache\administration_helper\get_store_plugin_summaries().

Return values

string

HTML

usage_page()

core_cache\output\renderer::usage_page	(	\html_table	$maintable,
		html_table	$summarytable,
		moodleform	$samplesform )

Renders the usage page.

Parameters

html_table	$maintable	Main table
html_table	$summarytable	Summary table
moodleform	$samplesform	Form to select number of samples

Return values

string

HTML for page

usage_tables()

core_cache\output\renderer::usage_tables

(

array

$usage

)

Creates the two tables which display on the usage page.

Parameters

array

$usage

Usage information (from cache_helper\usage)

Return values

array

Array of 2 tables (main and summary table)

Exceptions

coding_exception

---

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

• cache/classes/output/renderer.php