core_availability_renderer Class Reference

Renderer for availability display. More...

Inheritance diagram for core_availability_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.
	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_core_availability_multiple_messages (core_availability_multiple_messages $renderable)
	Renders HTML for the result of two or more availability restriction messages being combined in a list.
	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.

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 availability display.

Copyright

2014 The Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

render_core_availability_multiple_messages()

core_availability_renderer::render_core_availability_multiple_messages

(

core_availability_multiple_messages

$renderable

)

Renders HTML for the result of two or more availability restriction messages being combined in a list.

The supplied messages should already take account of the 'not' option, e.g. an example message could be 'User profile field Department must not be set to Maths'.

This function will not be called unless there are at least two messages.

Deprecated

since Moodle 4.0 MDL-716916 - please do not use this function any more.

Parameters

core_availability_multiple_messages

$renderable

Multiple messages

Return values

string

Combined HTML

---

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

• availability/renderer.php