Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
tool_mfa\output\renderer Class Reference
Inheritance diagram for tool_mfa\output\renderer:
plugin_renderer_base renderer_base

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 (string $filterfactor=null)
 Show a table displaying a users active 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_page ()
 Returns the moodle page object.
 
 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

◆ active_factors()

tool_mfa\output\renderer::active_factors ( string $filterfactor = null)

Show a table displaying a users active factors.

Parameters
string | null$filterfactorThe 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$factorthe factor class
Return values
stringthe 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$lookbackthe period to view.
Return values
stringthe 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
stringthe 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$elementelement
bool$requiredif input is required field
bool$advancedif input is an advanced field
string | null$errorerror message to display
bool$ingroupTrue if this element is rendered as part of a group
Return values
mixedstring|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 ( object $factor)

Returns the html section for factor setup.

Parameters
object$factorobject of the factor class
Return values
string
Deprecated
since Moodle 4.4
Todo
Final deprecation in Moodle 4.8 MDL-80995

◆ verification_form()

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

Renders the verification form.

Parameters
object_factor$factorThe factor to render the form for.
login_form$formThe login form object.
Return values
string
Exceptions
coding_exception
dml_exception
moodle_exception

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