A checkbox matrix Operates similarly to HTMLMultiSelectField, but instead of using an array of options, uses an array of rows and an array of columns to dynamically construct a matrix of options. More...

Inheritance diagram for HTMLCheckMatrix:

[legend]

Collaboration diagram for HTMLCheckMatrix:

[legend]

Public Member Functions
	__construct ( $params)
	Initialise the object.

	filterDataForSubmit ( $data)
	Support for separating multi-option preferences into multiple preferences Due to lack of array support.

	getDefault ()

	getInputHTML ( $value)
	Build a table containing a matrix of checkbox options.

	getInputOOUI ( $value)
	Same as getInputHTML, but returns an OOUI object.

	getTableRow ( $value)
	Get the complete table row for the input, including help text, labels, and whatever.

	loadDataFromRequest ( $request)

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

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)

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

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

	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.

	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 ()
	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
	getOneCheckboxHTML ( $checked, $attribs)

	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.

	isTagForcedOff ( $tag)

	isTagForcedOn ( $tag)

	shouldInfuseOOUI ()
	Whether the field should be automatically infused.

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

Static Private Attributes
static	$requiredParams

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

A checkbox matrix Operates similarly to HTMLMultiSelectField, but instead of using an array of options, uses an array of rows and an array of columns to dynamically construct a matrix of options.

The tags used to identify a particular cell are of the form "columnName-rowName"

Options:

columns
- Required associative array mapping column labels (as HTML) to their tags.
rows
- Required associative array mapping row labels (as HTML) to their tags.
force-options-on
- Array of column-row tags to be displayed as enabled but unavailable to change.
force-options-off
- Array of column-row tags to be displayed as disabled but unavailable to change.
tooltips
- Optional associative array mapping row labels to tooltips (as text, will be escaped).
tooltip-class
- Optional CSS class used on tooltip container span. Defaults to mw-icon-question. Not used by OOUI form fields.

Definition at line 25 of file HTMLCheckMatrix.php.

Constructor & Destructor Documentation

◆ __construct()

HTMLCheckMatrix::__construct ( $params )

Initialise the object.

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 34 of file HTMLCheckMatrix.php.

References $params.

Member Function Documentation

◆ filterDataForSubmit()

HTMLCheckMatrix::filterDataForSubmit ( $data )

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

Parameters

array $data

Implements HTMLNestedFilterable.

Definition at line 256 of file HTMLCheckMatrix.php.

References $data, $res, $rows, as, HTMLFormField\flattenOptions(), isTagForcedOff(), and isTagForcedOn().

◆ getDefault()

HTMLCheckMatrix::getDefault ( )

Reimplemented from HTMLFormField.

Definition at line 252 of file HTMLCheckMatrix.php.

Referenced by loadDataFromRequest().

◆ getInputHTML()

HTMLCheckMatrix::getInputHTML ( $value )

Build a table containing a matrix of checkbox options.

The value of each option is a combination of the row tag and column tag. mParams['rows'] is an array with row labels as keys and row tags as values. mParams['columns'] is an array with column labels as keys and column tags as values.

Parameters

array $value Array of the options that should be checked

Returns: string

Reimplemented from HTMLFormField.

Definition at line 83 of file HTMLCheckMatrix.php.

References $attribs, $html, $rows, $value, array(), as, HTMLFormField\getAttributes(), getOneCheckboxHTML(), isTagForcedOff(), and isTagForcedOn().

Referenced by getTableRow().

◆ getInputOOUI()

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

Definition at line 153 of file HTMLCheckMatrix.php.

References $attribs, $value, and HTMLFormField\getAttributes().

◆ getOneCheckboxHTML()

HTMLCheckMatrix::getOneCheckboxHTML	(	$checked,
		$attribs
	)

protected

Definition at line 171 of file HTMLCheckMatrix.php.

References $attribs.

Referenced by getInputHTML().

◆ getOOUIModules()

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

Definition at line 277 of file HTMLCheckMatrix.php.

◆ getTableRow()

HTMLCheckMatrix::getTableRow ( $value )

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

We override this function since the label should always be on a separate line above the options in the case of a checkbox matrix, i.e. it's always a "vertical-label".

Parameters

string $value The value to set the input to

Returns: string Complete HTML table row

Reimplemented from HTMLFormField.

Definition at line 203 of file HTMLCheckMatrix.php.

References $html, $value, HTMLFormField\getErrorsAndErrorClass(), HTMLFormField\getHelpText(), HTMLFormField\getHelpTextHtmlTable(), getInputHTML(), HTMLFormField\getLabelHtml(), and list.

◆ isTagForcedOff()

HTMLCheckMatrix::isTagForcedOff ( $tag )

protected

Definition at line 182 of file HTMLCheckMatrix.php.

Referenced by filterDataForSubmit(), and getInputHTML().

◆ isTagForcedOn()

HTMLCheckMatrix::isTagForcedOn ( $tag )

protected

Definition at line 187 of file HTMLCheckMatrix.php.

Referenced by filterDataForSubmit(), and getInputHTML().

◆ loadDataFromRequest()

HTMLCheckMatrix::loadDataFromRequest ( $request )

Parameters

WebRequest $request

Returns: array

Reimplemented from HTMLFormField.

Definition at line 241 of file HTMLCheckMatrix.php.

References $request, getDefault(), and HTMLFormField\isSubmitAttempt().

◆ shouldInfuseOOUI()

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

Definition at line 281 of file HTMLCheckMatrix.php.

◆ validate()

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

Definition at line 42 of file HTMLCheckMatrix.php.

References $rows, $value, as, and HTMLFormField\msg().

Member Data Documentation

◆ $requiredParams

HTMLCheckMatrix::$requiredParams

staticprivate

Initial value:

= [
        
        'fieldname',
        
        'rows',
        'columns'
    ]

Definition at line 26 of file HTMLCheckMatrix.php.

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

includes/htmlform/fields/HTMLCheckMatrix.php

Public Member Functions

Protected Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ filterDataForSubmit()

◆ getDefault()

◆ getInputHTML()

◆ getInputOOUI()

◆ getOneCheckboxHTML()

◆ getOOUIModules()

◆ getTableRow()

◆ isTagForcedOff()

◆ isTagForcedOn()

◆ loadDataFromRequest()

◆ shouldInfuseOOUI()

◆ validate()

Member Data Documentation

◆ $requiredParams