4 * Double field with a dropdown list constructed from a system message in the format
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
11 * @todo FIXME: If made 'required', only the text field should be compulsory.
13 class HTMLSelectAndOtherField extends HTMLSelectField {
14 public function __construct( $params ) {
15 if ( array_key_exists( 'other', $params ) ) {
17 } elseif ( array_key_exists( 'other-message', $params ) ) {
18 $params['other'] = $this->getMessage( $params['other-message'] )->plain();
20 $params['other'] = $this->msg( 'htmlform-selectorother-other' )->plain();
23 parent::__construct( $params );
25 if ( $this->getOptions() === null ) {
27 throw new MWException( 'HTMLSelectAndOtherField called without any options' );
29 if ( !in_array( 'other', $this->mOptions, true ) ) {
30 // Have 'other' always as first element
31 $this->mOptions = [ $params['other'] => 'other' ] + $this->mOptions;
33 $this->mFlatOptions = self::flattenOptions( $this->getOptions() );
36 public function getInputHTML( $value ) {
37 $select = parent::getInputHTML( $value[1] );
40 'id' => $this->mID . '-other',
41 'size' => $this->getSize(),
42 'class' => [ 'mw-htmlform-select-and-other-field' ],
43 'data-id-select' => $this->mID,
46 if ( $this->mClass !== '' ) {
47 $textAttribs['class'][] = $this->mClass;
56 'maxlength', // gets dynamic with javascript, see mediawiki.htmlform.js
59 $textAttribs += $this->getAttributes( $allowedParams );
61 $textbox = Html::input( $this->mName . '-other', $value[2], 'text', $textAttribs );
63 return "$select<br />\n$textbox";
66 protected function getOOUIModules() {
67 return [ 'mediawiki.widgets.SelectWithInputWidget' ];
70 public function getInputOOUI( $value ) {
71 $this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.SelectWithInputWidget.styles' );
75 'id' => $this->mID . '-other',
76 'name' => $this->mName . '-other',
77 'size' => $this->getSize(),
78 'class' => [ 'mw-htmlform-select-and-other-field' ],
79 'data-id-select' => $this->mID,
92 $textAttribs += OOUI\Element::configFromHtmlAttributes(
93 $this->getAttributes( $allowedParams )
96 if ( $this->mClass !== '' ) {
97 $textAttribs['classes'] = [ $this->mClass ];
101 $dropdownInputAttribs = [
102 'name' => $this->mName,
104 'options' => $this->getOptionsOOUI(),
105 'value' => $value[1],
113 $dropdownInputAttribs += OOUI\Element::configFromHtmlAttributes(
114 $this->getAttributes( $allowedParams )
117 if ( $this->mClass !== '' ) {
118 $dropdownInputAttribs['classes'] = [ $this->mClass ];
121 return $this->getInputWidget( [
122 'textinput' => $textAttribs,
123 'dropdowninput' => $dropdownInputAttribs,
128 public function getInputWidget( $params ) {
129 return new Mediawiki\Widget\SelectWithInputWidget( $params );
133 * @param WebRequest $request
135 * @return array("<overall message>","<select value>","<text field value>")
137 public function loadDataFromRequest( $request ) {
138 if ( $request->getCheck( $this->mName ) ) {
139 $list = $request->getText( $this->mName );
140 $text = $request->getText( $this->mName . '-other' );
142 // Should be built the same as in mediawiki.htmlform.js
143 if ( $list == 'other' ) {
145 } elseif ( !in_array( $list, $this->mFlatOptions, true ) ) {
146 # User has spoofed the select form to give an option which wasn't
147 # in the original offer. Sulk...
149 } elseif ( $text == '' ) {
152 $final = $list . $this->msg( 'colon-separator' )->inContentLanguage()->text() . $text;
155 $final = $this->getDefault();
159 foreach ( $this->mFlatOptions as $option ) {
160 $match = $option . $this->msg( 'colon-separator' )->inContentLanguage()->text();
161 if ( strpos( $text, $match ) === 0 ) {
163 $text = substr( $text, strlen( $match ) );
169 return [ $final, $list, $text ];
172 public function getSize() {
173 return isset( $this->mParams['size'] ) ? $this->mParams['size'] : 45;
176 public function validate( $value, $alldata ) {
177 # HTMLSelectField forces $value to be one of the options in the select
178 # field, which is not useful here. But we do want the validation further up
180 $p = parent::validate( $value[1], $alldata );
186 if ( isset( $this->mParams['required'] )
187 && $this->mParams['required'] !== false
190 return $this->msg( 'htmlform-required' );