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

Inherits MediaWiki\HTMLForm\HTMLFormField.

Collaboration diagram for MediaWiki\HTMLForm\Field\HTMLInfoField:

[legend]

Public Member Functions

__construct ( $info)

getCodex ( $value)

Get the Codex version of the div.

getDefault ()

Stability: stable: to override

Returns: mixed

getDiv ( $value)

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

getOOUI ( $value)

getRaw ( $value)

getTableRow ( $value)

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

Stability: stable: to override

Parameters

string $value The value to set the input to.

Returns: string Complete HTML table row.

Public Member Functions inherited from MediaWiki\HTMLForm\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.

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, $cssClasses=[])

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.

getInputCodex ( $value, $hasErrors)

Same as getInputHTML, but for Codex.

getLabel ()

getLabelHtml ( $cellAttributes=[])

getName ()

Get the field name that will be used for submission.

getOptions ()

Fetch the array of options from the field's parameters.

getOptionsOOUI ()

Get options and make them into arrays suitable for OOUI.

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
	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to? Stability: stable to override Returns bool True to output a label, false to suppress

Protected Member Functions inherited from MediaWiki\HTMLForm\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.

	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.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\HTMLForm\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 MediaWiki\HTMLForm\HTMLFormField
array array[]	$mParams

HTMLForm null	$mParent

Static Protected Member Functions inherited from MediaWiki\HTMLForm\HTMLFormField
static	formatErrors ( $errors)
	Formats one or more errors as accepted by field validation-callback.

Protected Attributes inherited from MediaWiki\HTMLForm\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 = ''

Detailed Description

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

Stability: stable: to extend

Definition at line 12 of file HTMLInfoField.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HTMLForm\Field\HTMLInfoField::__construct ( $info )

Stability: stable: to call

Parameters

array

$info

In addition 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 MediaWiki\HTMLForm\HTMLFormField.

Definition at line 24 of file HTMLInfoField.php.

Member Function Documentation

◆ getCodex()

MediaWiki\HTMLForm\Field\HTMLInfoField::getCodex ( $value )

Get the Codex version of the div.

Since: 1.42

Parameters

string $value The value to set the input to.

Returns: string HTML

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 124 of file HTMLInfoField.php.

◆ getDefault()

MediaWiki\HTMLForm\Field\HTMLInfoField::getDefault ( )

Stability: stable: to override

Returns: mixed

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 34 of file HTMLInfoField.php.

◆ getDiv()

MediaWiki\HTMLForm\Field\HTMLInfoField::getDiv ( $value )

Stability: stable: to override

Parameters

string $value

Returns: string

Since: 1.20

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 83 of file HTMLInfoField.php.

◆ getInputHTML()

MediaWiki\HTMLForm\Field\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 $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 MediaWiki\HTMLForm\HTMLFormField.

Definition at line 46 of file HTMLInfoField.php.

◆ getInputOOUI()

MediaWiki\HTMLForm\Field\HTMLInfoField::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 MediaWiki\HTMLForm\HTMLFormField.

Definition at line 54 of file HTMLInfoField.php.

◆ getOOUI()

MediaWiki\HTMLForm\Field\HTMLInfoField::getOOUI ( $value )

Stability: stable: to override

Parameters

mixed $value If not FieldLayout or subclass has been deprecated.

Returns: \OOUI\FieldLayout

Since: 1.32

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 111 of file HTMLInfoField.php.

References wfDeprecatedMsg().

◆ getRaw()

MediaWiki\HTMLForm\Field\HTMLInfoField::getRaw ( $value )

Stability: stable: to override

Parameters

string $value

Returns: string

Since: 1.20

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 97 of file HTMLInfoField.php.

◆ getTableRow()

MediaWiki\HTMLForm\Field\HTMLInfoField::getTableRow ( $value )

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

Stability: stable: to override

Parameters

string $value The value to set the input to.

Returns: string Complete HTML table row.

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 69 of file HTMLInfoField.php.

◆ needsLabel()

MediaWiki\HTMLForm\Field\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?

Stability: stable: to override

Returns: bool True to output a label, false to suppress

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 136 of file HTMLInfoField.php.

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

includes/htmlform/fields/HTMLInfoField.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCodex()

◆ getDefault()

◆ getDiv()

◆ getInputHTML()

◆ getInputOOUI()

◆ getOOUI()

◆ getRaw()

◆ getTableRow()

◆ needsLabel()