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                 // For backwards compatibility, also handle the old way with 'cssclass' => 'mw-chosen'
  21                 if ( isset( $params['dropdown'] ) || strpos( $this->mClass, 'mw-chosen' ) !== false ) {
  22                         $this->mClass .= ' mw-htmlform-dropdown';
  23                 }
  24
  25                 if ( isset( $params['flatlist'] ) ) {
  26                         $this->mClass .= ' mw-htmlform-flatlist';
  27                 }
  28         }
  29
  30         public function validate( $value, $alldata ) {
  31                 $p = parent::validate( $value, $alldata );
  32
  33                 if ( $p !== true ) {
  34                         return $p;
  35                 }
  36
  37                 if ( !is_array( $value ) ) {
  38                         return false;
  39                 }
  40
  41                 # If all options are valid, array_intersect of the valid options
  42                 # and the provided options will return the provided options.
  43                 $validOptions = HTMLFormField::flattenOptions( $this->getOptions() );
  44
  45                 $validValues = array_intersect( $value, $validOptions );
  46                 if ( count( $validValues ) == count( $value ) ) {
  47                         return true;
  48                 } else {
  49                         return $this->msg( 'htmlform-select-badoption' );
  50                 }
  51         }
  52
  53         public function getInputHTML( $value ) {
  54                 if ( isset( $this->mParams['dropdown'] ) ) {
  55                         $this->mParent->getOutput()->addModules( 'jquery.chosen' );
  56                 }
  57
  58                 $value = HTMLFormField::forceToStringRecursive( $value );
  59                 $html = $this->formatOptions( $this->getOptions(), $value );
  60
  61                 return $html;
  62         }
  63
  64         public function formatOptions( $options, $value ) {
  65                 $html = '';
  66
  67                 $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
  68
  69                 foreach ( $options as $label => $info ) {
  70                         if ( is_array( $info ) ) {
  71                                 $html .= Html::rawElement( 'h1', [], $label ) . "\n";
  72                                 $html .= $this->formatOptions( $info, $value );
  73                         } else {
  74                                 $thisAttribs = [
  75                                         'id' => "{$this->mID}-$info",
  76                                         'value' => $info,
  77                                 ];
  78                                 $checked = in_array( $info, $value, true );
  79
  80                                 $checkbox = $this->getOneCheckbox( $checked, $attribs + $thisAttribs, $label );
  81
  82                                 $html .= ' ' . Html::rawElement(
  83                                         'div',
  84                                         [ 'class' => 'mw-htmlform-flatlist-item' ],
  85                                         $checkbox
  86                                 );
  87                         }
  88                 }
  89
  90                 return $html;
  91         }
  92
  93         protected function getOneCheckbox( $checked, $attribs, $label ) {
  94                 if ( $this->mParent instanceof OOUIHTMLForm ) {
  95                         throw new MWException( 'HTMLMultiSelectField#getOneCheckbox() is not supported' );
  96                 } else {
  97                         $elementFunc = [ 'Html', $this->mOptionsLabelsNotFromMessage ? 'rawElement' : 'element' ];
  98                         $checkbox =
  99                                 Xml::check( "{$this->mName}[]", $checked, $attribs ) .
 100                                 '&#160;' .
 101                                 call_user_func( $elementFunc,
 102                                         'label',
 103                                         [ 'for' => $attribs['id'] ],
 104                                         $label
 105                                 );
 106                         if ( $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
 107                                 $checkbox = Html::openElement( 'div', [ 'class' => 'mw-ui-checkbox' ] ) .
 108                                         $checkbox .
 109                                         Html::closeElement( 'div' );
 110                         }
 111                         return $checkbox;
 112                 }
 113         }
 114
 115         /**
 116          * Get the OOUI version of this field.
 117          *
 118          * @since 1.28
 119          * @param string[] $value
 120          * @return OOUI\CheckboxMultiselectInputWidget
 121          */
 122         public function getInputOOUI( $value ) {
 123                 $this->mParent->getOutput()->addModules( 'oojs-ui-widgets' );
 124
 125                 $attr = $this->getTooltipAndAccessKey();
 126                 $attr['id'] = $this->mID;
 127                 $attr['name'] = "{$this->mName}[]";
 128
 129                 $attr['value'] = $value;
 130                 $attr['options'] = $this->getOptionsOOUI();
 131
 132                 if ( $this->mOptionsLabelsNotFromMessage ) {
 133                         foreach ( $attr['options'] as &$option ) {
 134                                 $option['label'] = new OOUI\HtmlSnippet( $option['label'] );
 135                         }
 136                 }
 137
 138                 $attr += OOUI\Element::configFromHtmlAttributes(
 139                         $this->getAttributes( [ 'disabled', 'tabindex' ] )
 140                 );
 141
 142                 if ( $this->mClass !== '' ) {
 143                         $attr['classes'] = [ $this->mClass ];
 144                 }
 145
 146                 return new OOUI\CheckboxMultiselectInputWidget( $attr );
 147         }
 148
 149         /**
 150          * @param WebRequest $request
 151          *
 152          * @return string|array
 153          */
 154         public function loadDataFromRequest( $request ) {
 155                 if ( $this->isSubmitAttempt( $request ) ) {
 156                         // Checkboxes are just not added to the request arrays if they're not checked,
 157                         // so it's perfectly possible for there not to be an entry at all
 158                         return $request->getArray( $this->mName, [] );
 159                 } else {
 160                         // That's ok, the user has not yet submitted the form, so show the defaults
 161                         return $this->getDefault();
 162                 }
 163         }
 164
 165         public function getDefault() {
 166                 if ( isset( $this->mDefault ) ) {
 167                         return $this->mDefault;
 168                 } else {
 169                         return [];
 170                 }
 171         }
 172
 173         public function filterDataForSubmit( $data ) {
 174                 $data = HTMLFormField::forceToStringRecursive( $data );
 175                 $options = HTMLFormField::flattenOptions( $this->getOptions() );
 176
 177                 $res = [];
 178                 foreach ( $options as $opt ) {
 179                         $res["$opt"] = in_array( $opt, $data, true );
 180                 }
 181
 182                 return $res;
 183         }
 184
 185         protected function needsLabel() {
 186                 return false;
 187         }
 188 }