Inheritance diagram for tool_mfa\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.

	active_factors ()
	Defines section with active user's factors.

	add_action_handler (component_action $action, $id=null)
	Adds a JS action for the element with the provided id.

	available_factors ()
	Returns a list of factors which a user can add.

	factor_locked_users_table (object_factor $factor)
	Displays a table of all users with a locked instance of the given factor.

	factors_in_use_table (int $lookback)
	Displays a table of all factors in use currently.

	factors_locked_table ()
	Displays a table of all factors in use currently.

	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_state_badge (string $state)
	Returns the state of the factor as a badge.

	get_support_link ()
	Returns a rendered support link.

	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.

	mform_element (mixed $element, bool $required, bool $advanced, string\|null $error, bool $ingroup)
	Renders an mform element from a template.

	not_enough_factors ()
	Generates notification text for display when user cannot login.

	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.

	setup_factor (object $factor)
	Returns the html section for factor setup.

	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.

	verification_form (object_factor $factor, login_form $form)
	Renders the verification form.

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

◆ __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

◆ active_factors()

tool_mfa\output\renderer::active_factors ( )

Defines section with active user's factors.

Return values

string\$html

Exceptions

coding_exception

◆ 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

◆ available_factors()

tool_mfa\output\renderer::available_factors ( )

Returns a list of factors which a user can add.

Return values

string

◆ factor_locked_users_table()

tool_mfa\output\renderer::factor_locked_users_table ( object_factor $factor )

Displays a table of all users with a locked instance of the given factor.

Parameters

object_factor $factor the factor class

Return values

string the HTML for the table

◆ factors_in_use_table()

tool_mfa\output\renderer::factors_in_use_table ( int $lookback )

Displays a table of all factors in use currently.

Parameters

int $lookback the period to view.

Return values

string the HTML for the table

◆ factors_locked_table()

tool_mfa\output\renderer::factors_locked_table ( )

Displays a table of all factors in use currently.

Return values

string the HTML for the table

◆ 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

◆ get_state_badge()

tool_mfa\output\renderer::get_state_badge ( string $state )

Returns the state of the factor as a badge.

Parameters

string $state

Return values

string

◆ get_support_link()

tool_mfa\output\renderer::get_support_link ( )

Returns a rendered support link.

If the MFA guidance page is enabled, this is returned. Otherwise, the site support link is returned. If neither support link is configured, an empty string is returned.

Return values

string

◆ 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

◆ mform_element()

tool_mfa\output\renderer::mform_element	(	mixed	$element,
		bool	$required,
		bool	$advanced,
		string\|null	$error,
		bool	$ingroup )

Renders an mform element from a template.

In certain situations, includes a script element which adds autosubmission behaviour.

Parameters

mixed	$element	element
bool	$required	if input is required field
bool	$advanced	if input is an advanced field
string \| null	$error	error message to display
bool	$ingroup	True if this element is rendered as part of a group

Return values

mixed string|bool

◆ not_enough_factors()

tool_mfa\output\renderer::not_enough_factors ( )

Generates notification text for display when user cannot login.

Return values

string\$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_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

◆ setup_factor()

tool_mfa\output\renderer::setup_factor ( object $factor )

Returns the html section for factor setup.

Parameters

object $factor object of the factor class

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

◆ verification_form()

tool_mfa\output\renderer::verification_form	(	object_factor	$factor,
		login_form	$form )

Renders the verification form.

Parameters

object_factor	$factor	The factor to render the form for.
login_form	$form	The login form object.

Return values

string

Exceptions

coding_exception
dml_exception
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/mfa/classes/output/renderer.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ __call()

◆ active_factors()

◆ add_action_handler()

◆ available_factors()

◆ factor_locked_users_table()

◆ factors_in_use_table()

◆ factors_locked_table()

◆ get_compact_logo_url()

◆ get_logo_url()

◆ get_mustache()

◆ get_state_badge()

◆ get_support_link()

◆ has_started()

◆ image_url()

◆ mform_element()

◆ not_enough_factors()

◆ pix_url()

◆ prepare_classes()

◆ render()

◆ render_from_template()

◆ setup_factor()

◆ should_display_main_logo()

◆ should_display_navbar_logo()

◆ verification_form()

Member Data Documentation

◆ $output