plugin_renderer_base Class Reference

Inheritance diagram for plugin_renderer_base:

Public Member Functions
	__construct (moodle_page $page, $target)
	Constructor method, calls the parent constructor. More...
	__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. More...
	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id. More...
	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any. More...
	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any. More...
	has_started ()
	Returns true is output has already started, and false if not. More...
	image_url ($imagename, $component='moodle')
	Return the moodle_url for an image. More...
	pix_url ($imagename, $component='moodle')
	Return the direct URL for an image from the pix folder. More...
	render (renderable $widget)
	Renders the provided widget and returns the HTML to display it. More...
	render_from_template ($templatename, $context)
	Renders a template by name with the given context. More...
	should_display_main_logo ($headinglevel=1)
	Whether we should display the main logo. More...
	should_display_navbar_logo ()
	Whether we should display the logo in the navbar. More...

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. More...

Protected Member Functions
	get_mustache ()
	Return an instance of the mustache class. More...

Protected Attributes
xhtml_container_stack	$opencontainers
	The xhtml_container_stack to use.
renderer_base core_renderer	$output
	A reference to the current renderer. More...
moodle_page	$page
	The Moodle page the renderer has been created to assist with.
string	$target
	The requested rendering target.

Constructor & Destructor Documentation

__construct()

plugin_renderer_base::__construct	(	moodle_page	$page,
			$target
	)

Constructor method, calls the parent constructor.

Parameters

moodle_page	$page
string	$target	one of rendering target constants

Reimplemented from renderer_base.

Reimplemented in format_section_renderer_base, format_topics_renderer, and core_course_renderer.

Member Function Documentation

__call()

plugin_renderer_base::__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.

Parameters

string	$method
array	$arguments

Return values

mixed

add_action_handler()

renderer_base::add_action_handler ( component_action  $action,   $id = null  )

inherited

Adds a JS action for the element with the provided id.

This method adds a JS event for the provided component action to the page and then returns the id that the event has been attached to. If no id has been provided then a new ID is generated by html_writer::random_id()

Parameters

component_action	$action
string	$id

Return values

string

id of element, either original submitted or random new if not supplied

get_compact_logo_url()

renderer_base::get_compact_logo_url (   $maxwidth = 300,   $maxheight = 300  )

inherited

Return the site's compact logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

get_logo_url()

renderer_base::get_logo_url (   $maxwidth = null,   $maxheight = 200  )

inherited

Return the site's logo URL, if any.

Parameters

int	$maxwidth	The maximum width, or null when the maximum width does not matter.
int	$maxheight	The maximum height, or null when the maximum height does not matter.

Return values

moodle_url|false

get_mustache()

renderer_base::get_mustache ( )

protectedinherited

Return an instance of the mustache class.

Since

2.9

Return values

Mustache_Engine

has_started()

renderer_base::has_started ( )

inherited

Returns true is output has already started, and false if not.

Return values

boolean

true if the header has been printed.

image_url()

renderer_base::image_url (   $imagename,   $component = 'moodle'  )

inherited

Return the moodle_url for an image.

The exact image location and extension is determined automatically by searching for gif|png|jpg|jpeg, please note there can not be diferent images with the different extension. The imagename is for historical reasons a relative path name, it may be changed later for core images. It is recommended to not use subdirectories in plugin and theme pix directories.

There are three types of images: 1/ theme images - stored in theme/mytheme/pix/, use component 'theme' 2/ core images - stored in /pix/, overridden via theme/mytheme/pix_core/ 3/ plugin images - stored in mod/mymodule/pix, overridden via theme/mytheme/pix_plugins/mod/mymodule/, example: image_url('comment', 'mod_glossary')

Parameters

string	$imagename	the pathname of the image
string	$component	full plugin name (aka component) or 'theme'

Return values

moodle_url

pix_url()

renderer_base::pix_url (   $imagename,   $component = 'moodle'  )

inherited

Return the direct URL for an image from the pix folder.

Use this function sparingly and never for icons. For icons use pix_icon or the pix helper in a mustache template.

Deprecated:

since Moodle 3.3

Parameters

string	$imagename	the name of the icon.
string	$component	specification of one plugin like in get_string()

Return values

moodle_url

prepare_classes()

static renderer_base::prepare_classes (   $classes )

staticinherited

Given an array or space-separated list of classes, prepares and returns the HTML class attribute value.

Parameters

mixed

$classes

Space-separated string or array of classes

Return values

string

HTML class attribute value

render()

plugin_renderer_base::render

(

renderable

$widget

)

Renders the provided widget and returns the HTML to display it.

Parameters

renderable

$widget

instance with renderable interface

Return values

string

Reimplemented from renderer_base.

Reimplemented in tool_policy\output\renderer.

render_from_template()

renderer_base::render_from_template (   $templatename,   $context  )

inherited

Renders a template by name with the given context.

The provided data needs to be array/stdClass made up of only simple types. Simple types are array,stdClass,bool,int,float,string

Since

2.9

Parameters

array | stdClass

$context

Context containing data for the template.

Return values

string|boolean

should_display_main_logo()

renderer_base::should_display_main_logo (   $headinglevel = 1 )

inherited

Whether we should display the main logo.

Parameters

int

$headinglevel

The heading level we want to check against.

Return values

bool

should_display_navbar_logo()

renderer_base::should_display_navbar_logo ( )

inherited

Whether we should display the logo in the navbar.

We will when there are no main logos, and we have compact logo.

Return values

bool

Member Data Documentation

$output

renderer_base core_renderer plugin_renderer_base::$output

protected

A reference to the current renderer.

The renderer provided here will be determined by the page but will in 90% of cases by the core_renderer

---

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

• lib/outputrenderers.php