tool_lp\output\renderer Class Reference

Renderer class for learning plans. More...

Inheritance diagram for tool_lp\output\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.
	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.
	notify_message ($message)
	Output a nofication.
	notify_problem ($message)
	Output an error notification.
	notify_success ($message)
	Output a success notification.
	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_competency_plan_navigation (competency_plan_navigation $nav)
	Defer to template.
	render_course_competencies_page (course_competencies_page $page)
	Defer to template.
	render_from_template ($templatename, $context)
	Renders a template by name with the given context.
	render_manage_competencies_page (manage_competencies_page $page)
	Defer to template.
	render_manage_competency_frameworks_page (manage_competency_frameworks_page $page)
	Defer to template.
	render_manage_templates_page (manage_templates_page $page)
	Defer to template.
	render_module_navigation (module_navigation $nav)
	Defer to template.
	render_plan_page (plan_page $page)
	Defer to template.
	render_plans_page (plans_page $page)
	Defer to template.
	render_related_competencies_section (renderable $page)
	Defer to template.
	render_template_cohorts_page (renderable $page)
	Render the template cohorts page.
	render_template_competencies_page (template_competencies_page $page)
	Defer to template.
	render_template_plans_page (renderable $page)
	Render the template plans page.
	render_user_competency_course_navigation (user_competency_course_navigation $nav)
	Defer to template.
	render_user_competency_summary (user_competency_summary $page)
	Defer to template.
	render_user_competency_summary_in_course (user_competency_summary_in_course $page)
	Defer to template.
	render_user_competency_summary_in_plan (user_competency_summary_in_plan $page)
	Defer to template.
	render_user_evidence_list_page (user_evidence_list_page $page)
	Defer to template.
	render_user_evidence_page (user_evidence_page $page)
	Defer to template.
	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 class for learning plans.

Copyright

2015 Damyon Wiese

License

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

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

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

notify_message()

tool_lp\output\renderer::notify_message

(

$message

)

Output a nofication.

Parameters

string

$message

the message to print out

Return values

string

HTML fragment.

See also

core\output\notification

notify_problem()

tool_lp\output\renderer::notify_problem

(

$message

)

Output an error notification.

Parameters

string

$message

the message to print out

Return values

string

HTML fragment.

See also

core\output\notification

notify_success()

tool_lp\output\renderer::notify_success

(

$message

)

Output a success notification.

Parameters

string

$message

the message to print out

Return values

string

HTML fragment.

See also

core\output\notification

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

tool_lp\output\renderer::render_competency_plan_navigation

(

competency_plan_navigation

$nav

)

Defer to template.

Parameters

competency_plan_navigation

$nav

Return values

string

render_course_competencies_page()

tool_lp\output\renderer::render_course_competencies_page

(

course_competencies_page

$page

)

Defer to template.

Parameters

course_competencies_page

$page

Return values

string

html for the page

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

tool_lp\output\renderer::render_manage_competencies_page

(

manage_competencies_page

$page

)

Defer to template.

Parameters

manage_competencies_page

$page

Return values

string

html for the page

render_manage_competency_frameworks_page()

tool_lp\output\renderer::render_manage_competency_frameworks_page

(

manage_competency_frameworks_page

$page

)

Defer to template.

Parameters

manage_competency_frameworks_page

$page

Return values

string

html for the page

render_manage_templates_page()

tool_lp\output\renderer::render_manage_templates_page

(

manage_templates_page

$page

)

Defer to template.

Parameters

manage_templates_page

$page

Return values

string

html for the page

render_module_navigation()

tool_lp\output\renderer::render_module_navigation

(

module_navigation

$nav

)

Defer to template.

Parameters

module_navigation

$nav

Return values

string

render_plan_page()

tool_lp\output\renderer::render_plan_page

(

plan_page

$page

)

Defer to template.

Parameters

plan_page

$page

Return values

bool|string

render_plans_page()

tool_lp\output\renderer::render_plans_page

(

plans_page

$page

)

Defer to template.

Parameters

plans_page

$page

Return values

bool|string

render_related_competencies_section()

tool_lp\output\renderer::render_related_competencies_section

(

renderable

$page

)

Defer to template.

Parameters

renderable

$page

Return values

string

render_template_cohorts_page()

tool_lp\output\renderer::render_template_cohorts_page

(

renderable

$page

)

Render the template cohorts page.

Parameters

renderable

$page

Return values

string

render_template_competencies_page()

tool_lp\output\renderer::render_template_competencies_page

(

template_competencies_page

$page

)

Defer to template.

Parameters

template_competencies_page

$page

Return values

string

html for the page

render_template_plans_page()

tool_lp\output\renderer::render_template_plans_page

(

renderable

$page

)

Render the template plans page.

Parameters

renderable

$page

Return values

string

render_user_competency_course_navigation()

tool_lp\output\renderer::render_user_competency_course_navigation

(

user_competency_course_navigation

$nav

)

Defer to template.

Parameters

user_competency_course_navigation

$nav

Return values

string

render_user_competency_summary()

tool_lp\output\renderer::render_user_competency_summary

(

user_competency_summary

$page

)

Defer to template.

Parameters

user_competency_summary

$page

Return values

string

render_user_competency_summary_in_course()

tool_lp\output\renderer::render_user_competency_summary_in_course

(

user_competency_summary_in_course

$page

)

Defer to template.

Parameters

user_competency_summary_in_course

$page

Return values

string

render_user_competency_summary_in_plan()

tool_lp\output\renderer::render_user_competency_summary_in_plan

(

user_competency_summary_in_plan

$page

)

Defer to template.

Parameters

user_competency_summary_in_plan

$page

Return values

string

render_user_evidence_list_page()

tool_lp\output\renderer::render_user_evidence_list_page

(

user_evidence_list_page

$page

)

Defer to template.

Parameters

user_evidence_list_page

$page

Return values

string

render_user_evidence_page()

tool_lp\output\renderer::render_user_evidence_page

(

user_evidence_page

$page

)

Defer to template.

Parameters

user_evidence_page

$page

Return values

string

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

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/lp/classes/output/renderer.php