Double field with a dropdown list constructed from a system message in the format. More...

Inheritance diagram for HTMLSelectAndOtherField:

[legend]

Collaboration diagram for HTMLSelectAndOtherField:

[legend]

Public Member Functions

__construct ( $params)

Initialise the object.

getDefault ()

Stable to override.

Returns: mixed

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.

Stable to override Stable to override

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 Stable to override

getInputWidget ( $params)

Stable to override

getSize ()

loadDataFromRequest ( $request)

validate ( $value, $alldata)

Override this function to add specific validation checks on the field input.Don't forget to call parent::validate() to ensure that the user-defined callback mValidationCallback is still run Stable to override

Parameters

string \| array	$value	The value the field was submitted with
array	$alldata	The data collected from the form

Returns: bool|string|Message True on success, or String/Message error to display, or false to fail validation without displaying an error.

Stable to override Stable to override

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)

Stable to override.

getAttributes (array $list)

Returns the given attributes from the parameters Stable to override.

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

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 ()

Stable to override.

getLabelHtml ( $cellAttributes=[])

Stable to override.

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.

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.

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.

Protected Member Functions
	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.

Protected Member Functions inherited from HTMLSelectField
	shouldInfuseOOUI ()
	Whether the field should be automatically infused.Note that all OOUI HTMLForm fields are infusable (you can call OO.ui.infuse() on them), but not all are infused by default, since there is no benefit in doing it e.g. for buttons and it's a small performance hit on page load. Stable to override Returns bool Stable to override

Protected Member Functions inherited from HTMLFormField
	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.

	getNearestFieldByName ( $alldata, $name)
	Fetch a field value from $alldata for the closest field matching a given name.

	isHiddenRecurse (array $alldata, array $params)
	Helper function for isHidden to handle recursive data structures.

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

Private Attributes
string[]	$mFlatOptions

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.

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.

	$mValidationCallback

	$mVFormClass = ''

Detailed Description

Double field with a dropdown list constructed from a system message in the format.

Optgroup header ** <option value>
New Optgroup header Plus a text field underneath for an additional reason. The 'value' of the field is "<select>: <extra reason>", or "<extra reason>" if nothing has been selected in the select dropdown.

Stable to extend

Todo:: FIXME: If made 'required', only the text field should be compulsory.

Definition at line 15 of file HTMLSelectAndOtherField.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLSelectAndOtherField::__construct ( $params )

Initialise the object.

Stable to call

Parameters

array $params Associative 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 22 of file HTMLSelectAndOtherField.php.

References HTMLFormField\$mOptions, HTMLFormField\flattenOptions(), HTMLFormField\getMessage(), HTMLFormField\getOptions(), and HTMLFormField\msg().

Member Function Documentation

◆ getDefault()

HTMLSelectAndOtherField::getDefault ( )

Stable to override.

Returns: mixed

Reimplemented from HTMLFormField.

Definition at line 160 of file HTMLSelectAndOtherField.php.

References HTMLFormField\msg().

Referenced by loadDataFromRequest().

◆ getInputHTML()

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

Stable to override Stable to override

Reimplemented from HTMLSelectField.

Definition at line 44 of file HTMLSelectAndOtherField.php.

References HTMLFormField\$mClass, HTMLFormField\$mID, HTMLFormField\getAttributes(), and getSize().

◆ getInputOOUI()

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

Reimplemented from HTMLSelectField.

Definition at line 83 of file HTMLSelectAndOtherField.php.

References HTMLFormField\$mClass, HTMLFormField\$mName, HTMLFormField\getAttributes(), getInputWidget(), and HTMLFormField\getOptionsOOUI().

◆ getInputWidget()

HTMLSelectAndOtherField::getInputWidget ( $params )

Stable to override

Definition at line 153 of file HTMLSelectAndOtherField.php.

Referenced by getInputOOUI().

◆ getOOUIModules()

HTMLSelectAndOtherField::getOOUIModules ( )

protected

Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to infuse this field's OOUI widget.

Stable to override

Returns: string[]

Reimplemented from HTMLFormField.

Definition at line 79 of file HTMLSelectAndOtherField.php.

◆ getSize()

HTMLSelectAndOtherField::getSize ( )

Definition at line 213 of file HTMLSelectAndOtherField.php.

Referenced by getInputHTML().

◆ loadDataFromRequest()

HTMLSelectAndOtherField::loadDataFromRequest ( $request )

Parameters

WebRequest $request

Returns: array ["<overall message>","<select value>","<text field value>"]

Reimplemented from HTMLFormField.

Definition at line 191 of file HTMLSelectAndOtherField.php.

References getDefault(), and HTMLFormField\msg().

◆ validate()

HTMLSelectAndOtherField::validate	(	$value,
		$alldata
	)

Override this function to add specific validation checks on the field input.Don't forget to call parent::validate() to ensure that the user-defined callback mValidationCallback is still run Stable to override

Parameters

string \| array	$value	The value the field was submitted with
array	$alldata	The data collected from the form

Returns: bool|string|Message True on success, or String/Message error to display, or false to fail validation without displaying an error.

Stable to override Stable to override

Reimplemented from HTMLSelectField.

Definition at line 217 of file HTMLSelectAndOtherField.php.

References HTMLFormField\msg().

Member Data Documentation

◆ $mFlatOptions

string [] HTMLSelectAndOtherField::$mFlatOptions

private

Definition at line 17 of file HTMLSelectAndOtherField.php.

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

includes/htmlform/fields/HTMLSelectAndOtherField.php

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefault()

◆ getInputHTML()

◆ getInputOOUI()

◆ getInputWidget()

◆ getOOUIModules()

◆ getSize()

◆ loadDataFromRequest()

◆ validate()

Member Data Documentation

◆ $mFlatOptions