MediaWiki  master
HTMLCheckMatrix.php
Go to the documentation of this file.
1 <?php
2 
25  static private $requiredParams = [
26  // Required by underlying HTMLFormField
27  'fieldname',
28  // Required by HTMLCheckMatrix
29  'rows',
30  'columns'
31  ];
32 
33  public function __construct( $params ) {
34  $missing = array_diff( self::$requiredParams, array_keys( $params ) );
35  if ( $missing ) {
36  throw new HTMLFormFieldRequiredOptionsException( $this, $missing );
37  }
38  parent::__construct( $params );
39  }
40 
41  public function validate( $value, $alldata ) {
42  $rows = $this->mParams['rows'];
43  $columns = $this->mParams['columns'];
44 
45  // Make sure user-defined validation callback is run
46  $p = parent::validate( $value, $alldata );
47  if ( $p !== true ) {
48  return $p;
49  }
50 
51  // Make sure submitted value is an array
52  if ( !is_array( $value ) ) {
53  return false;
54  }
55 
56  // If all options are valid, array_intersect of the valid options
57  // and the provided options will return the provided options.
58  $validOptions = [];
59  foreach ( $rows as $rowTag ) {
60  foreach ( $columns as $columnTag ) {
61  $validOptions[] = $columnTag . '-' . $rowTag;
62  }
63  }
64  $validValues = array_intersect( $value, $validOptions );
65  if ( count( $validValues ) == count( $value ) ) {
66  return true;
67  } else {
68  return $this->msg( 'htmlform-select-badoption' );
69  }
70  }
71 
82  public function getInputHTML( $value ) {
83  $html = '';
84  $tableContents = '';
85  $rows = $this->mParams['rows'];
86  $columns = $this->mParams['columns'];
87 
88  $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
89 
90  // Build the column headers
91  $headerContents = Html::rawElement( 'td', [], '&#160;' );
92  foreach ( $columns as $columnLabel => $columnTag ) {
93  $headerContents .= Html::rawElement( 'td', [], $columnLabel );
94  }
95  $tableContents .= Html::rawElement( 'tr', [], "\n$headerContents\n" );
96 
97  $tooltipClass = 'mw-icon-question';
98  if ( isset( $this->mParams['tooltip-class'] ) ) {
99  $tooltipClass = $this->mParams['tooltip-class'];
100  }
101 
102  // Build the options matrix
103  foreach ( $rows as $rowLabel => $rowTag ) {
104  // Append tooltip if configured
105  if ( isset( $this->mParams['tooltips'][$rowLabel] ) ) {
106  $tooltipAttribs = [
107  'class' => "mw-htmlform-tooltip $tooltipClass",
108  'title' => $this->mParams['tooltips'][$rowLabel],
109  'aria-label' => $this->mParams['tooltips'][$rowLabel]
110  ];
111  $rowLabel .= ' ' . Html::element( 'span', $tooltipAttribs, '' );
112  }
113  $rowContents = Html::rawElement( 'td', [], $rowLabel );
114  foreach ( $columns as $columnTag ) {
115  $thisTag = "$columnTag-$rowTag";
116  // Construct the checkbox
117  $thisAttribs = [
118  'id' => "{$this->mID}-$thisTag",
119  'value' => $thisTag,
120  ];
121  $checked = in_array( $thisTag, (array)$value, true );
122  if ( $this->isTagForcedOff( $thisTag ) ) {
123  $checked = false;
124  $thisAttribs['disabled'] = 1;
125  $thisAttribs['class'] = 'checkmatrix-forced checkmatrix-forced-off';
126  } elseif ( $this->isTagForcedOn( $thisTag ) ) {
127  $checked = true;
128  $thisAttribs['disabled'] = 1;
129  $thisAttribs['class'] = 'checkmatrix-forced checkmatrix-forced-on';
130  }
131 
132  $checkbox = $this->getOneCheckbox( $checked, $attribs + $thisAttribs );
133 
134  $rowContents .= Html::rawElement(
135  'td',
136  [],
137  $checkbox
138  );
139  }
140  $tableContents .= Html::rawElement( 'tr', [], "\n$rowContents\n" );
141  }
142 
143  // Put it all in a table
144  $html .= Html::rawElement( 'table',
145  [ 'class' => 'mw-htmlform-matrix' ],
146  Html::rawElement( 'tbody', [], "\n$tableContents\n" ) ) . "\n";
147 
148  return $html;
149  }
150 
151  protected function getOneCheckbox( $checked, $attribs ) {
152  if ( $this->mParent instanceof OOUIHTMLForm ) {
153  return new OOUI\CheckboxInputWidget( [
154  'name' => "{$this->mName}[]",
155  'selected' => $checked,
156  ] + OOUI\Element::configFromHtmlAttributes(
157  $attribs
158  ) );
159  } else {
160  $checkbox = Xml::check( "{$this->mName}[]", $checked, $attribs );
161  if ( $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
162  $checkbox = Html::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
163  $checkbox .
164  Html::element( 'label', [ 'for' => $attribs['id'] ] ) .
165  Html::closeElement( 'div' );
166  }
167  return $checkbox;
168  }
169  }
170 
171  protected function isTagForcedOff( $tag ) {
172  return isset( $this->mParams['force-options-off'] )
173  && in_array( $tag, $this->mParams['force-options-off'] );
174  }
175 
176  protected function isTagForcedOn( $tag ) {
177  return isset( $this->mParams['force-options-on'] )
178  && in_array( $tag, $this->mParams['force-options-on'] );
179  }
180 
192  public function getTableRow( $value ) {
193  list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
194  $inputHtml = $this->getInputHTML( $value );
195  $fieldType = static::class;
196  $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
197  $cellAttributes = [ 'colspan' => 2 ];
198 
199  $hideClass = '';
200  $hideAttributes = [];
201  if ( $this->mHideIf ) {
202  $hideAttributes['data-hide-if'] = FormatJson::encode( $this->mHideIf );
203  $hideClass = 'mw-htmlform-hide-if';
204  }
205 
206  $label = $this->getLabelHtml( $cellAttributes );
207 
208  $field = Html::rawElement(
209  'td',
210  [ 'class' => 'mw-input' ] + $cellAttributes,
211  $inputHtml . "\n$errors"
212  );
213 
214  $html = Html::rawElement( 'tr',
215  [ 'class' => "mw-htmlform-vertical-label $hideClass" ] + $hideAttributes,
216  $label );
217  $html .= Html::rawElement( 'tr',
218  [ 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $hideClass" ] +
219  $hideAttributes,
220  $field );
221 
222  return $html . $helptext;
223  }
224 
230  public function loadDataFromRequest( $request ) {
231  if ( $this->isSubmitAttempt( $request ) ) {
232  // Checkboxes are just not added to the request arrays if they're not checked,
233  // so it's perfectly possible for there not to be an entry at all
234  return $request->getArray( $this->mName, [] );
235  } else {
236  // That's ok, the user has not yet submitted the form, so show the defaults
237  return $this->getDefault();
238  }
239  }
240 
241  public function getDefault() {
242  if ( isset( $this->mDefault ) ) {
243  return $this->mDefault;
244  } else {
245  return [];
246  }
247  }
248 
249  public function filterDataForSubmit( $data ) {
250  $columns = HTMLFormField::flattenOptions( $this->mParams['columns'] );
251  $rows = HTMLFormField::flattenOptions( $this->mParams['rows'] );
252  $res = [];
253  foreach ( $columns as $column ) {
254  foreach ( $rows as $row ) {
255  // Make sure option hasn't been forced
256  $thisTag = "$column-$row";
257  if ( $this->isTagForcedOff( $thisTag ) ) {
258  $res[$thisTag] = false;
259  } elseif ( $this->isTagForcedOn( $thisTag ) ) {
260  $res[$thisTag] = true;
261  } else {
262  $res[$thisTag] = in_array( $thisTag, $data );
263  }
264  }
265  }
266 
267  return $res;
268  }
269 }
static closeElement($element)
Returns "".
Definition: Html.php:309
getTableRow($value)
Get the complete table row for the input, including help text, labels, and whatever.
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:2636
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:2019
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
the array() calling protocol came about after MediaWiki 1.4rc1.
getLabelHtml($cellAttributes=[])
msg()
Get a translated interface message.
static rawElement($element, $attribs=[], $contents= '')
Returns an HTML element in a string.
Definition: Html.php:209
$value
getHelpText()
Determine the help text to display.
static check($name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:324
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:251
$res
Definition: database.txt:21
static encode($value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
$params
getHelpTextHtmlTable($helptext)
Generate help text HTML in table format.
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:2019
validate($value, $alldata)
filterDataForSubmit($data)
Support for seperating multi-option preferences into multiple preferences Due to lack of array suppor...
getOneCheckbox($checked, $attribs)
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
getInputHTML($value)
Build a table containing a matrix of checkbox options.
A checkbox matrix Operates similarly to HTMLMultiSelectField, but instead of using an array of option...
loadDataFromRequest($request)
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
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
Compact stacked vertical format for forms, implemented using OOUI widgets.
getErrorsAndErrorClass($value)
Determine form errors to display and their classes.
isSubmitAttempt(WebRequest $request)
Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just v...
static flattenOptions($options)
flatten an array of options to a single array, for instance, a set of "" inside "...
getAttributes(array $list)
Returns the given attributes from the parameters.
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
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:2636