auth_lti\output\renderer Class Reference

Inheritance diagram for auth_lti\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.
	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_account_binding_complete (notification $notification, moodle_url $returnurl)
	Render the page displayed when the account binding is complete, letting the user continue to the launch.
	render_account_binding_options_page (int $provisioningmode)
	Render the account options view, displayed to instructors on first launch if no account binding exists.
	render_from_template ($templatename, $context)
	Renders a template by name with the given context.
	should_display_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.

Member Function Documentation

render_account_binding_complete()

auth_lti\output\renderer::render_account_binding_complete	(	notification	$notification,
		moodle_url	$returnurl )

Render the page displayed when the account binding is complete, letting the user continue to the launch.

Callers can provide different messages depending on which type of binding took place. For example, a newly provisioned account may require a slightly different message to an existing account being linked.

The return URL is the page the user will be taken back to when they click 'Continue'. This is likely the launch or deeplink launch endpoint but could be any calling code in LTI which wants to use the account binding workflow.

Parameters

notification	$notification	the notification containing the message describing the binding success.
moodle_url	$returnurl	the URL to return to when the user clicks continue on the rendered page.

Return values

string

the rendered HTML

render_account_binding_options_page()

auth_lti\output\renderer::render_account_binding_options_page

(

int

$provisioningmode

)

Render the account options view, displayed to instructors on first launch if no account binding exists.

Parameters

int

$provisioningmode

the desired account provisioning mode, see auth_plugin_lti constants for details.

Return values

string

the html.

---

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

• auth/lti/classes/output/renderer.php