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

Public Member Functions

 __construct ( $params)
 Initialise the object. More...
 
 getDiv ( $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...
 
- Public Member Functions inherited from HTMLFormField
 filter ( $value, $alldata)
 
 getAttributes (array $list)
 Returns the given attributes from the parameters. More...
 
 getDefault ()
 
 getErrorsAndErrorClass ( $value)
 Determine form errors to display and their classes. More...
 
 getHelpText ()
 Determine the help text to display. 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...
 
 getLabel ()
 
 getLabelHtml ( $cellAttributes=array())
 
 getOptions ()
 Fetch the array of options from the field's parameters. More...
 
 getTooltipAndAccessKey ()
 Returns the attributes required for the tooltip and accesskey. 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 ()
 Get a translated interface message. More...
 
 setShowEmptyLabel ( $show)
 Tell the field whether to generate a separate label element if its label is blank. More...
 
 validate ( $value, $alldata)
 Override this function to add specific validation checks on the field input. More...
 

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
 $mParams
 
HTMLForm $mParent
 
- Protected Member Functions inherited from HTMLFormField
 needsLabel ()
 Should this field have a label, or is there no input element with the appropriate id for the label to point to? More...
 
- Static Protected Member Functions inherited from HTMLFormField
static formatErrors ( $errors)
 Formats one or more errors as accepted by field validation-callback. More...
 
- Protected Attributes inherited from HTMLFormField
 $mClass = ''
 
 $mDefault
 
 $mFilterCallback
 
 $mID
 
 $mLabel
 
 $mName
 
 $mOptions = false
 
 $mOptionsLabelsNotFromMessage = false
 
bool $mShowEmptyLabels = true
 If true will generate an empty div element with no label. More...
 
 $mValidationCallback
 

Detailed Description

Definition at line 3 of file HTMLHiddenField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLHiddenField::__construct (   $params)

Initialise the object.

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 4 of file HTMLHiddenField.php.

References $params.

Member Function Documentation

◆ getDiv()

HTMLHiddenField::getDiv (   $value)
Since
1.20

Reimplemented from HTMLFormField.

Definition at line 26 of file HTMLHiddenField.php.

References $value, and 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
string$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 37 of file HTMLHiddenField.php.

◆ getRaw()

HTMLHiddenField::getRaw (   $value)
Since
1.20

Reimplemented from HTMLFormField.

Definition at line 33 of file HTMLHiddenField.php.

References $value, and getTableRow().

◆ getTableRow()

HTMLHiddenField::getTableRow (   $value)

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

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

Reimplemented from HTMLFormField.

Definition at line 12 of file HTMLHiddenField.php.

References HTMLFormField\$mID, $params, and array().

Referenced by getDiv(), and getRaw().


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