Implements a tag multiselect input field for user names. More...

Inheritance diagram for HTMLUsersMultiselectField:

[legend]

Collaboration diagram for HTMLUsersMultiselectField:

[legend]

Public Member Functions
	getInputHTML ( $value)
	This function must be implemented to return the HTML to generate the input object itself. More...

	getInputOOUI ( $value)
	Same as getInputHTML, but returns an OOUI object. 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...

	validate ( $value, $alldata)
	Override this function to add specific validation checks on the field input. More...

Public Member Functions inherited from HTMLUserTextField
	__construct ( $params)

	getInputHtml ( $value)

Public Member Functions inherited from HTMLTextField
	getSize ()

	getSpellCheck ()

	isPersistent ()

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)

	getAttributes (array $list)
	Returns the given attributes from the parameters. More...

	getDefault ()

	getDiv ( $value)
	Get the complete div for the input, including help text, labels, and whatever. 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. 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 ()

	getLabelHtml ( $cellAttributes=[])

	getNotices ( $skipDeprecation=null)
	Determine notices to display for the field. More...

	getOOUI ( $value)
	Get the OOUI version of the div. 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...

	getRaw ( $value)
	Get the complete raw fields for the input, including help text, labels, and whatever. More...

	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever. 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...

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

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. More...

	shouldInfuseOOUI ()
	Whether the field should be automatically infused. More...

Protected Member Functions inherited from HTMLUserTextField
	getInputWidget ( $params)

	isValidIPRange ( $value)

Protected Member Functions inherited from HTMLTextField
	getDataAttribs ()
	Returns an array of data-* attributes to add to the field. More...

	getType (&$attribs)

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

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

	needsLabel ()
	Should this field have a label, or is there no input element with the appropriate id for the label to point to? 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 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 HTMLTextField
bool	$autocomplete
	HTML autocomplete attribute. More...

	$mPlaceholder = ''

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

Implements a tag multiselect input field for user names.

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

The result is the array of usernames

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

Definition at line 17 of file HTMLUsersMultiselectField.php.

Member Function Documentation

◆ getInputHTML()

HTMLUsersMultiselectField::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 $value The value to set the input to; eg a default text for a text input.

Returns: string Valid HTML.

Reimplemented from HTMLTextField.

Definition at line 51 of file HTMLUsersMultiselectField.php.

References $value, and getInputOOUI().

◆ getInputOOUI()

HTMLUsersMultiselectField::getInputOOUI ( $value )

Same as getInputHTML, but returns an OOUI object.

Defaults to false, which getOOUI will interpret as "use the HTML version"

Parameters

string $value

Returns: OOUI\Widget|false

Reimplemented from HTMLTextField.

Definition at line 56 of file HTMLUsersMultiselectField.php.

References HTMLFormField\$mName, $params, $value, getOOUIModules(), and HTMLFormField\msg().

Referenced by getInputHTML().

◆ getOOUIModules()

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

Returns: string[]

Reimplemented from HTMLUserTextField.

Definition at line 95 of file HTMLUsersMultiselectField.php.

Referenced by getInputOOUI().

◆ loadDataFromRequest()

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

Parameters

WebRequest $request

Returns: string The value

Reimplemented from HTMLFormField.

Definition at line 18 of file HTMLUsersMultiselectField.php.

References $request, $username, $value, and HTMLFormField\getDefault().

◆ shouldInfuseOOUI()

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

Returns: bool

Reimplemented from HTMLUserTextField.

Definition at line 91 of file HTMLUsersMultiselectField.php.

◆ validate()

HTMLUsersMultiselectField::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

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.

Reimplemented from HTMLUserTextField.

Definition at line 30 of file HTMLUsersMultiselectField.php.

References $username, $value, and as.

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

includes/htmlform/fields/HTMLUsersMultiselectField.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getInputHTML()

◆ getInputOOUI()

◆ getOOUIModules()

◆ loadDataFromRequest()

◆ shouldInfuseOOUI()

◆ validate()