includes/htmlform/HTMLComboboxField.php

   1 <?php
   2
   3 /**
   4  * A combo box field.
   5  *
   6  * You can think of it as a dropdown select with the ability to add custom options,
   7  * or as a text field with input suggestions (autocompletion).
   8  *
   9  * When JavaScript is not supported or enabled, it uses HTML5 `<datalist>` element.
  10  *
  11  * Besides the parameters recognized by HTMLTextField, the following are
  12  * recognized:
  13  *   options-messages - As for HTMLSelectField
  14  *   options - As for HTMLSelectField
  15  *   options-message - As for HTMLSelectField
  16  */
  17 class HTMLComboboxField extends HTMLTextField {
  18         // FIXME Ewww, this shouldn't be adding any attributes not requested in $list :(
  19         public function getAttributes( array $list, array $mappings = null ) {
  20                 $attribs = array(
  21                         'type' => 'text',
  22                         'list' => $this->mName . '-datalist',
  23                 ) + parent::getAttributes( $list, $mappings );
  24
  25                 return $attribs;
  26         }
  27
  28         function getInputHTML( $value ) {
  29                 $datalist = new XmlSelect( false, $this->mName . '-datalist' );
  30                 $datalist->setTagName( 'datalist' );
  31                 $datalist->addOptions( $this->getOptions() );
  32
  33                 return parent::getInputHTML( $value ) . $datalist->getHTML();
  34         }
  35
  36         function getInputOOUI( $value ) {
  37                 $disabled = false;
  38                 $allowedParams = array( 'tabindex' );
  39                 $attribs = $this->getAttributes( $allowedParams, array( 'tabindex' => 'tabIndex' ) );
  40
  41                 if ( $this->mClass !== '' ) {
  42                         $attribs['classes'] = array( $this->mClass );
  43                 }
  44
  45                 if ( !empty( $this->mParams['disabled'] ) ) {
  46                         $disabled = true;
  47                 }
  48
  49                 return new OOUI\ComboBoxInputWidget( array(
  50                         'name' => $this->mName,
  51                         'id' => $this->mID,
  52                         'options' => $this->getOptionsOOUI(),
  53                         'value' => strval( $value ),
  54                         'disabled' => $disabled,
  55                 ) + $attribs );
  56         }
  57 }