HTMLCheckMatrix Class Reference

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:

Collaboration diagram for HTMLCheckMatrix:

List of all members.

Public Member Functions
	__construct ($params)
	Initialise the object.
	filterDataForSubmit ($data)
	Support for seperating multi-option preferences into multiple preferences Due to lack of array support.
	getDefault ()
	getInputHTML ($value)
	Build a table containing a matrix of checkbox options.
	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.
Protected Member Functions
	isTagForcedOff ($tag)
	isTagForcedOn ($tag)
Static Private Attributes
static	$requiredParams

---

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 list of columns in the matrix.
• rows
  • Required list of rows in the matrix.
• force-options-on
  • Accepts array of column-row tags to be displayed as enabled but unavailable to change
• force-options-off
  • Accepts array of column-row tags to be displayed as disabled but unavailable to change.
• tooltips
  • Optional array mapping row label to tooltip content
• tooltip-class
  • Optional CSS class used on tooltip container span. Defaults to mw-icon-question.

Definition at line 24 of file HTMLCheckMatrix.php.

---

Constructor & Destructor Documentation

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

References $params.

---

Member Function Documentation

HTMLCheckMatrix::filterDataForSubmit

(

$

data

)

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

Parameters:

array

$data

Implements HTMLNestedFilterable.

Definition at line 230 of file HTMLCheckMatrix.php.

References $columns, $res, array(), as, HTMLFormField\flattenOptions(), isTagForcedOff(), and isTagForcedOn().

HTMLCheckMatrix::getDefault

(

)

Reimplemented from HTMLFormField.

Definition at line 222 of file HTMLCheckMatrix.php.

References array().

Referenced by loadDataFromRequest().

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

References $attribs, $columns, $html, $value, array(), as, check, Html\closeElement(), Html\element(), HTMLFormField\getAttributes(), isTagForcedOff(), isTagForcedOn(), Html\openElement(), and Html\rawElement().

Referenced by 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 174 of file HTMLCheckMatrix.php.

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

HTMLCheckMatrix::isTagForcedOff

(

$

tag

)

[protected]

Definition at line 153 of file HTMLCheckMatrix.php.

Referenced by filterDataForSubmit(), and getInputHTML().

HTMLCheckMatrix::isTagForcedOn

(

$

tag

)

[protected]

Definition at line 158 of file HTMLCheckMatrix.php.

Referenced by filterDataForSubmit(), and getInputHTML().

HTMLCheckMatrix::loadDataFromRequest

(

$

request

)

Parameters:

WebRequest

$request

Returns:

array

Reimplemented from HTMLFormField.

Definition at line 202 of file HTMLCheckMatrix.php.

References array(), and getDefault().

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 True on success, or String error to display, or false to fail validation without displaying an error.

Reimplemented from HTMLFormField.

Definition at line 41 of file HTMLCheckMatrix.php.

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

---

Member Data Documentation

HTMLCheckMatrix::$requiredParams [static, private]

Initial value:

 array(
        
        'fieldname',
        
        'rows',
        'columns'
    )

Definition at line 25 of file HTMLCheckMatrix.php.

---

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

• includes/htmlform/HTMLCheckMatrix.php