1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
|
<?php
/**
* Double field with a dropdown list constructed from a system message in the format
* * Optgroup header
* ** <option value>
* * New Optgroup header
* Plus a text field underneath for an additional reason. The 'value' of the field is
* "<select>: <extra reason>", or "<extra reason>" if nothing has been selected in the
* select dropdown.
*
* @stable to extend
* @todo FIXME: If made 'required', only the text field should be compulsory.
*/
class HTMLSelectAndOtherField extends HTMLSelectField {
/** @var string[] */
private $mFlatOptions;
/*
* @stable to call
*/
public function __construct( $params ) {
if ( array_key_exists( 'other', $params ) ) {
// Do nothing
} elseif ( array_key_exists( 'other-message', $params ) ) {
$params['other'] = $this->getMessage( $params['other-message'] )->plain();
} else {
$params['other'] = $this->msg( 'htmlform-selectorother-other' )->plain();
}
parent::__construct( $params );
if ( $this->getOptions() === null ) {
// Sulk
throw new MWException( 'HTMLSelectAndOtherField called without any options' );
}
if ( !in_array( 'other', $this->mOptions, true ) ) {
// Have 'other' always as first element
$this->mOptions = [ $params['other'] => 'other' ] + $this->mOptions;
}
$this->mFlatOptions = self::flattenOptions( $this->getOptions() );
}
public function getInputHTML( $value ) {
$select = parent::getInputHTML( $value[1] );
$textAttribs = [
'id' => $this->mID . '-other',
'size' => $this->getSize(),
'class' => [ 'mw-htmlform-select-and-other-field' ],
'data-id-select' => $this->mID,
];
if ( $this->mClass !== '' ) {
$textAttribs['class'][] = $this->mClass;
}
if ( isset( $this->mParams['maxlength-unit'] ) ) {
$textAttribs['data-mw-maxlength-unit'] = $this->mParams['maxlength-unit'];
}
$allowedParams = [
'required',
'autofocus',
'multiple',
'disabled',
'tabindex',
'maxlength', // gets dynamic with javascript, see mediawiki.htmlform.js
'maxlength-unit', // 'bytes' or 'codepoints', see mediawiki.htmlform.js
];
$textAttribs += $this->getAttributes( $allowedParams );
$textbox = Html::input( $this->mName . '-other', $value[2], 'text', $textAttribs );
return "$select<br />\n$textbox";
}
protected function getOOUIModules() {
return [ 'mediawiki.widgets.SelectWithInputWidget' ];
}
public function getInputOOUI( $value ) {
$this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.SelectWithInputWidget.styles' );
# TextInput
$textAttribs = [
'name' => $this->mName . '-other',
'value' => $value[2],
];
$allowedParams = [
'required',
'autofocus',
'multiple',
'disabled',
'tabindex',
'maxlength',
];
$textAttribs += OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( $allowedParams )
);
if ( $this->mClass !== '' ) {
$textAttribs['classes'] = [ $this->mClass ];
}
# DropdownInput
$dropdownInputAttribs = [
'name' => $this->mName,
'id' => $this->mID . '-select',
'options' => $this->getOptionsOOUI(),
'value' => $value[1],
];
$allowedParams = [
'tabindex',
'disabled',
];
$dropdownInputAttribs += OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( $allowedParams )
);
if ( $this->mClass !== '' ) {
$dropdownInputAttribs['classes'] = [ $this->mClass ];
}
$disabled = false;
if ( isset( $this->mParams[ 'disabled' ] ) && $this->mParams[ 'disabled' ] ) {
$disabled = true;
}
return $this->getInputWidget( [
'id' => $this->mID,
'disabled' => $disabled,
'textinput' => $textAttribs,
'dropdowninput' => $dropdownInputAttribs,
'or' => false,
'required' => $this->mParams[ 'required' ] ?? false,
'classes' => [ 'mw-htmlform-select-and-other-field' ],
'data' => [
'maxlengthUnit' => $this->mParams['maxlength-unit'] ?? 'bytes'
],
] );
}
/**
* @inheritDoc
* @stable to override
*/
public function getInputWidget( $params ) {
return new MediaWiki\Widget\SelectWithInputWidget( $params );
}
/**
* @inheritDoc
*/
public function getDefault() {
$default = parent::getDefault();
// Default values of empty form
$final = '';
$list = 'other';
$text = '';
if ( $default !== null ) {
$final = $default;
// Assume the default is a text value, with the 'other' option selected.
// Then check if that assumption is correct, and update $list and $text if not.
$text = $final;
foreach ( $this->mFlatOptions as $option ) {
$match = $option . $this->msg( 'colon-separator' )->inContentLanguage()->text();
if ( strpos( $final, $match ) === 0 ) {
$list = $option;
$text = substr( $final, strlen( $match ) );
break;
}
}
}
return [ $final, $list, $text ];
}
/**
* @param WebRequest $request
*
* @return array ["<overall message>","<select value>","<text field value>"]
*/
public function loadDataFromRequest( $request ) {
if ( $request->getCheck( $this->mName ) ) {
$list = $request->getText( $this->mName );
$text = $request->getText( $this->mName . '-other' );
// Should be built the same as in mediawiki.htmlform.js
if ( $list == 'other' ) {
$final = $text;
} elseif ( !in_array( $list, $this->mFlatOptions, true ) ) {
# User has spoofed the select form to give an option which wasn't
# in the original offer. Sulk...
$final = $text;
} elseif ( $text == '' ) {
$final = $list;
} else {
$final = $list . $this->msg( 'colon-separator' )->inContentLanguage()->text() . $text;
}
return [ $final, $list, $text ];
}
return $this->getDefault();
}
public function getSize() {
return $this->mParams['size'] ?? 45;
}
public function validate( $value, $alldata ) {
# HTMLSelectField forces $value to be one of the options in the select
# field, which is not useful here. But we do want the validation further up
# the chain
$p = parent::validate( $value[1], $alldata );
if ( $p !== true ) {
return $p;
}
if ( isset( $this->mParams['required'] )
&& $this->mParams['required'] !== false
&& $value[0] === ''
) {
return $this->msg( 'htmlform-required' );
}
return true;
}
}
|