MediaWiki  master
HTMLInfoField Class Reference

An information field (text blob), not a proper input. More...

Inheritance diagram for HTMLInfoField:
Collaboration diagram for HTMLInfoField:

Public Member Functions

 __construct ( $info)
 Stable to call. More...
 
 getDefault ()
 Stable to override.
Returns
mixed
Stable to override More...
 
 getDiv ( $value)
 Stable to override. More...
 
 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.
Stable to override More...
 
 getInputOOUI ( $value)
 Same as getInputHTML, but returns an OOUI object.Defaults to false, which getOOUI will interpret as "use the HTML version" Stable to override
Parameters
string$value
Returns
OOUI\Widget|false
Stable to override More...
 
 getOOUI ( $value)
 Stable to override. More...
 
 getRaw ( $value)
 Stable to override. More...
 
 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.
Stable to override 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...
 
 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...
 
 filter ( $value, $alldata)
 Stable to override. More...
 
 getAttributes (array $list)
 Returns the given attributes from the parameters 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...
 
 getLabel ()
 Stable to override. More...
 
 getLabelHtml ( $cellAttributes=[])
 Stable to override. 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...
 
 hasVisibleOutput ()
 If this field has a user-visible output or not. 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 Member Functions

 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.
Returns
bool True to output a label, false to suppress
Stable to override More...
 
- 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...
 
 shouldInfuseOOUI ()
 Whether the field should be automatically infused. 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
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. More...
 
- 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 = ''
 

Detailed Description

An information field (text blob), not a proper input.

Stable to extend

Definition at line 7 of file HTMLInfoField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLInfoField::__construct (   $info)

Stable to call.

Parameters
array$infoIn adition to the usual HTMLFormField parameters, this can take the following fields:
  • default: the value (text) of the field. Unlike other form field types, HTMLInfoField can take a closure as a default value, which will be evaluated with $info as its only parameter.
  • raw: if true, the value won't be escaped.
  • rawrow: if true, the usual wrapping of form fields (e.g. into a table row + cell when display mode is table) will not happen and the value must contain it already.

Reimplemented from HTMLFormField.

Definition at line 19 of file HTMLInfoField.php.

Member Function Documentation

◆ getDefault()

HTMLInfoField::getDefault ( )

Stable to override.

Returns
mixed
Stable to override

Reimplemented from HTMLFormField.

Definition at line 29 of file HTMLInfoField.php.

◆ getDiv()

HTMLInfoField::getDiv (   $value)

Stable to override.

Parameters
string$value
Returns
string
Since
1.20

Reimplemented from HTMLFormField.

Definition at line 77 of file HTMLInfoField.php.

◆ getInputHTML()

HTMLInfoField::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.
Stable to override

Reimplemented from HTMLFormField.

Definition at line 41 of file HTMLInfoField.php.

◆ getInputOOUI()

HTMLInfoField::getInputOOUI (   $value)

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

Parameters
string$value
Returns
OOUI\Widget|false
Stable to override

Reimplemented from HTMLFormField.

Definition at line 49 of file HTMLInfoField.php.

◆ getOOUI()

HTMLInfoField::getOOUI (   $value)

Stable to override.

Parameters
mixed$valueIf not FieldLayout or subclass has been deprecated.
Returns
OOUI\FieldLayout
Since
1.32

Reimplemented from HTMLFormField.

Definition at line 105 of file HTMLInfoField.php.

References wfDeprecatedMsg().

◆ getRaw()

HTMLInfoField::getRaw (   $value)

Stable to override.

Parameters
string$value
Returns
string
Since
1.20

Reimplemented from HTMLFormField.

Definition at line 91 of file HTMLInfoField.php.

◆ getTableRow()

HTMLInfoField::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.
Stable to override

Reimplemented from HTMLFormField.

Definition at line 63 of file HTMLInfoField.php.

◆ needsLabel()

HTMLInfoField::needsLabel ( )
protected

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.

Returns
bool True to output a label, false to suppress
Stable to override

Reimplemented from HTMLFormField.

Definition at line 122 of file HTMLInfoField.php.


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