MediaWiki  master
HTMLCheckMatrix.php
Go to the documentation of this file.
1 <?php
2 
26  private static $requiredParams = [
27  // Required by underlying HTMLFormField
28  'fieldname',
29  // Required by HTMLCheckMatrix
30  'rows',
31  'columns'
32  ];
33 
34  public function __construct( $params ) {
35  $missing = array_diff( self::$requiredParams, array_keys( $params ) );
36  if ( $missing ) {
37  throw new HTMLFormFieldRequiredOptionsException( $this, $missing );
38  }
39  parent::__construct( $params );
40  }
41 
42  public function validate( $value, $alldata ) {
43  $rows = $this->mParams['rows'];
44  $columns = $this->mParams['columns'];
45 
46  // Make sure user-defined validation callback is run
47  $p = parent::validate( $value, $alldata );
48  if ( $p !== true ) {
49  return $p;
50  }
51 
52  // Make sure submitted value is an array
53  if ( !is_array( $value ) ) {
54  return false;
55  }
56 
57  // If all options are valid, array_intersect of the valid options
58  // and the provided options will return the provided options.
59  $validOptions = [];
60  foreach ( $rows as $rowTag ) {
61  foreach ( $columns as $columnTag ) {
62  $validOptions[] = $columnTag . '-' . $rowTag;
63  }
64  }
65  $validValues = array_intersect( $value, $validOptions );
66  if ( count( $validValues ) == count( $value ) ) {
67  return true;
68  } else {
69  return $this->msg( 'htmlform-select-badoption' );
70  }
71  }
72 
83  public function getInputHTML( $value ) {
84  $html = '';
85  $tableContents = '';
86  $rows = $this->mParams['rows'];
87  $columns = $this->mParams['columns'];
88 
89  $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
90 
91  // Build the column headers
92  $headerContents = Html::rawElement( 'td', [], "\u{00A0}" );
93  foreach ( $columns as $columnLabel => $columnTag ) {
94  $headerContents .= Html::rawElement( 'th', [], $columnLabel );
95  }
96  $thead = Html::rawElement( 'tr', [], "\n$headerContents\n" );
97  $tableContents .= Html::rawElement( 'thead', [], "\n$thead\n" );
98 
99  $tooltipClass = 'mw-icon-question';
100  if ( isset( $this->mParams['tooltip-class'] ) ) {
101  $tooltipClass = $this->mParams['tooltip-class'];
102  }
103 
104  // Build the options matrix
105  foreach ( $rows as $rowLabel => $rowTag ) {
106  // Append tooltip if configured
107  if ( isset( $this->mParams['tooltips'][$rowLabel] ) ) {
108  $tooltipAttribs = [
109  'class' => "mw-htmlform-tooltip $tooltipClass",
110  'title' => $this->mParams['tooltips'][$rowLabel],
111  'aria-label' => $this->mParams['tooltips'][$rowLabel]
112  ];
113  $rowLabel .= ' ' . Html::element( 'span', $tooltipAttribs, '' );
114  }
115  $rowContents = Html::rawElement( 'td', [], $rowLabel );
116  foreach ( $columns as $columnTag ) {
117  $thisTag = "$columnTag-$rowTag";
118  // Construct the checkbox
119  $thisAttribs = [
120  'id' => "{$this->mID}-$thisTag",
121  'value' => $thisTag,
122  ];
123  $checked = in_array( $thisTag, (array)$value, true );
124  if ( $this->isTagForcedOff( $thisTag ) ) {
125  $checked = false;
126  $thisAttribs['disabled'] = 1;
127  $thisAttribs['class'] = 'checkmatrix-forced checkmatrix-forced-off';
128  } elseif ( $this->isTagForcedOn( $thisTag ) ) {
129  $checked = true;
130  $thisAttribs['disabled'] = 1;
131  $thisAttribs['class'] = 'checkmatrix-forced checkmatrix-forced-on';
132  }
133 
134  $checkbox = $this->getOneCheckboxHTML( $checked, $attribs + $thisAttribs );
135 
136  $rowContents .= Html::rawElement(
137  'td',
138  [],
139  $checkbox
140  );
141  }
142  $tableContents .= Html::rawElement( 'tr', [], "\n$rowContents\n" );
143  }
144 
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";
149 
150  return $html;
151  }
152 
153  public function getInputOOUI( $value ) {
154  $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
155 
157  [
158  'name' => $this->mName,
159  'infusable' => true,
160  'id' => $this->mID,
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'] ?? [],
166  'values' => $value,
167  ] + OOUI\Element::configFromHtmlAttributes( $attribs )
168  );
169  }
170 
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' ] ) .
175  $checkbox .
176  Html::element( 'label', [ 'for' => $attribs['id'] ] ) .
177  Html::closeElement( 'div' );
178  }
179  return $checkbox;
180  }
181 
182  protected function isTagForcedOff( $tag ) {
183  return isset( $this->mParams['force-options-off'] )
184  && in_array( $tag, $this->mParams['force-options-off'] );
185  }
186 
187  protected function isTagForcedOn( $tag ) {
188  return isset( $this->mParams['force-options-on'] )
189  && in_array( $tag, $this->mParams['force-options-on'] );
190  }
191 
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 ];
209 
210  $hideClass = '';
211  $hideAttributes = [];
212  if ( $this->mHideIf ) {
213  $hideAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
214  $hideClass = 'mw-htmlform-hide-if';
215  }
216 
217  $label = $this->getLabelHtml( $cellAttributes );
218 
219  $field = Html::rawElement(
220  'td',
221  [ 'class' => 'mw-input' ] + $cellAttributes,
222  $inputHtml . "\n$errors"
223  );
224 
225  $html = Html::rawElement( 'tr',
226  [ 'class' => "mw-htmlform-vertical-label $hideClass" ] + $hideAttributes,
227  $label );
228  $html .= Html::rawElement( 'tr',
229  [ 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $hideClass" ] +
230  $hideAttributes,
231  $field );
232 
233  return $html . $helptext;
234  }
235 
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, [] );
246  } else {
247  // That's ok, the user has not yet submitted the form, so show the defaults
248  return $this->getDefault();
249  }
250  }
251 
252  public function getDefault() {
253  return $this->mDefault ?? [];
254  }
255 
256  public function filterDataForSubmit( $data ) {
257  $columns = HTMLFormField::flattenOptions( $this->mParams['columns'] );
258  $rows = HTMLFormField::flattenOptions( $this->mParams['rows'] );
259  $res = [];
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;
268  } else {
269  $res[$thisTag] = in_array( $thisTag, $data );
270  }
271  }
272  }
273 
274  return $res;
275  }
276 
277  protected function getOOUIModules() {
278  return [ 'mediawiki.widgets.CheckMatrixWidget' ];
279  }
280 
281  protected function shouldInfuseOOUI() {
282  return true;
283  }
284 }
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction $rows
Definition: hooks.txt:2621
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1972
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
getErrorsAndErrorClass( $value)
Determine form errors to display and their classes.
getOneCheckboxHTML( $checked, $attribs)
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
getLabelHtml( $cellAttributes=[])
msg()
Get a translated interface message.
static openElement( $element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing &#39;/&#39;...
Definition: Html.php:251
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
getInputHTML( $value)
Build a table containing a matrix of checkbox options.
$value
validate( $value, $alldata)
getTableRow( $value)
Get the complete table row for the input, including help text, labels, and whatever.
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
getHelpText()
Determine the help text to display.
$res
Definition: database.txt:21
$params
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:315
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1972
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
A checkbox matrix Operates similarly to HTMLMultiSelectField, but instead of using an array of option...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
__construct( $params)
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
getHelpTextHtmlTable( $helptext)
Generate help text HTML in table format.
filterDataForSubmit( $data)
Support for separating multi-option preferences into multiple preferences Due to lack of array suppor...
isSubmitAttempt(WebRequest $request)
Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just v...
getAttributes(array $list)
Returns the given attributes from the parameters.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2621
loadDataFromRequest( $request)
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323
static flattenOptions( $options)
flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>...