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                 if ( isset( $params['dropdown'] ) ) {
  26                         $this->mClass .= ' mw-htmlform-dropdown';
  27                 }
  28
  29                 if ( isset( $params['flatlist'] ) ) {
  30                         $this->mClass .= ' mw-htmlform-flatlist';
  31                 }
  32         }
  33
  34         public function validate( $value, $alldata ) {
  35                 $p = parent::validate( $value, $alldata );
  36
  37                 if ( $p !== true ) {
  38                         return $p;
  39                 }
  40
  41                 if ( !is_array( $value ) ) {
  42                         return false;
  43                 }
  44
  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() );
  48
  49                 $validValues = array_intersect( $value, $validOptions );
  50                 if ( count( $validValues ) == count( $value ) ) {
  51                         return true;
  52                 } else {
  53                         return $this->msg( 'htmlform-select-badoption' );
  54                 }
  55         }
  56
  57         public function getInputHTML( $value ) {
  58                 if ( isset( $this->mParams['dropdown'] ) ) {
  59                         $this->mParent->getOutput()->addModules( 'jquery.chosen' );
  60                 }
  61
  62                 $value = HTMLFormField::forceToStringRecursive( $value );
  63                 $html = $this->formatOptions( $this->getOptions(), $value );
  64
  65                 return $html;
  66         }
  67
  68         public function formatOptions( $options, $value ) {
  69                 $html = '';
  70
  71                 $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
  72
  73                 foreach ( $options as $label => $info ) {
  74                         if ( is_array( $info ) ) {
  75                                 $html .= Html::rawElement( 'h1', [], $label ) . "\n";
  76                                 $html .= $this->formatOptions( $info, $value );
  77                         } else {
  78                                 $thisAttribs = [
  79                                         'id' => "{$this->mID}-$info",
  80                                         'value' => $info,
  81                                 ];
  82                                 if ( in_array( $info, $this->mParams['disabled-options'], true ) ) {
  83                                         $thisAttribs['disabled'] = 'disabled';
  84                                 }
  85                                 $checked = in_array( $info, $value, true );
  86
  87                                 $checkbox = $this->getOneCheckbox( $checked, $attribs + $thisAttribs, $label );
  88
  89                                 $html .= ' ' . Html::rawElement(
  90                                         'div',
  91                                         [ 'class' => 'mw-htmlform-flatlist-item' ],
  92                                         $checkbox
  93                                 );
  94                         }
  95                 }
  96
  97                 return $html;
  98         }
  99
 100         protected function getOneCheckbox( $checked, $attribs, $label ) {
 101                 if ( $this->mParent instanceof OOUIHTMLForm ) {
 102                         throw new MWException( 'HTMLMultiSelectField#getOneCheckbox() is not supported' );
 103                 } else {
 104                         $elementFunc = [ Html::class, $this->mOptionsLabelsNotFromMessage ? 'rawElement' : 'element' ];
 105                         $checkbox =
 106                                 Xml::check( "{$this->mName}[]", $checked, $attribs ) .
 107                                 "\u{00A0}" .
 108                                 call_user_func( $elementFunc,
 109                                         'label',
 110                                         [ 'for' => $attribs['id'] ],
 111                                         $label
 112                                 );
 113                         if ( $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
 114                                 $checkbox = Html::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
 115                                         $checkbox .
 116                                         Html::closeElement( 'div' );
 117                         }
 118                         return $checkbox;
 119                 }
 120         }
 121
 122         /**
 123          * Get options and make them into arrays suitable for OOUI.
 124          * @return array Options for inclusion in a select or whatever.
 125          */
 126         public function getOptionsOOUI() {
 127                 // Sections make this difficult. See getInputOOUI().
 128                 throw new MWException( 'HTMLMultiSelectField#getOptionsOOUI() is not supported' );
 129         }
 130
 131         /**
 132          * Get the OOUI version of this field.
 133          *
 134          * Returns OOUI\CheckboxMultiselectInputWidget for fields that only have one section,
 135          * string otherwise.
 136          *
 137          * @since 1.28
 138          * @param string[] $value
 139          * @return string|OOUI\CheckboxMultiselectInputWidget
 140          */
 141         public function getInputOOUI( $value ) {
 142                 $this->mParent->getOutput()->addModules( 'oojs-ui-widgets' );
 143
 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] );
 153                                 $hasSections = true;
 154                         }
 155                 }
 156                 // If anything remains in the array, they are sectionless options. Put them in a separate widget
 157                 // at the beginning.
 158                 if ( $options ) {
 159                         $optionsOouiSections = array_merge(
 160                                 [ '' => Xml::listDropDownOptionsOoui( $options ) ],
 161                                 $optionsOouiSections
 162                         );
 163                 }
 164
 165                 $out = [];
 166                 foreach ( $optionsOouiSections as $sectionLabel => $optionsOoui ) {
 167                         $attr = [];
 168                         $attr['name'] = "{$this->mName}[]";
 169
 170                         $attr['value'] = $value;
 171                         $attr['options'] = $optionsOoui;
 172
 173                         foreach ( $attr['options'] as &$option ) {
 174                                 $option['disabled'] = in_array( $option['data'], $this->mParams['disabled-options'], true );
 175                         }
 176                         if ( $this->mOptionsLabelsNotFromMessage ) {
 177                                 foreach ( $attr['options'] as &$option ) {
 178                                         $option['label'] = new OOUI\HtmlSnippet( $option['label'] );
 179                                 }
 180                         }
 181
 182                         $attr += OOUI\Element::configFromHtmlAttributes(
 183                                 $this->getAttributes( [ 'disabled', 'tabindex' ] )
 184                         );
 185
 186                         if ( $this->mClass !== '' ) {
 187                                 $attr['classes'] = [ $this->mClass ];
 188                         }
 189
 190                         $widget = new OOUI\CheckboxMultiselectInputWidget( $attr );
 191                         if ( $sectionLabel ) {
 192                                 $out[] = new OOUI\FieldsetLayout( [
 193                                         'items' => [ $widget ],
 194                                         'label' => new OOUI\HtmlSnippet( $sectionLabel ),
 195                                 ] );
 196                         } else {
 197                                 $out[] = $widget;
 198                         }
 199                 }
 200
 201                 if ( !$hasSections ) {
 202                         // Directly return the only OOUI\CheckboxMultiselectInputWidget.
 203                         // This allows it to be made infusable and later tweaked by JS code.
 204                         return $out[ 0 ];
 205                 }
 206
 207                 return implode( '', $out );
 208         }
 209
 210         /**
 211          * @param WebRequest $request
 212          *
 213          * @return string|array
 214          */
 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
 223                         return $fromRequest;
 224                 } else {
 225                         // That's ok, the user has not yet submitted the form, so show the defaults
 226                         return $this->getDefault();
 227                 }
 228         }
 229
 230         public function getDefault() {
 231                 if ( isset( $this->mDefault ) ) {
 232                         return $this->mDefault;
 233                 } else {
 234                         return [];
 235                 }
 236         }
 237
 238         public function filterDataForSubmit( $data ) {
 239                 $data = HTMLFormField::forceToStringRecursive( $data );
 240                 $options = HTMLFormField::flattenOptions( $this->getOptions() );
 241
 242                 $res = [];
 243                 foreach ( $options as $opt ) {
 244                         $res["$opt"] = in_array( $opt, $data, true );
 245                 }
 246
 247                 return $res;
 248         }
 249
 250         protected function needsLabel() {
 251                 return false;
 252         }
 253 }