MediaWiki REL1_39
CheckMatrixWidget.php
Go to the documentation of this file.
1<?php
2
4
11class CheckMatrixWidget extends \OOUI\Widget {
13 protected $name;
15 protected $id;
17 protected $columns;
19 protected $rows;
21 protected $tooltips;
23 protected $values;
25 protected $forcedOn;
27 protected $forcedOff;
28
47 public function __construct( array $config = [] ) {
48 // Configuration initialization
49
50 parent::__construct( $config );
51
52 $this->name = $config['name'] ?? null;
53 $this->id = $config['id'] ?? null;
54
55 // Properties
56 $this->rows = $config['rows'] ?? [];
57 $this->columns = $config['columns'] ?? [];
58 $this->tooltips = $config['tooltips'] ?? [];
59
60 $this->values = $config['values'] ?? [];
61
62 $this->forcedOn = $config['forcedOn'] ?? [];
63 $this->forcedOff = $config['forcedOff'] ?? [];
64
65 // Build the table
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' );
71
72 // Build the header
73 $tr->appendContent( $this->getCellTag( "\u{00A0}" ) );
74 foreach ( $this->columns as $columnLabel => $columnTag ) {
75 $tr->appendContent(
76 $this->getCellTag( new \OOUI\HtmlSnippet( $columnLabel ), 'th' )
77 );
78 }
79 $thead->appendContent( $tr );
80
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 )
87 );
88 }
89
90 // Initialization
91 $this->addClasses( [ 'mw-widget-checkMatrixWidget' ] );
92 $this->appendContent( $table );
93 }
94
103 private function getTableRow( $label, $tag ) {
104 $row = new \OOUI\Tag( 'tr' );
105 $tooltip = $this->getTooltip( $label );
106 $labelFieldConfig = $tooltip ? [ 'help' => $tooltip ] : [];
107 // Build label cell
108 $labelField = new \OOUI\FieldLayout(
109 new \OOUI\Widget(), // Empty widget, since we don't have the checkboxes here
110 [
111 'label' => new \OOUI\HtmlSnippet( $label ),
112 'align' => 'inline',
113 ] + $labelFieldConfig
114 );
115 $row->appendContent( $this->getCellTag( $labelField ) );
116
117 // Build checkbox column cells
118 foreach ( $this->columns as $columnTag ) {
119 $thisTag = "$columnTag-$tag";
120
121 // Construct a checkbox
122 $checkbox = new \OOUI\CheckboxInputWidget( [
123 'value' => $thisTag,
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 ),
128 ] );
129
130 $row->appendContent( $this->getCellTag( $checkbox ) );
131 }
132 return $row;
133 }
134
142 private function getCellTag( $content, $tagElement = 'td' ) {
143 $cell = new \OOUI\Tag( $tagElement );
144 $cell->appendContent( $content );
145 return $cell;
146 }
147
155 private function isTagChecked( $tagName ) {
156 // If the tag is in the value list
157 return in_array( $tagName, (array)$this->values, true ) ||
158 // Or if the tag is forced on
159 in_array( $tagName, (array)$this->forcedOn, true );
160 }
161
169 private function isTagDisabled( $tagName ) {
170 return (
171 // If the entire widget is disabled
172 $this->isDisabled() ||
173 // If the tag is 'forced on' or 'forced off'
174 in_array( $tagName, (array)$this->forcedOn, true ) ||
175 in_array( $tagName, (array)$this->forcedOff, true )
176 );
177 }
178
185 private function getTooltip( $label ) {
186 return $this->tooltips[ $label ] ?? null;
187 }
188
189 protected function getJavaScriptClassName() {
190 return 'mw.widgets.CheckMatrixWidget';
191 }
192
193 public function getConfig( &$config ) {
194 $config += [
195 'name' => $this->name,
196 'id' => $this->id,
197 'rows' => $this->rows,
198 'columns' => $this->columns,
199 'tooltips' => $this->tooltips,
200 'forcedOff' => $this->forcedOff,
201 'forcedOn' => $this->forcedOn,
202 'values' => $this->values,
203 ];
204 return parent::getConfig( $config );
205 }
206}
__construct(array $config=[])
Operates similarly to MultiSelectWidget, but instead of using an array of options,...
$content
Definition router.php:76