The primary renderer for the capability tool. More...

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

	capability_comparison_table (array $capabilities, $contextid, array $roles, $onlydiff=false)
	Produces a table to visually compare roles and capabilities.

	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.

	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.

	get_permission_classes ()
	Returns an array of permission CSS classes.

	get_permission_strings ()
	Returns an array of permission strings.

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 capability tool.

Member Function Documentation

tool_capability_renderer::capability_comparison_table	(	array	$capabilities,
			$contextid,
		array	$roles,
			$onlydiff = false )

Produces a table to visually compare roles and capabilities.

Parameters

array	$capabilities	An array of capabilities to show comparison for.
int	$contextid	The context we are displaying for.
array	$roles	An array of roles to show comparison for.
bool	$onlydiff	show only different permissions

Return values

string

tool_capability_renderer::get_permission_classes ( )

protected

Returns an array of permission CSS classes.

Return values

string[]

tool_capability_renderer::get_permission_strings ( )

protected

Returns an array of permission strings.

Return values

lang_string[]

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