6 class HTMLMultiSelectField
extends HTMLFormField
implements HTMLNestedFilterable
{
9 * In adition to the usual HTMLFormField parameters, this can take the following fields:
10 * - dropdown: If given, the options will be displayed inside a dropdown with a text field that
11 * can be used to filter them. This is desirable mostly for very long lists of options.
12 * This only works for users with JavaScript support and falls back to the list of checkboxes.
13 * - flatlist: If given, the options will be displayed on a single line (wrapping to following
14 * lines if necessary), rather than each one on a line of its own. This is desirable mostly
15 * for very short lists of concisely labelled options.
17 public function __construct( $params ) {
18 parent
::__construct( $params );
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'] = [];
25 if ( isset( $params['dropdown'] ) ) {
26 $this->mClass
.= ' mw-htmlform-dropdown';
29 if ( isset( $params['flatlist'] ) ) {
30 $this->mClass
.= ' mw-htmlform-flatlist';
34 public function validate( $value, $alldata ) {
35 $p = parent
::validate( $value, $alldata );
41 if ( !is_array( $value ) ) {
45 # If all options are valid, array_intersect of the valid options
46 # and the provided options will return the provided options.
47 $validOptions = HTMLFormField
::flattenOptions( $this->getOptions() );
49 $validValues = array_intersect( $value, $validOptions );
50 if ( count( $validValues ) == count( $value ) ) {
53 return $this->msg( 'htmlform-select-badoption' );
57 public function getInputHTML( $value ) {
58 if ( isset( $this->mParams
['dropdown'] ) ) {
59 $this->mParent
->getOutput()->addModules( 'jquery.chosen' );
62 $value = HTMLFormField
::forceToStringRecursive( $value );
63 $html = $this->formatOptions( $this->getOptions(), $value );
68 public function formatOptions( $options, $value ) {
71 $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
73 foreach ( $options as $label => $info ) {
74 if ( is_array( $info ) ) {
75 $html .= Html
::rawElement( 'h1', [], $label ) . "\n";
76 $html .= $this->formatOptions( $info, $value );
79 'id' => "{$this->mID}-$info",
82 if ( in_array( $info, $this->mParams
['disabled-options'], true ) ) {
83 $thisAttribs['disabled'] = 'disabled';
85 $checked = in_array( $info, $value, true );
87 $checkbox = $this->getOneCheckbox( $checked, $attribs +
$thisAttribs, $label );
89 $html .= ' ' . Html
::rawElement(
91 [ 'class' => 'mw-htmlform-flatlist-item' ],
100 protected function getOneCheckbox( $checked, $attribs, $label ) {
101 if ( $this->mParent
instanceof OOUIHTMLForm
) {
102 throw new MWException( 'HTMLMultiSelectField#getOneCheckbox() is not supported' );
104 $elementFunc = [ Html
::class, $this->mOptionsLabelsNotFromMessage ?
'rawElement' : 'element' ];
106 Xml
::check( "{$this->mName}[]", $checked, $attribs ) .
108 call_user_func( $elementFunc,
110 [ 'for' => $attribs['id'] ],
113 if ( $this->mParent
->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
114 $checkbox = Html
::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
116 Html
::closeElement( 'div' );
123 * Get options and make them into arrays suitable for OOUI.
124 * @return array Options for inclusion in a select or whatever.
126 public function getOptionsOOUI() {
127 // Sections make this difficult. See getInputOOUI().
128 throw new MWException( 'HTMLMultiSelectField#getOptionsOOUI() is not supported' );
132 * Get the OOUI version of this field.
134 * Returns OOUI\CheckboxMultiselectInputWidget for fields that only have one section,
138 * @param string[] $value
139 * @return string|OOUI\CheckboxMultiselectInputWidget
141 public function getInputOOUI( $value ) {
142 $this->mParent
->getOutput()->addModules( 'oojs-ui-widgets' );
144 $hasSections = false;
145 $optionsOouiSections = [];
146 $options = $this->getOptions();
147 // If the options are supposed to be split into sections, each section becomes a separate
148 // CheckboxMultiselectInputWidget.
149 foreach ( $options as $label => $section ) {
150 if ( is_array( $section ) ) {
151 $optionsOouiSections[ $label ] = Xml
::listDropDownOptionsOoui( $section );
152 unset( $options[$label] );
156 // If anything remains in the array, they are sectionless options. Put them in a separate widget
159 $optionsOouiSections = array_merge(
160 [ '' => Xml
::listDropDownOptionsOoui( $options ) ],
166 foreach ( $optionsOouiSections as $sectionLabel => $optionsOoui ) {
168 $attr['name'] = "{$this->mName}[]";
170 $attr['value'] = $value;
171 $attr['options'] = $optionsOoui;
173 foreach ( $attr['options'] as &$option ) {
174 $option['disabled'] = in_array( $option['data'], $this->mParams
['disabled-options'], true );
176 if ( $this->mOptionsLabelsNotFromMessage
) {
177 foreach ( $attr['options'] as &$option ) {
178 $option['label'] = new OOUI\
HtmlSnippet( $option['label'] );
182 $attr +
= OOUI\Element
::configFromHtmlAttributes(
183 $this->getAttributes( [ 'disabled', 'tabindex' ] )
186 if ( $this->mClass
!== '' ) {
187 $attr['classes'] = [ $this->mClass
];
190 $widget = new OOUI\
CheckboxMultiselectInputWidget( $attr );
191 if ( $sectionLabel ) {
192 $out[] = new OOUI\
FieldsetLayout( [
193 'items' => [ $widget ],
194 'label' => new OOUI\
HtmlSnippet( $sectionLabel ),
201 if ( !$hasSections ) {
202 // Directly return the only OOUI\CheckboxMultiselectInputWidget.
203 // This allows it to be made infusable and later tweaked by JS code.
207 return implode( '', $out );
211 * @param WebRequest $request
213 * @return string|array
215 public function loadDataFromRequest( $request ) {
216 $fromRequest = $request->getArray( $this->mName
, [] );
217 // Fetch the value in either one of the two following case:
218 // - we have a valid submit attempt (form was just submitted)
219 // - we have a value (an URL manually built by the user, or GET form with no wpFormIdentifier)
220 if ( $this->isSubmitAttempt( $request ) ||
$fromRequest ) {
221 // Checkboxes are just not added to the request arrays if they're not checked,
222 // so it's perfectly possible for there not to be an entry at all
225 // That's ok, the user has not yet submitted the form, so show the defaults
226 return $this->getDefault();
230 public function getDefault() {
231 return $this->mDefault ??
[];
234 public function filterDataForSubmit( $data ) {
235 $data = HTMLFormField
::forceToStringRecursive( $data );
236 $options = HTMLFormField
::flattenOptions( $this->getOptions() );
239 foreach ( $options as $opt ) {
240 $res["$opt"] = in_array( $opt, $data, true );
246 protected function needsLabel() {