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

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

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

---

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

• admin/tool/lp/classes/output/renderer.php