tool_brickfield\output\printable\renderer Class Reference

Inheritance diagram for tool_brickfield\output\printable\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.
	analysisalert (int $courseid)
	This function assumes that 'scheduler\is_analysed' has already failed.
	analysisbutton (int $courseid)
	Render the analysis request button.
	cachealert ()
	Render the cache alert message.
	display (\stdClass $data, filter $filter)
	Render the page containing the Printable report.
	get_compact_logo_url ($maxwidth=300, $maxheight=300)
	Return the site's compact logo URL, if any.
	get_errors_table (\stdClass $data)
	Gets the Top Errors table.
	get_group_table (\stdClass $data)
	Gets the Check Errors table.
	get_inaccessible_table (\stdClass $data)
	Gets the Failed Activities table.
	get_logo_url ($maxwidth=null, $maxheight=200)
	Return the site's logo URL, if any.
	get_ratio_table (\stdClass $data)
	Gets the Activity Pass Ratio table.
	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.
	notvalidatedalert ()
	Render the "not validated" alert message.
	pdf_renderer (\stdClass $data, filter $filter)
	Renders the accessability report using the pdflib.
	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.
	render_table (array $headers, array $data, string $title, array $widths)
	Builds the HTML for a styled table used in the pdf report.
	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.
	tabs (filter $filter, array $tools)
	Render the valid tabs.

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.
	render_tabtree (tabtree $tabtree)
	Renders tabtree.

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

__call()

plugin_renderer_base::__call ( $method, $arguments )

inherited

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

analysisalert()

tool_brickfield\output\renderer::analysisalert ( int $courseid )

inherited

This function assumes that 'scheduler\is_analysed' has already failed.

Parameters

int

$courseid

Return values

string

Exceptions

coding_exception
moodle_exception

analysisbutton()

tool_brickfield\output\renderer::analysisbutton ( int $courseid )

inherited

Render the analysis request button.

Parameters

int

$courseid

Return values

string

Exceptions

coding_exception
moodle_exception

cachealert()

tool_brickfield\output\renderer::cachealert ( )

inherited

Render the cache alert message.

Return values

string

Exceptions

coding_exception
dml_exception

display()

tool_brickfield\output\printable\renderer::display	(	\stdClass	$data,
		filter	$filter )

Render the page containing the Printable report.

Parameters

stdClass	$data	Report data.
filter	$filter	Display filters.

Return values

String

HTML showing charts.

Exceptions

coding_exception
dml_exception
moodle_exception

Reimplemented from tool_brickfield\output\renderer.

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_errors_table()

tool_brickfield\output\printable\renderer::get_errors_table

(

\stdClass

$data

)

Gets the Top Errors table.

Parameters

stdClass

$data

Report data.

Return values

string

The HTML code of the table.

get_group_table()

tool_brickfield\output\printable\renderer::get_group_table

(

\stdClass

$data

)

Gets the Check Errors table.

Parameters

stdClass

$data

Report data.

Return values

string

The HTML code of the table.

get_inaccessible_table()

tool_brickfield\output\printable\renderer::get_inaccessible_table

(

\stdClass

$data

)

Gets the Failed Activities table.

Parameters

stdClass

$data

Report data.

Return values

string

The HTML code of the table.

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

get_ratio_table()

tool_brickfield\output\printable\renderer::get_ratio_table

(

\stdClass

$data

)

Gets the Activity Pass Ratio table.

Parameters

stdClass

$data

Report data.

Return values

string

The HTML code of the table.

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

notvalidatedalert()

tool_brickfield\output\renderer::notvalidatedalert ( )

inherited

Render the "not validated" alert message.

Return values

string

Exceptions

coding_exception

pdf_renderer()

tool_brickfield\output\printable\renderer::pdf_renderer	(	\stdClass	$data,
		filter	$filter )

Renders the accessability report using the pdflib.

Parameters

stdClass	$data	Report data.
filter	$filter	Display filters.

Exceptions

coding_exception
dml_exception
moodle_exception

Return values

void

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 )

inherited

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 core_courseformat\output\section_renderer, and 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

render_table()

tool_brickfield\output\printable\renderer::render_table	(	array	$headers,
		array	$data,
		string	$title,
		array	$widths )

Builds the HTML for a styled table used in the pdf report.

Parameters

array	$headers	The headers of the table.
array	$data	The table data.
string	$title	The title of the table.
array	$widths	The widths of the table columns.

Return values

string

The HTML code of the table.

render_tabtree()

tool_brickfield\output\renderer::render_tabtree ( tabtree $tabtree )

protectedinherited

Renders tabtree.

Parameters

tabtree

$tabtree

Return values

string

Exceptions

moodle_exception

should_display_main_logo()

renderer_base::should_display_main_logo ( $headinglevel = 1 )

inherited

Whether we should display the main logo.

Deprecated

since Moodle 4.0

Todo

final deprecation. To be removed in Moodle 4.4 MDL-73165.

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

tabs()

tool_brickfield\output\renderer::tabs ( filter $filter, array $tools )

inherited

Render the valid tabs.

Parameters

filter	$filter
array	$tools

Return values

string

Exceptions

moodle_exception

Member Data Documentation

$output

renderer_base core_renderer plugin_renderer_base::$output

protectedinherited

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:

• admin/tool/brickfield/classes/output/printable/renderer.php