includes/htmlform/fields/HTMLMultiSelectField.php

   1 <?php
   2
   3 /**
   4  * Multi-select field
   5  */
   6 class HTMLMultiSelectField extends HTMLFormField implements HTMLNestedFilterable {
   7         /**
   8          * @param array $params
   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.
  16          */
  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
  63                 $value = HTMLFormField::forceToStringRecursive( $value );
  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                                 "\u{00A0}" .
 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
 123         /**
 124          * Get options and make them into arrays suitable for OOUI.
 125          * @return array Options for inclusion in a select or whatever.
 126          */
 127         public function getOptionsOOUI() {
 128                 // Sections make this difficult. See getInputOOUI().
 129                 throw new MWException( 'HTMLMultiSelectField#getOptionsOOUI() is not supported' );
 130         }
 131
 132         /**
 133          * Get the OOUI version of this field.
 134          *
 135          * Returns OOUI\CheckboxMultiselectInputWidget for fields that only have one section,
 136          * string otherwise.
 137          *
 138          * @since 1.28
 139          * @param string[] $value
 140          * @return string|OOUI\CheckboxMultiselectInputWidget
 141          */
 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(
 161                                 [ '' => Xml::listDropDownOptionsOoui( $options ) ],
 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
 211         /**
 212          * @param WebRequest $request
 213          *
 214          * @return string|array
 215          */
 216         public function loadDataFromRequest( $request ) {
 217                 $fromRequest = $request->getArray( $this->mName, [] );
 218                 // Fetch the value in either one of the two following case:
 219                 // - we have a valid submit attempt (form was just submitted)
 220                 // - we have a value (an URL manually built by the user, or GET form with no wpFormIdentifier)
 221                 if ( $this->isSubmitAttempt( $request ) || $fromRequest ) {
 222                         // Checkboxes are just not added to the request arrays if they're not checked,
 223                         // so it's perfectly possible for there not to be an entry at all
 224                         return $fromRequest;
 225                 } else {
 226                         // That's ok, the user has not yet submitted the form, so show the defaults
 227                         return $this->getDefault();
 228                 }
 229         }
 230
 231         public function getDefault() {
 232                 if ( isset( $this->mDefault ) ) {
 233                         return $this->mDefault;
 234                 } else {
 235                         return [];
 236                 }
 237         }
 238
 239         public function filterDataForSubmit( $data ) {
 240                 $data = HTMLFormField::forceToStringRecursive( $data );
 241                 $options = HTMLFormField::flattenOptions( $this->getOptions() );
 242
 243                 $res = [];
 244                 foreach ( $options as $opt ) {
 245                         $res["$opt"] = in_array( $opt, $data, true );
 246                 }
 247
 248                 return $res;
 249         }
 250
 251         protected function needsLabel() {
 252                 return false;
 253         }
 254 }