tool_mfa\output\renderer Class Reference

Inheritance diagram for tool_mfa\output\renderer:

Public Member Functions
	active_factors (?string $filterfactor=null)
	Show a table displaying a users active factors.
	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_state_badge (string $state)
	Returns the state of the factor as a badge.
	get_support_link ()
	Returns a rendered support link.
	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.
	setup_factor ()
	verification_form (object_factor $factor, login_form $form)
	Renders the verification form.

Member Function Documentation

active_factors()

tool_mfa\output\renderer::active_factors

(

?string

$filterfactor = null

)

Show a table displaying a users active factors.

Parameters

string | null

$filterfactor

The factor name to filter on.

Return values

string#$html

Exceptions

coding_exception

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

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

setup_factor()

tool_mfa\output\renderer::setup_factor

(

)

Deprecated

since Moodle 4.4

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

---

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

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