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_page ()
	Returns the moodle page object.
	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

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

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

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

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

---

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

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