HTMLTextField Class Reference

<input> field. More...

Inherits HTMLFormField.

Inherited by HTMLAutoCompleteSelectField, HTMLComboboxField, HTMLDateTimeField, HTMLFloatField, HTMLSelectOrOtherField, HTMLTagMultiselectField, HTMLTextFieldWithButton, HTMLTitleTextField, HTMLUserTextField, and UploadSourceField.

Collaboration diagram for HTMLTextField:

Public Member Functions
	__construct ( $params)
	getInputHTML ( $value)
	This function must be implemented to return the HTML to generate the input object itself.It should not implement the surrounding table cells/rows, or labels/help messages. Parameters mixed $value The value to set the input to; eg a default text for a text input. Returns string Valid HTML.
	getInputOOUI ( $value)
	Same as getInputHTML, but returns an OOUI object.Defaults to false, which getOOUI will interpret as "use the HTML version" Stability: stable to override Parameters string $value Returns OOUI\Widget|string|false
	getSize ()
	getSpellCheck ()
	isPersistent ()
Public Member Functions inherited from HTMLFormField
	cancelSubmit ( $value, $alldata)
	Override this function if the control can somehow trigger a form submission that shouldn't actually submit the HTMLForm.
	canDisplayErrors ()
	True if this field type is able to display errors; false if validation errors need to be displayed in the main HTMLForm error area.
	filter ( $value, $alldata)
	getAttributes (array $list)
	Returns the given attributes from the parameters.
	getDefault ()
	getDiv ( $value)
	Get the complete div for the input, including help text, labels, and whatever.
	getErrorsAndErrorClass ( $value)
	Determine form errors to display and their classes.
	getErrorsRaw ( $value)
	Determine form errors to display, returning them in an array.
	getHelpText ()
	Determine the help text to display.
	getHelpTextHtmlDiv ( $helptext)
	Generate help text HTML in div format.
	getHelpTextHtmlRaw ( $helptext)
	Generate help text HTML formatted for raw output.
	getHelpTextHtmlTable ( $helptext)
	Generate help text HTML in table format.
	getInline ( $value)
	Get the complete field as an inline element.
	getLabel ()
	getLabelHtml ( $cellAttributes=[])
	getName ()
	Get the field name that will be used for submission.
	getOOUI ( $value)
	Get the OOUI version of the div.
	getOptions ()
	Fetch the array of options from the field's parameters.
	getOptionsOOUI ()
	Get options and make them into arrays suitable for OOUI.
	getRaw ( $value)
	Get the complete raw fields for the input, including help text, labels, and whatever.
	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever.
	getTooltipAndAccessKey ()
	Returns the attributes required for the tooltip and accesskey, for Html::element() etc.
	getTooltipAndAccessKeyOOUI ()
	Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
	getVForm ( $value)
	Get the complete field for the input, including help text, labels, and whatever.
	hasVisibleOutput ()
	If this field has a user-visible output or not.
	isDisabled ( $alldata)
	Test whether this field is supposed to be disabled, based on the values of the other form fields.
	isHelpInline ()
	Determine if the help text should be displayed inline.
	isHidden ( $alldata)
	Test whether this field is supposed to be hidden, based on the values of the other form fields.
	loadDataFromRequest ( $request)
	Get the value that this input has been set to from a posted form, or the input's default value if it has not been set.
	msg ( $key,... $params)
	Get a translated interface message.
	needsJSForHtml5FormValidation ()
	Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly.
	setShowEmptyLabel ( $show)
	Tell the field whether to generate a separate label element if its label is blank.
	skipLoadData ( $request)
	Skip this field when collecting data.
	validate ( $value, $alldata)
	Override this function to add specific validation checks on the field input.

Protected Member Functions
	getDataAttribs ()
	Returns an array of data-* attributes to add to the field.
	getInputWidget ( $params)
	getType (&$attribs)
Protected Member Functions inherited from HTMLFormField
	checkStateRecurse (array $alldata, array $params)
	Helper function for isHidden and isDisabled to handle recursive data structures.
	getClassName ()
	Gets the non namespaced class name.
	getFieldLayoutOOUI ( $inputField, $config)
	Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output.
	getLabelAlignOOUI ()
	Get label alignment when generating field for OOUI.
	getMessage ( $value)
	Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message.
	getNearestField ( $name, $backCompat=false)
	Get the closest field matching a given name.
	getNearestFieldByName ( $alldata, $name, $asDisplay=false)
	Fetch a field value from $alldata for the closest field matching a given name.
	getNearestFieldValue ( $alldata, $name, $asDisplay=false, $backCompat=false)
	Fetch a field value from $alldata for the closest field matching a given name.
	getOOUIModules ()
	Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.
	isSubmitAttempt (WebRequest $request)
	Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just view it? This can't normally be distinguished for e.g.
	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to?
	parseCondState ( $params)
	Parse the cond-state array to use the field name for submission, since the key in the form descriptor is never known in HTML.
	parseCondStateForClient ()
	Parse the cond-state array for client-side.
	shouldInfuseOOUI ()
	Whether the field should be automatically infused.
	validateCondState ( $params)
	Validate the cond-state params, the existence check of fields should be done later.

Protected Attributes
bool	$autocomplete
	HTML autocomplete attribute.
	$mPlaceholder = ''
Protected Attributes inherited from HTMLFormField
	$mClass = ''
array	$mCondState = []
	Array to hold params for 'hide-if' or 'disable-if' statements.
	$mCondStateClass = []
	$mDefault
	$mDir
	$mFilterCallback
	$mHelpClass = false
	$mID
	$mLabel
	$mName
array null false	$mOptions = false
	$mOptionsLabelsNotFromMessage = false
bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label.
	$mVFormClass = ''

Additional Inherited Members
Static Public Member Functions inherited from HTMLFormField
static	flattenOptions ( $options)
	flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>".
static	forceToStringRecursive ( $array)
	Recursively forces values in an array to strings, because issues arise with integer 0 as a value.
Public Attributes inherited from HTMLFormField
array array[]	$mParams
HTMLForm null	$mParent
Static Protected Member Functions inherited from HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Detailed Description

<input> field.

Besides the parameters recognized by HTMLFormField, the following are recognized: autocomplete - HTML autocomplete value (a boolean for on/off or a string according to https://html.spec.whatwg.org/multipage/forms.html#autofill )

Stability: stable

to extend

Definition at line 16 of file HTMLTextField.php.

Constructor & Destructor Documentation

__construct()

HTMLTextField::__construct

(

$params

)

Stability: stable

to call

Parameters

array

$params

type: HTML textfield type size: field size in characters (defaults to 45) placeholder/placeholder-message: set HTML placeholder attribute spellcheck: set HTML spellcheck attribute persistent: upon unsuccessful requests, retain the value (defaults to true, except for password fields)

Reimplemented from HTMLFormField.

Reimplemented in HTMLTextFieldWithButton, HTMLAutoCompleteSelectField, HTMLDateTimeField, HTMLSelectOrOtherField, HTMLTimezoneField, HTMLTitlesMultiselectField, HTMLTitleTextField, and HTMLUserTextField.

Definition at line 33 of file HTMLTextField.php.

References HTMLFormField\getMessage().

Member Function Documentation

getDataAttribs()

HTMLTextField::getDataAttribs ( )

protected

Returns an array of data-* attributes to add to the field.

Stability: stable

to override

Returns

array

Reimplemented in HTMLTitleTextField.

Definition at line 245 of file HTMLTextField.php.

Referenced by getInputHTML().

getInputHTML()

HTMLTextField::getInputHTML

(

$value

)

This function must be implemented to return the HTML to generate the input object itself.It should not implement the surrounding table cells/rows, or labels/help messages.

Parameters

mixed

$value

The value to set the input to; eg a default text for a text input.

Returns

string Valid HTML.

Stability: stable

to override

Reimplemented from HTMLFormField.

Reimplemented in HTMLAutoCompleteSelectField, HTMLComboboxField, HTMLSelectOrOtherField, HTMLSizeFilterField, HTMLTagMultiselectField, HTMLTextFieldWithButton, HTMLTitlesMultiselectField, and HTMLUsersMultiselectField.

Definition at line 76 of file HTMLTextField.php.

References HTMLFormField\$mClass, HTMLFormField\$mDir, HTMLFormField\$mID, HTMLFormField\$mName, $mPlaceholder, HTMLFormField\getAttributes(), getDataAttribs(), getSize(), getSpellCheck(), HTMLFormField\getTooltipAndAccessKey(), getType(), and isPersistent().

getInputOOUI()

HTMLTextField::getInputOOUI

(

$value

)

Same as getInputHTML, but returns an OOUI object.Defaults to false, which getOOUI will interpret as "use the HTML version"

Stability: stable

to override

Parameters

string

$value

Returns

OOUI\Widget|string|false

Stability: stable

to override

Reimplemented from HTMLFormField.

Reimplemented in HTMLAutoCompleteSelectField, HTMLComboboxField, HTMLDateTimeField, HTMLSelectOrOtherField, HTMLTagMultiselectField, HTMLTitlesMultiselectField, and HTMLUsersMultiselectField.

Definition at line 174 of file HTMLTextField.php.

References HTMLFormField\$mClass, $mPlaceholder, HTMLFormField\getAttributes(), getInputWidget(), HTMLFormField\getTooltipAndAccessKeyOOUI(), getType(), and isPersistent().

getInputWidget()

HTMLTextField::getInputWidget ( $params )

protected

Stability: stable

to override

Parameters

array

$params

Returns

Widget

Reimplemented in HTMLFloatField, HTMLSelectOrOtherField, HTMLSizeFilterField, HTMLTagMultiselectField, HTMLTitlesMultiselectField, HTMLTitleTextField, HTMLUsersMultiselectField, and HTMLUserTextField.

Definition at line 235 of file HTMLTextField.php.

Referenced by getInputOOUI().

getSize()

HTMLTextField::getSize

(

)

Stability: stable

to override

Returns

int

Reimplemented in HTMLFloatField, HTMLSizeFilterField, and UploadSourceField.

Definition at line 51 of file HTMLTextField.php.

Referenced by HTMLSelectOrOtherField\getInputHTML(), getInputHTML(), and HTMLSelectOrOtherField\getInputOOUI().

getSpellCheck()

HTMLTextField::getSpellCheck

(

)

Definition at line 55 of file HTMLTextField.php.

Referenced by getInputHTML().

getType()

HTMLTextField::getType ( & $attribs )

protected

Definition at line 138 of file HTMLTextField.php.

Referenced by getInputHTML(), and getInputOOUI().

isPersistent()

HTMLTextField::isPersistent

(

)

Definition at line 64 of file HTMLTextField.php.

Referenced by getInputHTML(), and getInputOOUI().

Member Data Documentation

$autocomplete

bool HTMLTextField::$autocomplete

protected

HTML autocomplete attribute.

Definition at line 20 of file HTMLTextField.php.

$mPlaceholder

HTMLTextField::$mPlaceholder = ''

protected

Definition at line 17 of file HTMLTextField.php.

Referenced by getInputHTML(), HTMLComboboxField\getInputOOUI(), HTMLSelectOrOtherField\getInputOOUI(), and getInputOOUI().

---

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

• includes/htmlform/fields/HTMLTextField.php