Renderer for block navigation. More...

Inheritance diagram for block_navigation_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.

	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.

	navigation_tree (global_navigation $navigation, $expansionlimit, array $options=array())
	Returns the content of the navigation tree.

	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.

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.

	navigation_node ($items, $attrs=array(), $expansionlimit=null, array $options=array(), $depth=1)
	Produces a navigation node for the navigation tree.

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

Renderer for block navigation.

Member Function Documentation

block_navigation_renderer::navigation_node	(		$items,
			$attrs = array(),
			$expansionlimit = null,
		array	$options = array(),
			$depth = 1 )

protected

Produces a navigation node for the navigation tree.

Parameters

Return values

string

block_navigation_renderer::navigation_tree	(	global_navigation	$navigation,
			$expansionlimit,
		array	$options = array() )

Returns the content of the navigation tree.

Parameters

Return values

string#$content

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