MediaWiki  REL1_31
HTMLMultiSelectField.php
Go to the documentation of this file.
1 <?php
2 
17  public function __construct( $params ) {
18  parent::__construct( $params );
19 
20  // If the disabled-options parameter is not provided, use an empty array
21  if ( isset( $this->mParams['disabled-options'] ) === false ) {
22  $this->mParams['disabled-options'] = [];
23  }
24 
25  // For backwards compatibility, also handle the old way with 'cssclass' => 'mw-chosen'
26  if ( isset( $params['dropdown'] ) || strpos( $this->mClass, 'mw-chosen' ) !== false ) {
27  $this->mClass .= ' mw-htmlform-dropdown';
28  }
29 
30  if ( isset( $params['flatlist'] ) ) {
31  $this->mClass .= ' mw-htmlform-flatlist';
32  }
33  }
34 
35  public function validate( $value, $alldata ) {
36  $p = parent::validate( $value, $alldata );
37 
38  if ( $p !== true ) {
39  return $p;
40  }
41 
42  if ( !is_array( $value ) ) {
43  return false;
44  }
45 
46  # If all options are valid, array_intersect of the valid options
47  # and the provided options will return the provided options.
48  $validOptions = HTMLFormField::flattenOptions( $this->getOptions() );
49 
50  $validValues = array_intersect( $value, $validOptions );
51  if ( count( $validValues ) == count( $value ) ) {
52  return true;
53  } else {
54  return $this->msg( 'htmlform-select-badoption' );
55  }
56  }
57 
58  public function getInputHTML( $value ) {
59  if ( isset( $this->mParams['dropdown'] ) ) {
60  $this->mParent->getOutput()->addModules( 'jquery.chosen' );
61  }
62 
64  $html = $this->formatOptions( $this->getOptions(), $value );
65 
66  return $html;
67  }
68 
69  public function formatOptions( $options, $value ) {
70  $html = '';
71 
72  $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
73 
74  foreach ( $options as $label => $info ) {
75  if ( is_array( $info ) ) {
76  $html .= Html::rawElement( 'h1', [], $label ) . "\n";
77  $html .= $this->formatOptions( $info, $value );
78  } else {
79  $thisAttribs = [
80  'id' => "{$this->mID}-$info",
81  'value' => $info,
82  ];
83  if ( in_array( $info, $this->mParams['disabled-options'], true ) ) {
84  $thisAttribs['disabled'] = 'disabled';
85  }
86  $checked = in_array( $info, $value, true );
87 
88  $checkbox = $this->getOneCheckbox( $checked, $attribs + $thisAttribs, $label );
89 
90  $html .= ' ' . Html::rawElement(
91  'div',
92  [ 'class' => 'mw-htmlform-flatlist-item' ],
93  $checkbox
94  );
95  }
96  }
97 
98  return $html;
99  }
100 
101  protected function getOneCheckbox( $checked, $attribs, $label ) {
102  if ( $this->mParent instanceof OOUIHTMLForm ) {
103  throw new MWException( 'HTMLMultiSelectField#getOneCheckbox() is not supported' );
104  } else {
105  $elementFunc = [ Html::class, $this->mOptionsLabelsNotFromMessage ? 'rawElement' : 'element' ];
106  $checkbox =
107  Xml::check( "{$this->mName}[]", $checked, $attribs ) .
108  '&#160;' .
109  call_user_func( $elementFunc,
110  'label',
111  [ 'for' => $attribs['id'] ],
112  $label
113  );
114  if ( $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
115  $checkbox = Html::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
116  $checkbox .
117  Html::closeElement( 'div' );
118  }
119  return $checkbox;
120  }
121  }
122 
127  public function getOptionsOOUI() {
128  // Sections make this difficult. See getInputOOUI().
129  throw new MWException( 'HTMLMultiSelectField#getOptionsOOUI() is not supported' );
130  }
131 
142  public function getInputOOUI( $value ) {
143  $this->mParent->getOutput()->addModules( 'oojs-ui-widgets' );
144 
145  $hasSections = false;
146  $optionsOouiSections = [];
147  $options = $this->getOptions();
148  // If the options are supposed to be split into sections, each section becomes a separate
149  // CheckboxMultiselectInputWidget.
150  foreach ( $options as $label => $section ) {
151  if ( is_array( $section ) ) {
152  $optionsOouiSections[ $label ] = Xml::listDropDownOptionsOoui( $section );
153  unset( $options[$label] );
154  $hasSections = true;
155  }
156  }
157  // If anything remains in the array, they are sectionless options. Put them in a separate widget
158  // at the beginning.
159  if ( $options ) {
160  $optionsOouiSections = array_merge(
162  $optionsOouiSections
163  );
164  }
165 
166  $out = [];
167  foreach ( $optionsOouiSections as $sectionLabel => $optionsOoui ) {
168  $attr = [];
169  $attr['name'] = "{$this->mName}[]";
170 
171  $attr['value'] = $value;
172  $attr['options'] = $optionsOoui;
173 
174  foreach ( $attr['options'] as &$option ) {
175  $option['disabled'] = in_array( $option['data'], $this->mParams['disabled-options'], true );
176  }
177  if ( $this->mOptionsLabelsNotFromMessage ) {
178  foreach ( $attr['options'] as &$option ) {
179  $option['label'] = new OOUI\HtmlSnippet( $option['label'] );
180  }
181  }
182 
183  $attr += OOUI\Element::configFromHtmlAttributes(
184  $this->getAttributes( [ 'disabled', 'tabindex' ] )
185  );
186 
187  if ( $this->mClass !== '' ) {
188  $attr['classes'] = [ $this->mClass ];
189  }
190 
191  $widget = new OOUI\CheckboxMultiselectInputWidget( $attr );
192  if ( $sectionLabel ) {
193  $out[] = new OOUI\FieldsetLayout( [
194  'items' => [ $widget ],
195  'label' => new OOUI\HtmlSnippet( $sectionLabel ),
196  ] );
197  } else {
198  $out[] = $widget;
199  }
200  }
201 
202  if ( !$hasSections ) {
203  // Directly return the only OOUI\CheckboxMultiselectInputWidget.
204  // This allows it to be made infusable and later tweaked by JS code.
205  return $out[ 0 ];
206  }
207 
208  return implode( '', $out );
209  }
210 
216  public function loadDataFromRequest( $request ) {
217  if ( $this->isSubmitAttempt( $request ) ) {
218  // Checkboxes are just not added to the request arrays if they're not checked,
219  // so it's perfectly possible for there not to be an entry at all
220  return $request->getArray( $this->mName, [] );
221  } else {
222  // That's ok, the user has not yet submitted the form, so show the defaults
223  return $this->getDefault();
224  }
225  }
226 
227  public function getDefault() {
228  if ( isset( $this->mDefault ) ) {
229  return $this->mDefault;
230  } else {
231  return [];
232  }
233  }
234 
235  public function filterDataForSubmit( $data ) {
236  $data = HTMLFormField::forceToStringRecursive( $data );
238 
239  $res = [];
240  foreach ( $options as $opt ) {
241  $res["$opt"] = in_array( $opt, $data, true );
242  }
243 
244  return $res;
245  }
246 
247  protected function needsLabel() {
248  return false;
249  }
250 }
HTMLFormField\getOptions
getOptions()
Fetch the array of options from the field's parameters.
Definition: HTMLFormField.php:1083
HTMLMultiSelectField\loadDataFromRequest
loadDataFromRequest( $request)
Definition: HTMLMultiSelectField.php:216
HTMLMultiSelectField\needsLabel
needsLabel()
Should this field have a label, or is there no input element with the appropriate id for the label to...
Definition: HTMLMultiSelectField.php:247
HTMLMultiSelectField\getDefault
getDefault()
Definition: HTMLMultiSelectField.php:227
HTMLMultiSelectField\getInputOOUI
getInputOOUI( $value)
Get the OOUI version of this field.
Definition: HTMLMultiSelectField.php:142
$html
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:2013
Xml\listDropDownOptionsOoui
static listDropDownOptionsOoui( $options)
Convert options for a drop-down box into a format accepted by OOUI\DropdownInputWidget etc.
Definition: Xml.php:582
$opt
$opt
Definition: postprocess-phan.php:119
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
HTMLFormField\$mClass
$mClass
Definition: HTMLFormField.php:16
php
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:37
HTMLMultiSelectField\filterDataForSubmit
filterDataForSubmit( $data)
Support for seperating multi-option preferences into multiple preferences Due to lack of array suppor...
Definition: HTMLMultiSelectField.php:235
OOUIHTMLForm
Compact stacked vertical format for forms, implemented using OOUI widgets.
Definition: OOUIHTMLForm.php:27
Html\closeElement
static closeElement( $element)
Returns "</$element>".
Definition: Html.php:309
HTMLMultiSelectField\validate
validate( $value, $alldata)
Override this function to add specific validation checks on the field input.
Definition: HTMLMultiSelectField.php:35
MWException
MediaWiki exception.
Definition: MWException.php:26
Xml\check
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:324
HTMLFormField
The parent class to generate form fields.
Definition: HTMLFormField.php:7
HTMLFormField\$mDefault
$mDefault
Definition: HTMLFormField.php:19
$options
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 & $options
Definition: hooks.txt:2001
$attribs
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:2014
$value
$value
Definition: styleTest.css.php:45
HTMLFormField\msg
msg()
Get a translated interface message.
Definition: HTMLFormField.php:77
HTMLMultiSelectField\getOneCheckbox
getOneCheckbox( $checked, $attribs, $label)
Definition: HTMLMultiSelectField.php:101
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3022
HTMLMultiSelectField\getInputHTML
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself.
Definition: HTMLMultiSelectField.php:58
HTMLNestedFilterable
Definition: HTMLNestedFilterable.php:3
HTMLMultiSelectField
Multi-select field.
Definition: HTMLMultiSelectField.php:6
as
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:22
Html\openElement
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
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
HTMLFormField\forceToStringRecursive
static forceToStringRecursive( $array)
Recursively forces values in an array to strings, because issues arise with integer 0 as a value.
Definition: HTMLFormField.php:1069
HTMLFormField\isSubmitAttempt
isSubmitAttempt(WebRequest $request)
Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just v...
Definition: HTMLFormField.php:362
HTMLMultiSelectField\formatOptions
formatOptions( $options, $value)
Definition: HTMLMultiSelectField.php:69
HTMLMultiSelectField\__construct
__construct( $params)
Definition: HTMLMultiSelectField.php:17
HTMLFormField\flattenOptions
static flattenOptions( $options)
flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>...
Definition: HTMLFormField.php:1122
class
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:56
$request
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:2806
HTMLMultiSelectField\getOptionsOOUI
getOptionsOOUI()
Get options and make them into arrays suitable for OOUI.
Definition: HTMLMultiSelectField.php:127
HTMLFormField\getAttributes
getAttributes(array $list)
Returns the given attributes from the parameters.
Definition: HTMLFormField.php:1027