Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
|
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. | |
tool_mfa\output\renderer::active_factors | ( | string | $filterfactor = null | ) |
Show a table displaying a users active factors.
string | null | $filterfactor | The factor name to filter on. |
string\$html |
coding_exception |
tool_mfa\output\renderer::available_factors | ( | ) |
Returns a list of factors which a user can add.
string |
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.
object_factor | $factor | the factor class |
string | the HTML for the table |
tool_mfa\output\renderer::factors_in_use_table | ( | int | $lookback | ) |
Displays a table of all factors in use currently.
int | $lookback | the period to view. |
string | the HTML for the table |
tool_mfa\output\renderer::factors_locked_table | ( | ) |
Displays a table of all factors in use currently.
string | the HTML for the table |
tool_mfa\output\renderer::get_state_badge | ( | string | $state | ) |
Returns the state of the factor as a badge.
string | $state |
string |
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.
string |
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.
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 |
mixed | string|bool |
tool_mfa\output\renderer::not_enough_factors | ( | ) |
Generates notification text for display when user cannot login.
string\$notification |
tool_mfa\output\renderer::setup_factor | ( | object | $factor | ) |
Returns the html section for factor setup.
object | $factor | object of the factor class |
string |
tool_mfa\output\renderer::verification_form | ( | object_factor | $factor, |
login_form | $form ) |
Renders the verification form.
object_factor | $factor | The factor to render the form for. |
login_form | $form | The login form object. |
string |
coding_exception | |
dml_exception | |
moodle_exception |