5 * Operates similarly to HTMLMultiSelectField, but instead of using an array of
6 * options, uses an array of rows and an array of columns to dynamically
7 * construct a matrix of options. The tags used to identify a particular cell
8 * are of the form "columnName-rowName"
12 * - Required associative array mapping column labels (as HTML) to their tags.
14 * - Required associative array mapping row labels (as HTML) to their tags.
16 * - Array of column-row tags to be displayed as enabled but unavailable to change.
18 * - Array of column-row tags to be displayed as disabled but unavailable to change.
20 * - Optional associative array mapping row labels to tooltips (as text, will be escaped).
22 * - Optional CSS class used on tooltip container span. Defaults to mw-icon-question.
23 * Not used by OOUI form fields.
25 class HTMLCheckMatrix
extends HTMLFormField
implements HTMLNestedFilterable
{
26 private static $requiredParams = [
27 // Required by underlying HTMLFormField
29 // Required by HTMLCheckMatrix
34 public function __construct( $params ) {
35 $missing = array_diff( self
::$requiredParams, array_keys( $params ) );
37 throw new HTMLFormFieldRequiredOptionsException( $this, $missing );
39 parent
::__construct( $params );
42 public function validate( $value, $alldata ) {
43 $rows = $this->mParams
['rows'];
44 $columns = $this->mParams
['columns'];
46 // Make sure user-defined validation callback is run
47 $p = parent
::validate( $value, $alldata );
52 // Make sure submitted value is an array
53 if ( !is_array( $value ) ) {
57 // If all options are valid, array_intersect of the valid options
58 // and the provided options will return the provided options.
60 foreach ( $rows as $rowTag ) {
61 foreach ( $columns as $columnTag ) {
62 $validOptions[] = $columnTag . '-' . $rowTag;
65 $validValues = array_intersect( $value, $validOptions );
66 if ( count( $validValues ) == count( $value ) ) {
69 return $this->msg( 'htmlform-select-badoption' );
74 * Build a table containing a matrix of checkbox options.
75 * The value of each option is a combination of the row tag and column tag.
76 * mParams['rows'] is an array with row labels as keys and row tags as values.
77 * mParams['columns'] is an array with column labels as keys and column tags as values.
79 * @param array $value Array of the options that should be checked
83 public function getInputHTML( $value ) {
86 $rows = $this->mParams
['rows'];
87 $columns = $this->mParams
['columns'];
89 $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
91 // Build the column headers
92 $headerContents = Html
::rawElement( 'td', [], "\u{00A0}" );
93 foreach ( $columns as $columnLabel => $columnTag ) {
94 $headerContents .= Html
::rawElement( 'th', [], $columnLabel );
96 $thead = Html
::rawElement( 'tr', [], "\n$headerContents\n" );
97 $tableContents .= Html
::rawElement( 'thead', [], "\n$thead\n" );
99 $tooltipClass = 'mw-icon-question';
100 if ( isset( $this->mParams
['tooltip-class'] ) ) {
101 $tooltipClass = $this->mParams
['tooltip-class'];
104 // Build the options matrix
105 foreach ( $rows as $rowLabel => $rowTag ) {
106 // Append tooltip if configured
107 if ( isset( $this->mParams
['tooltips'][$rowLabel] ) ) {
109 'class' => "mw-htmlform-tooltip $tooltipClass",
110 'title' => $this->mParams
['tooltips'][$rowLabel],
111 'aria-label' => $this->mParams
['tooltips'][$rowLabel]
113 $rowLabel .= ' ' . Html
::element( 'span', $tooltipAttribs, '' );
115 $rowContents = Html
::rawElement( 'td', [], $rowLabel );
116 foreach ( $columns as $columnTag ) {
117 $thisTag = "$columnTag-$rowTag";
118 // Construct the checkbox
120 'id' => "{$this->mID}-$thisTag",
123 $checked = in_array( $thisTag, (array)$value, true );
124 if ( $this->isTagForcedOff( $thisTag ) ) {
126 $thisAttribs['disabled'] = 1;
127 $thisAttribs['class'] = 'checkmatrix-forced checkmatrix-forced-off';
128 } elseif ( $this->isTagForcedOn( $thisTag ) ) {
130 $thisAttribs['disabled'] = 1;
131 $thisAttribs['class'] = 'checkmatrix-forced checkmatrix-forced-on';
134 $checkbox = $this->getOneCheckboxHTML( $checked, $attribs +
$thisAttribs );
136 $rowContents .= Html
::rawElement(
142 $tableContents .= Html
::rawElement( 'tr', [], "\n$rowContents\n" );
145 // Put it all in a table
146 $html .= Html
::rawElement( 'table',
147 [ 'class' => 'mw-htmlform-matrix' ],
148 Html
::rawElement( 'tbody', [], "\n$tableContents\n" ) ) . "\n";
153 public function getInputOOUI( $value ) {
154 $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
156 return new MediaWiki\Widget\
CheckMatrixWidget(
158 'name' => $this->mName
,
161 'rows' => $this->mParams
['rows'],
162 'columns' => $this->mParams
['columns'],
163 'tooltips' => $this->mParams
['tooltips'] ??
[],
164 'forcedOff' => $this->mParams
['force-options-off'] ??
[],
165 'forcedOn' => $this->mParams
['force-options-on'] ??
[],
167 ] + OOUI\Element
::configFromHtmlAttributes( $attribs )
171 protected function getOneCheckboxHTML( $checked, $attribs ) {
172 $checkbox = Xml
::check( "{$this->mName}[]", $checked, $attribs );
173 if ( $this->mParent
->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
174 $checkbox = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
176 Html
::element( 'label', [ 'for' => $attribs['id'] ] ) .
177 Html
::closeElement( 'div' );
182 protected function isTagForcedOff( $tag ) {
183 return isset( $this->mParams
['force-options-off'] )
184 && in_array( $tag, $this->mParams
['force-options-off'] );
187 protected function isTagForcedOn( $tag ) {
188 return isset( $this->mParams
['force-options-on'] )
189 && in_array( $tag, $this->mParams
['force-options-on'] );
193 * Get the complete table row for the input, including help text,
194 * labels, and whatever.
195 * We override this function since the label should always be on a separate
196 * line above the options in the case of a checkbox matrix, i.e. it's always
197 * a "vertical-label".
199 * @param string|array $value The value to set the input to
201 * @return string Complete HTML table row
203 public function getTableRow( $value ) {
204 list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
205 $inputHtml = $this->getInputHTML( $value );
206 $fieldType = static::class;
207 $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
208 $cellAttributes = [ 'colspan' => 2 ];
211 $hideAttributes = [];
212 if ( $this->mHideIf
) {
213 $hideAttributes['data-hide-if'] = FormatJson
::encode( $this->mHideIf
);
214 $hideClass = 'mw-htmlform-hide-if';
217 $label = $this->getLabelHtml( $cellAttributes );
219 $field = Html
::rawElement(
221 [ 'class' => 'mw-input' ] +
$cellAttributes,
222 $inputHtml . "\n$errors"
225 $html = Html
::rawElement( 'tr',
226 [ 'class' => "mw-htmlform-vertical-label $hideClass" ] +
$hideAttributes,
228 $html .= Html
::rawElement( 'tr',
229 [ 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $hideClass" ] +
233 return $html . $helptext;
237 * @param WebRequest $request
241 public function loadDataFromRequest( $request ) {
242 if ( $this->isSubmitAttempt( $request ) ) {
243 // Checkboxes are just not added to the request arrays if they're not checked,
244 // so it's perfectly possible for there not to be an entry at all
245 return $request->getArray( $this->mName
, [] );
247 // That's ok, the user has not yet submitted the form, so show the defaults
248 return $this->getDefault();
252 public function getDefault() {
253 return $this->mDefault ??
[];
256 public function filterDataForSubmit( $data ) {
257 $columns = HTMLFormField
::flattenOptions( $this->mParams
['columns'] );
258 $rows = HTMLFormField
::flattenOptions( $this->mParams
['rows'] );
260 foreach ( $columns as $column ) {
261 foreach ( $rows as $row ) {
262 // Make sure option hasn't been forced
263 $thisTag = "$column-$row";
264 if ( $this->isTagForcedOff( $thisTag ) ) {
265 $res[$thisTag] = false;
266 } elseif ( $this->isTagForcedOn( $thisTag ) ) {
267 $res[$thisTag] = true;
269 $res[$thisTag] = in_array( $thisTag, $data );
277 protected function getOOUIModules() {
278 return [ 'mediawiki.widgets.CheckMatrixWidget' ];
281 protected function shouldInfuseOOUI() {