MediaWiki  master
HTMLHiddenField Class Reference
Inheritance diagram for HTMLHiddenField:
Collaboration diagram for HTMLHiddenField:

Public Member Functions

 __construct ( $params)
 Stable to call Initialise the object.Stable to call

Parameters
array$paramsAssociative Array. See HTMLForm doc for syntax.
Since
1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
Exceptions
MWException
. More...
 
 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. More...
 
 getDiv ( $value)
 
 getHiddenFieldData ( $value)
 
 getInputHTML ( $value)
 This function must be implemented to return the HTML to generate the input object itself. More...
 
 getRaw ( $value)
 
 getTableRow ( $value)
 Get the complete table row for the input, including help text, labels, and whatever. More...
 
 hasVisibleOutput ()
 If this field has a user-visible output or not. More...
 
- 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. More...
 
 filter ( $value, $alldata)
 Stable to override. More...
 
 getAttributes (array $list)
 Returns the given attributes from the parameters Stable to override. More...
 
 getDefault ()
 Stable to override. More...
 
 getErrorsAndErrorClass ( $value)
 Determine form errors to display and their classes. More...
 
 getErrorsRaw ( $value)
 Determine form errors to display, returning them in an array. More...
 
 getHelpText ()
 Determine the help text to display Stable to override. More...
 
 getHelpTextHtmlDiv ( $helptext)
 Generate help text HTML in div format. More...
 
 getHelpTextHtmlRaw ( $helptext)
 Generate help text HTML formatted for raw output. More...
 
 getHelpTextHtmlTable ( $helptext)
 Generate help text HTML in table format. More...
 
 getInline ( $value)
 Get the complete field as an inline element. More...
 
 getInputOOUI ( $value)
 Same as getInputHTML, but returns an OOUI object. More...
 
 getLabel ()
 Stable to override. More...
 
 getLabelHtml ( $cellAttributes=[])
 Stable to override. More...
 
 getOOUI ( $value)
 Get the OOUI version of the div. More...
 
 getOptions ()
 Fetch the array of options from the field's parameters. More...
 
 getOptionsOOUI ()
 Get options and make them into arrays suitable for OOUI. More...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey, for Html::element() etc. More...
 
 getTooltipAndAccessKeyOOUI ()
 Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config. More...
 
 getVForm ( $value)
 Get the complete field for the input, including help text, labels, and whatever. More...
 
 isHelpInline ()
 Determine if the help text should be displayed inline. More...
 
 isHidden ( $alldata)
 Test whether this field is supposed to be hidden, based on the values of the other form fields. More...
 
 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. More...
 
 msg ( $key,... $params)
 Get a translated interface message. More...
 
 needsJSForHtml5FormValidation ()
 Whether this field requires the user agent to have JavaScript enabled for the client-side HTML5 form validation to work correctly. More...
 
 setShowEmptyLabel ( $show)
 Tell the field whether to generate a separate label element if its label is blank. More...
 
 skipLoadData ( $request)
 Skip this field when collecting data. More...
 
 validate ( $value, $alldata)
 Override this function to add specific validation checks on the field input. More...
 

Protected Attributes

 $outputAsDefault = true
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
 $mDefault
 
 $mDir
 
 $mFilterCallback
 
 $mHelpClass = false
 
 $mHideIf = null
 
 $mID
 
 $mLabel
 
 $mName
 
array bool null $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 
 $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>". More...
 
static forceToStringRecursive ( $array)
 Recursively forces values in an array to strings, because issues arise with integer 0 as a value. More...
 
- Public Attributes inherited from HTMLFormField
array array[] $mParams
 
HTMLForm null $mParent
 
- Protected Member Functions inherited from HTMLFormField
 getFieldLayoutOOUI ( $inputField, $config)
 Get a FieldLayout (or subclass thereof) to wrap this field in when using OOUI output. More...
 
 getLabelAlignOOUI ()
 Get label alignment when generating field for OOUI. More...
 
 getMessage ( $value)
 Turns a *-message parameter (which could be a MessageSpecifier, or a message name, or a name + parameters array) into a Message. More...
 
 getNearestFieldByName ( $alldata, $name)
 Fetch a field value from $alldata for the closest field matching a given name. More...
 
 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. More...
 
 isHiddenRecurse (array $alldata, array $params)
 Helper function for isHidden to handle recursive data structures. More...
 
 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. More...
 
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? Stable to override. More...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. More...
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 

Detailed Description

Definition at line 6 of file HTMLHiddenField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLHiddenField::__construct (   $params)

Stable to call Initialise the object.Stable to call

Parameters
array$paramsAssociative Array. See HTMLForm doc for syntax.
Since
1.22 The 'label' attribute no longer accepts raw HTML, use 'label-raw' instead
Exceptions
MWException
.

Reimplemented from HTMLFormField.

Definition at line 13 of file HTMLHiddenField.php.

Member Function Documentation

◆ canDisplayErrors()

HTMLHiddenField::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.

Stable to override

Returns
bool

Reimplemented from HTMLFormField.

Definition at line 66 of file HTMLHiddenField.php.

◆ getDiv()

HTMLHiddenField::getDiv (   $value)
Parameters
string$value
Returns
string
Since
1.20

Reimplemented from HTMLFormField.

Definition at line 49 of file HTMLHiddenField.php.

References getTableRow().

◆ getHiddenFieldData()

HTMLHiddenField::getHiddenFieldData (   $value)

Definition at line 25 of file HTMLHiddenField.php.

References HTMLFormField\$mDefault, HTMLFormField\$mID, and HTMLFormField\$mName.

Referenced by getTableRow().

◆ getInputHTML()

HTMLHiddenField::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$valueThe value to set the input to; eg a default text for a text input.
Returns
string Valid HTML.

Reimplemented from HTMLFormField.

Definition at line 62 of file HTMLHiddenField.php.

◆ getRaw()

HTMLHiddenField::getRaw (   $value)
Parameters
string$value
Returns
string
Since
1.20

Reimplemented from HTMLFormField.

Definition at line 58 of file HTMLHiddenField.php.

References getTableRow().

◆ getTableRow()

HTMLHiddenField::getTableRow (   $value)

Get the complete table row for the input, including help text, labels, and whatever.

Stable to override

Parameters
string$valueThe value to set the input to.
Returns
string Complete HTML table row.

Reimplemented from HTMLFormField.

Definition at line 38 of file HTMLHiddenField.php.

References getHiddenFieldData().

Referenced by getDiv(), and getRaw().

◆ hasVisibleOutput()

HTMLHiddenField::hasVisibleOutput ( )

If this field has a user-visible output or not.

If not, it will not be rendered Stable to override

Returns
bool

Reimplemented from HTMLFormField.

Definition at line 70 of file HTMLHiddenField.php.

Member Data Documentation

◆ $outputAsDefault

HTMLHiddenField::$outputAsDefault = true
protected

Definition at line 7 of file HTMLHiddenField.php.


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