includes/htmlform/fields/HTMLSelectAndOtherField.php

   1 <?php
   2
   3 /**
   4  * Double field with a dropdown list constructed from a system message in the format
   5  *     * Optgroup header
   6  *     ** <option value>
   7  *     * New Optgroup header
   8  * Plus a text field underneath for an additional reason.  The 'value' of the field is
   9  * "<select>: <extra reason>", or "<extra reason>" if nothing has been selected in the
  10  * select dropdown.
  11  * @todo FIXME: If made 'required', only the text field should be compulsory.
  12  */
  13 class HTMLSelectAndOtherField extends HTMLSelectField {
  14         public function __construct( $params ) {
  15                 if ( array_key_exists( 'other', $params ) ) {
  16                         // Do nothing
  17                 } elseif ( array_key_exists( 'other-message', $params ) ) {
  18                         $params['other'] = $this->getMessage( $params['other-message'] )->plain();
  19                 } else {
  20                         $params['other'] = $this->msg( 'htmlform-selectorother-other' )->plain();
  21                 }
  22
  23                 parent::__construct( $params );
  24
  25                 if ( $this->getOptions() === null ) {
  26                         // Sulk
  27                         throw new MWException( 'HTMLSelectAndOtherField called without any options' );
  28                 }
  29                 if ( !in_array( 'other', $this->mOptions, true ) ) {
  30                         // Have 'other' always as first element
  31                         $this->mOptions = [ $params['other'] => 'other' ] + $this->mOptions;
  32                 }
  33                 $this->mFlatOptions = self::flattenOptions( $this->getOptions() );
  34         }
  35
  36         public function getInputHTML( $value ) {
  37                 $select = parent::getInputHTML( $value[1] );
  38
  39                 $textAttribs = [
  40                         'id' => $this->mID . '-other',
  41                         'size' => $this->getSize(),
  42                         'class' => [ 'mw-htmlform-select-and-other-field' ],
  43                         'data-id-select' => $this->mID,
  44                 ];
  45
  46                 if ( $this->mClass !== '' ) {
  47                         $textAttribs['class'][] = $this->mClass;
  48                 }
  49
  50                 $allowedParams = [
  51                         'required',
  52                         'autofocus',
  53                         'multiple',
  54                         'disabled',
  55                         'tabindex',
  56                         'maxlength', // gets dynamic with javascript, see mediawiki.htmlform.js
  57                 ];
  58
  59                 $textAttribs += $this->getAttributes( $allowedParams );
  60
  61                 $textbox = Html::input( $this->mName . '-other', $value[2], 'text', $textAttribs );
  62
  63                 return "$select<br />\n$textbox";
  64         }
  65
  66         public function getInputOOUI( $value ) {
  67                 return false;
  68         }
  69
  70         /**
  71          * @param WebRequest $request
  72          *
  73          * @return array("<overall message>","<select value>","<text field value>")
  74          */
  75         public function loadDataFromRequest( $request ) {
  76                 if ( $request->getCheck( $this->mName ) ) {
  77                         $list = $request->getText( $this->mName );
  78                         $text = $request->getText( $this->mName . '-other' );
  79
  80                         // Should be built the same as in mediawiki.htmlform.js
  81                         if ( $list == 'other' ) {
  82                                 $final = $text;
  83                         } elseif ( !in_array( $list, $this->mFlatOptions, true ) ) {
  84                                 # User has spoofed the select form to give an option which wasn't
  85                                 # in the original offer.  Sulk...
  86                                 $final = $text;
  87                         } elseif ( $text == '' ) {
  88                                 $final = $list;
  89                         } else {
  90                                 $final = $list . $this->msg( 'colon-separator' )->inContentLanguage()->text() . $text;
  91                         }
  92                 } else {
  93                         $final = $this->getDefault();
  94
  95                         $list = 'other';
  96                         $text = $final;
  97                         foreach ( $this->mFlatOptions as $option ) {
  98                                 $match = $option . $this->msg( 'colon-separator' )->inContentLanguage()->text();
  99                                 if ( strpos( $text, $match ) === 0 ) {
 100                                         $list = $option;
 101                                         $text = substr( $text, strlen( $match ) );
 102                                         break;
 103                                 }
 104                         }
 105                 }
 106
 107                 return [ $final, $list, $text ];
 108         }
 109
 110         public function getSize() {
 111                 return isset( $this->mParams['size'] ) ? $this->mParams['size'] : 45;
 112         }
 113
 114         public function validate( $value, $alldata ) {
 115                 # HTMLSelectField forces $value to be one of the options in the select
 116                 # field, which is not useful here.  But we do want the validation further up
 117                 # the chain
 118                 $p = parent::validate( $value[1], $alldata );
 119
 120                 if ( $p !== true ) {
 121                         return $p;
 122                 }
 123
 124                 if ( isset( $this->mParams['required'] )
 125                         && $this->mParams['required'] !== false
 126                         && $value[1] === ''
 127                 ) {
 128                         return $this->msg( 'htmlform-required' );
 129                 }
 130
 131                 return true;
 132         }
 133 }