tool_mfa\local\form\verification_field Class Reference

Inheritance diagram for tool_mfa\local\form\verification_field:

Public Member Functions
	__construct ($attributes=null, $auth=true, ?string $elementlabel=null)
	Verification field is a text entry box that features some useful extras.
	freeze ()
	Freeze the element so that only its value is returned and set persistantfreeze to false.
	get_force_ltr ()
	Get force LTR option.
	getFrozenHtml ()
	Returns the html to be used when the element is frozen.
	getHelpButton ()
	get html for help button
	MoodleQuickForm_text ($elementName=null, $elementLabel=null, $attributes=null)
	Old syntax of class constructor.
	secure_js ()
	Setup and return the script for autosubmission while inside the secure layout.
	set_force_ltr ($value)
	Force the field to flow left-to-right.
	setHiddenLabel ($hiddenLabel)
	Sets label to be hidden.
	toHtml ()
	Returns HTML for this form element.

Public Attributes
string	$_helpbutton =''
	html for help button, if empty then no help
bool	$_hiddenLabel =false
	if true label will be hidden

Protected Attributes
bool	$forceltr = false
	Whether to force the display of this element to flow LTR.

Constructor & Destructor Documentation

__construct()

tool_mfa\local\form\verification_field::__construct	(		$attributes = null,
			$auth = true,
		?string	$elementlabel = null )

Verification field is a text entry box that features some useful extras.

Contains JS to autosubmit the auth page when code is entered, as well as additional styling.

Parameters

array	$attributes
boolean	$auth	is this constructed in auth.php loginform_* definitions. Set to false to prevent autosubmission of form.
string | null	$elementlabel	Provide a different element label.

Member Function Documentation

freeze()

MoodleQuickForm_text::freeze ( )

inherited

Freeze the element so that only its value is returned and set persistantfreeze to false.

Since

Moodle 2.4

Return values

void

get_force_ltr()

MoodleQuickForm_text::get_force_ltr ( )

inherited

Get force LTR option.

Return values

bool

getFrozenHtml()

MoodleQuickForm_text::getFrozenHtml ( )

inherited

Returns the html to be used when the element is frozen.

Since

Moodle 2.4

Return values

string

Frozen html

getHelpButton()

MoodleQuickForm_text::getHelpButton ( )

inherited

get html for help button

Return values

string

html for help button

MoodleQuickForm_text()

MoodleQuickForm_text::MoodleQuickForm_text ( $elementName = null, $elementLabel = null, $attributes = null )

inherited

Old syntax of class constructor.

Deprecated in PHP7.

Deprecated

since Moodle 3.1

secure_js()

tool_mfa\local\form\verification_field::secure_js

(

)

Setup and return the script for autosubmission while inside the secure layout.

Return values

string

the JS to inline attach to the rendered object.

set_force_ltr()

MoodleQuickForm_text::set_force_ltr ( $value )

inherited

Force the field to flow left-to-right.

This is useful for fields such as URLs, passwords, settings, etc...

Parameters

bool

$value

The value to set the option to.

setHiddenLabel()

MoodleQuickForm_text::setHiddenLabel ( $hiddenLabel )

inherited

Sets label to be hidden.

Parameters

bool

$hiddenLabel

sets if label should be hidden

toHtml()

tool_mfa\local\form\verification_field::toHtml

(

)

Returns HTML for this form element.

phpcs:disable moodle.NamingConventions.ValidFunctionName.LowercaseMethod

Return values

string

Reimplemented from MoodleQuickForm_text.

---

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

• admin/tool/mfa/classes/local/form/verification_field.php