tool_mfa\local\form\login_form Class Reference

Inheritance diagram for tool_mfa\local\form\login_form:

Public Member Functions
	__construct ($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true, $ajaxformdata=null)
	Create an instance of this class.
	_process_submission ($method)
	Internal method.
	_validate_files (&$files)
	Internal method.
	add_action_buttons ($cancel=true, $submitlabel=null)
	Use this method to a cancel and submit button to the end of your form.
	add_checkbox_controller ($groupid, $text=null, $attributes=null, $originalValue=0)
	Adds a link/button that controls the checked state of a group of checkboxes.
	add_sticky_action_buttons (bool $cancel=true, ?string $submitlabel=null)
	Use this method to make a sticky submit/cancel button at the end of your form.
	definition ()
	Form definition.Abstract method - always override!
	definition_after_data ()
	Invokes factor login_form_definition_after_data() method after form data has been set.
	display ()
	Print html form.
	element_exists (string $elementname)
	Returns true if the form element exists.
	filter_shown_headers (array $shownonly)
	Use this method to indicate that the fieldsets should be shown as expanded and all other fieldsets should be hidden.
	focus ($name=NULL)
	To autofocus on first form element or first element with error.
	freeze (string $elementname)
	Freeze a form element.
	get_data ()
	Return submitted data if properly submitted or returns NULL if validation fails or if there is no submitted data.
	get_element_error (string $elementname)
	Returns error corresponding to validated element.
	get_file_content ($elname)
	Get content of uploaded file.
	get_new_filename ($elname=null)
	Returns name of uploaded file.
	get_submitted_data ()
	Return submitted data without validation or NULL if there is no submitted data.
	init_javascript_enhancement ($element, $enhancement, array $options=array(), array $strings=null)
	Adds an initialisation call for a standard JavaScript enhancement.
	is_cancelled ()
	Return true if a cancel button has been pressed resulting in the form being submitted.
	is_submitted ()
	Check that form was submitted.
	is_validated ()
	Check that form data is valid.
	moodleform ($action=null, $customdata=null, $method='post', $target='', $attributes=null, $editable=true)
	Old syntax of class constructor.
	no_submit_button_pressed ()
	Checks if button pressed is not for submitting the form.
	optional_param ($name, $default, $type)
	Checks if a parameter was passed in the previous form submission.
	render ()
	Renders the html form (same as display, but returns the result).
	repeat_elements ($elementobjs, $repeats, $options, $repeathiddenname, $addfieldsname, $addfieldsno=5, $addstring=null, $addbuttoninside=false, $deletebuttonname='')
	Method to add a repeating group of elements to a form.
	repeat_elements_fix_clone ($i, $elementclone, &$namecloned)
	Helper used by repeat_elements().
	save_file ($elname, $pathname, $override=false)
	Save file to standard filesystem.
	save_files ($destination)
	Save verified uploaded files into directory.
	save_stored_file ($elname, $newcontextid, $newcomponent, $newfilearea, $newitemid, $newfilepath='/', $newfilename=null, $overwrite=false, $newuserid=null)
	Save file to local filesystem pool.
	save_temp_file ($elname)
	Returns a temporary file, do not forget to delete after not needed any more.
	set_data ($default_values)
	Load in existing data as form defaults.
	set_display_vertical ()
	Set display mode for the form when labels take full width of the form and above the elements even on big screens.
	set_element_error (string $elementname, string $error)
	Set an error message for a form element.
	set_initial_dirty_state ($state=false)
	Set the initial 'dirty' state of the form.
	validate_defined_fields ($validateonnosubmit=false)
	Validate the form.
	validation ($data, $files)
	Validates the login form with given factor validation method.

Static Public Member Functions
static	get_js_module ()
	Returns a JS module definition for the mforms JS.
static	mock_ajax_submit ($simulatedsubmitteddata, $simulatedsubmittedfiles=array(), $method='post', $formidentifier=null)
	Used by tests to simulate submitted form data submission via AJAX.
static	mock_generate_submit_keys ($data=[])
	Used by tests to generate valid submit keys for moodle forms that are submitted with ajax data.
static	mock_submit ($simulatedsubmitteddata, $simulatedsubmittedfiles=array(), $method='post', $formidentifier=null)
	Used by tests to simulate submitted form data submission from the user.

Public Attributes
tool_mfa local form global_form_manager	$globalmanager

Protected Member Functions
	_get_post_params ()
	Internal method - should not be used anywhere.
	after_definition ()
	After definition hook.
	get_array_value_by_keys (array $array, array $keys)
	Returns an element of multi-dimensional array given the list of keys.
	get_draft_files ($elname)
	Get draft files of a form element This is a protected method which will be used only inside moodleforms.
	get_form_identifier ()
	It should returns unique identifier for the form.
	validate_draft_files ()
	Internal method.

Protected Attributes
array	$_ajaxformdata
	submitted form data when using mforms with ajax
mixed	$_customdata
	globals workaround
object	$_definition_finalized = false
	definition_after_data executed flag
MoodleQuickForm	$_form
	quickform object definition
string	$_formname
	name of the form
bool null	$_validated = null
	stores the validation result of this form or null if not yet validated

Static Protected Attributes
static int	$uniqueid = 0
	Unique identifier to be used for action buttons.

Constructor & Destructor Documentation

__construct()

tool_mfa\local\form\login_form::__construct	(		$action = null,
			$customdata = null,
			$method = 'post',
			$target = '',
			$attributes = null,
			$editable = true,
			$ajaxformdata = null )

Create an instance of this class.

Parameters

mixed	$action	the action attribute for the form. If empty defaults to auto detect the current url. If a moodle_url object then outputs params as hidden variables.
mixed	$customdata	if your form defintion method needs access to data such as $course $cm, etc. to construct the form definition then pass it in this array. You can use globals for somethings.
string	$method	if you set this to anything other than 'post' then _GET and _POST will be merged and used as incoming data to the form.
string	$target	target frame for form submission. You will rarely use this. Don't use it if you don't need to as the target attribute is deprecated in xhtml strict.
mixed	$attributes	you can pass a string of html attributes here or an array. Special attribute 'data-random-ids' will randomise generated elements ids. This is necessary when there are several forms on the same page. Special attribute 'data-double-submit-protection' set to 'off' will turn off double-submit protection JavaScript - this may be necessary if your form sends downloadable files in response to a submit button, and can't call core_form\util\form_download_complete();
bool	$editable
array	$ajaxformdata	Forms submitted via ajax, must pass their data here, instead of relying on _GET and _POST.

Reimplemented from moodleform.

Member Function Documentation

definition()

tool_mfa\local\form\login_form::definition

(

)

Form definition.Abstract method - always override!

See also

moodleform\definition()

Reimplemented from moodleform.

definition_after_data()

tool_mfa\local\form\login_form::definition_after_data

(

)

Invokes factor login_form_definition_after_data() method after form data has been set.

Return values

void

Reimplemented from moodleform.

element_exists()

tool_mfa\local\form\login_form::element_exists

(

string

$elementname

)

Returns true if the form element exists.

Parameters

string

$elementname

Name of form element to check.

Return values

bool

freeze()

tool_mfa\local\form\login_form::freeze

(

string

$elementname

)

Freeze a form element.

Parameters

string

$elementname

Name of form element to freeze.

Return values

void

get_element_error()

tool_mfa\local\form\login_form::get_element_error

(

string

$elementname

)

Returns error corresponding to validated element.

Parameters

string

$elementname

Name of form element to check.

Return values

string|null

Error message corresponding to the validated element.

set_element_error()

tool_mfa\local\form\login_form::set_element_error	(	string	$elementname,
		string	$error )

Set an error message for a form element.

Parameters

string	$elementname	Name of form element to set error for.
string	$error	Error message, if empty then removes the current error message.

Return values

void

validation()

tool_mfa\local\form\login_form::validation	(		$data,
			$files )

Validates the login form with given factor validation method.

Parameters

array	$data
array	$files

Return values

array

Reimplemented from moodleform.

---

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

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