3 namespace MediaWiki\Widget
;
6 * Check matrix widget. Displays a matrix of checkboxes for given options
8 * @copyright 2018 MediaWiki Widgets Team and others; see AUTHORS.txt
11 class CheckMatrixWidget
extends \OOUI\Widget
{
12 /** @var string|null */
14 /** @var string|null */
30 * Operates similarly to MultiSelectWidget, but instead of using an array of
31 * options, uses an array of rows and an array of columns to dynamically
32 * construct a matrix of options. The tags used to identify a particular cell
33 * are of the form "columnName-rowName"
35 * @param array $config Configuration array with the following options:
37 * - Required associative array mapping column labels (as HTML) to their tags.
39 * - Required associative array mapping row labels (as HTML) to their tags.
41 * - Array of column-row tags to be displayed as enabled but unavailable to change.
43 * - Array of column-row tags to be displayed as disabled but unavailable to change.
45 * - Optional associative array mapping row labels to tooltips (as text, will be escaped).
47 public function __construct( array $config = [] ) {
48 // Configuration initialization
50 parent
::__construct( $config );
52 $this->name
= $config['name'] ??
null;
53 $this->id
= $config['id'] ??
null;
56 $this->rows
= $config['rows'] ??
[];
57 $this->columns
= $config['columns'] ??
[];
58 $this->tooltips
= $config['tooltips'] ??
[];
60 $this->values
= $config['values'] ??
[];
62 $this->forcedOn
= $config['forcedOn'] ??
[];
63 $this->forcedOff
= $config['forcedOff'] ??
[];
66 $table = new \OOUI\
Tag( 'table' );
67 $table->addClasses( [ 'mw-htmlform-matrix mw-widget-checkMatrixWidget-matrix' ] );
68 $thead = new \OOUI\
Tag( 'thead' );
69 $table->appendContent( $thead );
70 $tr = new \OOUI\
Tag( 'tr' );
73 $tr->appendContent( $this->getCellTag( "\u{00A0}" ) );
74 foreach ( $this->columns
as $columnLabel => $columnTag ) {
76 $this->getCellTag( new \OOUI\
HtmlSnippet( $columnLabel ), 'th' )
79 $thead->appendContent( $tr );
81 // Build the options matrix
82 $tbody = new \OOUI\
Tag( 'tbody' );
83 $table->appendContent( $tbody );
84 foreach ( $this->rows
as $rowLabel => $rowTag ) {
85 $tbody->appendContent(
86 $this->getTableRow( $rowLabel, $rowTag )
91 $this->addClasses( [ 'mw-widget-checkMatrixWidget' ] );
92 $this->appendContent( $table );
96 * Get a formatted table row for the option, with
99 * @param string $label Row label (as HTML)
100 * @param string $tag Row tag name
101 * @return \OOUI\Tag The resulting table row
103 private function getTableRow( $label, $tag ) {
104 $row = new \OOUI\
Tag( 'tr' );
105 $tooltip = $this->getTooltip( $label );
106 $labelFieldConfig = $tooltip ?
[ 'help' => $tooltip ] : [];
108 $labelField = new \OOUI\
FieldLayout(
109 new \OOUI\
Widget(), // Empty widget, since we don't have the checkboxes here
111 'label' => new \OOUI\
HtmlSnippet( $label ),
113 ] +
$labelFieldConfig
115 $row->appendContent( $this->getCellTag( $labelField ) );
117 // Build checkbox column cells
118 foreach ( $this->columns
as $columnTag ) {
119 $thisTag = "$columnTag-$tag";
121 // Construct a checkbox
122 $checkbox = new \OOUI\
CheckboxInputWidget( [
124 'name' => $this->name ?
"{$this->name}[]" : null,
125 'id' => $this->id ?
"{$this->id}-$thisTag" : null,
126 'selected' => $this->isTagChecked( $thisTag ),
127 'disabled' => $this->isTagDisabled( $thisTag ),
130 $row->appendContent( $this->getCellTag( $checkbox ) );
136 * Get an individual cell tag with requested content
138 * @param mixed $content Content for the <td> cell
139 * @return \OOUI\Tag Resulting cell
141 private function getCellTag( $content, $tagElement = 'td' ) {
142 $cell = new \OOUI\
Tag( $tagElement );
143 $cell->appendContent( $content );
148 * Check whether the given tag's checkbox should
151 * @param string $tagName Tag name
152 * @return boolean Tag should be checked
154 private function isTagChecked( $tagName ) {
155 // If the tag is in the value list
156 return in_array( $tagName, (array)$this->values
, true ) ||
157 // Or if the tag is forced on
158 in_array( $tagName, (array)$this->forcedOn
, true );
162 * Check whether the given tag's checkbox should
165 * @param string $tagName Tag name
166 * @return boolean Tag should be disabled
168 private function isTagDisabled( $tagName ) {
170 // If the entire widget is disabled
171 $this->isDisabled() ||
172 // If the tag is 'forced on' or 'forced off'
173 in_array( $tagName, (array)$this->forcedOn
, true ) ||
174 in_array( $tagName, (array)$this->forcedOff
, true )
179 * Get the tooltip help associated with this row
181 * @param string $label Label name
182 * @return string Tooltip. Null if none is available.
184 private function getTooltip( $label ) {
185 return $this->tooltips
[ $label ] ??
null;
188 protected function getJavaScriptClassName() {
189 return 'mw.widgets.CheckMatrixWidget';
192 public function getConfig( &$config ) {
194 'name' => $this->name
,
196 'rows' => $this->rows
,
197 'columns' => $this->columns
,
198 'tooltips' => $this->tooltips
,
199 'forcedOff' => $this->forcedOff
,
200 'forcedOn' => $this->forcedOn
,
201 'values' => $this->values
,
203 return parent
::getConfig( $config );