Multi-select field. More...

Inheritance diagram for HTMLMultiSelectField:

[legend]

Collaboration diagram for HTMLMultiSelectField:

[legend]

Public Member Functions
	filterDataForSubmit ( $data)
	Support for seperating multi-option preferences into multiple preferences Due to lack of array support. More...

	formatOptions ( $options, $value)

	getDefault ()

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

	loadDataFromRequest ( $request)

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

Public Member Functions inherited from HTMLFormField
	__construct ( $params)
	Initialise the object. More...

	filter ( $value, $alldata)

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

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

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

	getLabel ()

	getLabelHtml ( $cellAttributes=array())

	getOptions ()
	Fetch the array of options from the field's parameters. 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. More...

	msg ()
	Get a translated interface message. More...

	setShowEmptyLabel ( $show)
	Tell the field whether to generate a separate label element if its label is blank. 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? 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	$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

	$mFilterCallback

	$mID

	$mLabel

	$mName

	$mOptions = false

	$mOptionsLabelsNotFromMessage = false

bool	$mShowEmptyLabels = true
	If true will generate an empty div element with no label. More...

	$mValidationCallback

Detailed Description

Multi-select field.

Definition at line 6 of file HTMLMultiSelectField.php.

Member Function Documentation

◆ filterDataForSubmit()

HTMLMultiSelectField::filterDataForSubmit ( $data )

Support for seperating multi-option preferences into multiple preferences Due to lack of array support.

Parameters

$data array

Implements HTMLNestedFilterable.

Definition at line 106 of file HTMLMultiSelectField.php.

References $options, $res, array(), as, HTMLFormField\flattenOptions(), HTMLFormField\forceToStringRecursive(), and HTMLFormField\getOptions().

◆ formatOptions()

HTMLMultiSelectField::formatOptions	(	$options,
		$value
	)

Definition at line 37 of file HTMLMultiSelectField.php.

References $attribs, $html, $options, $value, array(), as, Xml\check(), HTMLFormField\getAttributes(), and Html\rawElement().

Referenced by getInputHTML().

◆ getDefault()

HTMLMultiSelectField::getDefault ( )

Reimplemented from HTMLFormField.

Definition at line 98 of file HTMLMultiSelectField.php.

References HTMLFormField\$mDefault, and array().

Referenced by loadDataFromRequest().

◆ getInputHTML()

HTMLMultiSelectField::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 HTMLFormField.

Definition at line 30 of file HTMLMultiSelectField.php.

References $html, $value, HTMLFormField\forceToStringRecursive(), formatOptions(), and HTMLFormField\getOptions().

◆ loadDataFromRequest()

HTMLMultiSelectField::loadDataFromRequest ( $request )

Parameters

$request WebRequest

Returns: String

Reimplemented from HTMLFormField.

Definition at line 77 of file HTMLMultiSelectField.php.

References array(), and getDefault().

◆ needsLabel()

HTMLMultiSelectField::needsLabel ( )

protected

Should this field have a label, or is there no input element with the appropriate id for the label to point to?

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

Reimplemented from HTMLFormField.

Definition at line 118 of file HTMLMultiSelectField.php.

◆ validate()

HTMLMultiSelectField::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	$value	The value the field was submitted with
array	$alldata	The data collected from the form

Returns: Mixed Bool true on success, or String error to display.

Reimplemented from HTMLFormField.

Reimplemented in EditWatchlistCheckboxSeriesField.

Definition at line 7 of file HTMLMultiSelectField.php.

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

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

includes/htmlform/HTMLMultiSelectField.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ filterDataForSubmit()

◆ formatOptions()

◆ getDefault()

◆ getInputHTML()

◆ loadDataFromRequest()

◆ needsLabel()

◆ validate()