Implements a tag multiselect input field for titles. More...

Inherits MediaWiki\HTMLForm\Field\HTMLTitleTextField.

Collaboration diagram for MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField:

[legend]

Public Member Functions

__construct ( $params)

getInputCodex ( $value, $hasErrors)

Same as getInputHTML, but for Codex.

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

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

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.

validate ( $value, $alldata)

Override this function to add specific validation checks on the field input.

Public Member Functions inherited from MediaWiki\HTMLForm\Field\HTMLTitleTextField

getInputHtml ( $value)

Public Member Functions inherited from MediaWiki\HTMLForm\Field\HTMLTextField

getSize ()

getSpellCheck ()

isPersistent ()

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.

getCodex ( $value)

Get the Codex version of the div.

getDefault ()

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.

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.

getLabel ()

getLabelHtml ( $cellAttributes=[])

getName ()

Get the field name that will be used for submission.

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.

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.

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

getInputWidget ( $params)

Stability: stable: to override

Parameters

array $params

Returns: Widget

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.

shouldInfuseOOUI ()

Whether the field should be automatically infused.

Protected Member Functions inherited from MediaWiki\HTMLForm\Field\HTMLTitleTextField

getDataAttribs ()

Returns an array of data-* attributes to add to the field.

Protected Member Functions inherited from MediaWiki\HTMLForm\Field\HTMLTextField

getType (&$attribs)

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.

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?

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.

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\Field\HTMLTextField
static	buildCodexComponent ( $value, $hasErrors, $type, $name, $inputAttribs)
	Build the markup of the Codex component.

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\Field\HTMLTextField
bool	$autocomplete
	HTML autocomplete attribute.

	$mPlaceholder = ''

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

Implements a tag multiselect input field for titles.

Besides the parameters recognized by HTMLTitleTextField, additional recognized parameters are: default - (optional) Array of titles to use as preset data placeholder - (optional) Custom placeholder message for input

The result is the array of titles

This widget is a duplication of HTMLUsersMultiselectField, except for:

The configuration variable changed to 'titles' (from 'users')
OOUI modules were adjusted for the TitlesMultiselectWidget
The PHP version instantiates a MediaWiki\Widget\TitlesMultiselectWidget

Stability: stable: to extend

Note: This widget is not likely to remain functional in non-OOUI forms.

Definition at line 25 of file HTMLTitlesMultiselectField.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField::__construct ( $params )

Stability: stable: to call

Reimplemented from MediaWiki\HTMLForm\Field\HTMLTitleTextField.

Definition at line 30 of file HTMLTitlesMultiselectField.php.

References $params.

Member Function Documentation

◆ getInputCodex()

MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField::getInputCodex	(		$value,
			$hasErrors )

Same as getInputHTML, but for Codex.

This is called by CodexHTMLForm.

If not overridden, falls back to getInputHTML.

Parameters

string	$value	The value to set the input to
bool	$hasErrors	Whether there are validation errors. If set to true, this method should apply a CSS class for the error status (e.g. cdx-text-input–status-error) if the component used supports that.

Returns: string HTML

Reimplemented from MediaWiki\HTMLForm\Field\HTMLTextField.

Definition at line 149 of file HTMLTitlesMultiselectField.php.

◆ getInputHTML()

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

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\Field\HTMLTextField.

Definition at line 77 of file HTMLTitlesMultiselectField.php.

References MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getInputOOUI().

◆ getInputOOUI()

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

Stability: stable: to override

Reimplemented from MediaWiki\HTMLForm\Field\HTMLTextField.

Definition at line 82 of file HTMLTitlesMultiselectField.php.

References MediaWiki\HTMLForm\HTMLFormField\$mDir, MediaWiki\HTMLForm\HTMLFormField\$mID, MediaWiki\HTMLForm\HTMLFormField\$mName, $params, MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getInputWidget(), and MediaWiki\HTMLForm\HTMLFormField\msg().

Referenced by MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getInputHTML().

◆ getInputWidget()

MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField::getInputWidget ( $params )

protected

Stability: stable: to override

Parameters

array $params

Returns: Widget

Reimplemented from MediaWiki\HTMLForm\Field\HTMLTitleTextField.

Definition at line 135 of file HTMLTitlesMultiselectField.php.

References $params, and MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getOOUIModules().

Referenced by MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getInputOOUI().

◆ getOOUIModules()

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

Stability: stable: to override

Returns: string[]

Reimplemented from MediaWiki\HTMLForm\Field\HTMLTitleTextField.

Definition at line 145 of file HTMLTitlesMultiselectField.php.

Referenced by MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField\getInputWidget().

◆ loadDataFromRequest()

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

Stability: stable: to override

Parameters

WebRequest $request

Returns: mixed The value

Reimplemented from MediaWiki\HTMLForm\HTMLFormField.

Definition at line 39 of file HTMLTitlesMultiselectField.php.

References MediaWiki\HTMLForm\HTMLFormField\getDefault().

◆ shouldInfuseOOUI()

MediaWiki\HTMLForm\Field\HTMLTitlesMultiselectField::shouldInfuseOOUI ( )

protected

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.