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 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\Request\WebRequest;
use MediaWiki\Xml\XmlSelect;
/**
* Select dropdown field, with an additional "other" textbox.
*
* HTMLComboboxField implements the same functionality using a single form field
* and should be used instead.
*
* @stable to extend
*/
class HTMLSelectOrOtherField extends HTMLTextField {
private const FIELD_CLASS = 'mw-htmlform-select-or-other';
/**
* @stable to call
* @inheritDoc
*/
public function __construct( $params ) {
parent::__construct( $params );
$this->getOptions();
if ( !in_array( 'other', $this->mOptions, true ) ) {
$msg =
$params['other'] ?? wfMessage( 'htmlform-selectorother-other' )->text();
// Have 'other' always as first element
$this->mOptions = [ $msg => 'other' ] + $this->mOptions;
}
}
public function getInputHTML( $value ) {
$valInSelect = false;
if ( $value !== false ) {
$value = strval( $value );
$valInSelect = in_array(
$value, HTMLFormField::flattenOptions( $this->getOptions() ), true
);
}
$selected = $valInSelect ? $value : 'other';
$select = new XmlSelect( $this->mName, false, $selected );
$select->addOptions( $this->getOptions() );
$tbAttribs = [ 'size' => $this->getSize() ];
if ( !empty( $this->mParams['disabled'] ) ) {
$select->setAttribute( 'disabled', 'disabled' );
$tbAttribs['disabled'] = 'disabled';
}
if ( isset( $this->mParams['tabindex'] ) ) {
$select->setAttribute( 'tabindex', $this->mParams['tabindex'] );
$tbAttribs['tabindex'] = $this->mParams['tabindex'];
}
$select = $select->getHTML();
if ( isset( $this->mParams['maxlength'] ) ) {
$tbAttribs['maxlength'] = $this->mParams['maxlength'];
}
if ( isset( $this->mParams['minlength'] ) ) {
$tbAttribs['minlength'] = $this->mParams['minlength'];
}
$textbox = Html::input( $this->mName . '-other', $valInSelect ? '' : $value, 'text', $tbAttribs );
$wrapperAttribs = [
'id' => $this->mID,
'class' => $this->getFieldClasses()
];
if ( $this->mClass !== '' ) {
$wrapperAttribs['class'][] = $this->mClass;
}
return Html::rawElement(
'div',
$wrapperAttribs,
"$select<br />\n$textbox"
);
}
protected function shouldInfuseOOUI() {
return true;
}
protected function getOOUIModules() {
return [ 'mediawiki.widgets.SelectWithInputWidget' ];
}
public function getInputOOUI( $value ) {
$this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.SelectWithInputWidget.styles' );
$valInSelect = false;
if ( $value !== false ) {
$value = strval( $value );
$valInSelect = in_array(
$value, HTMLFormField::flattenOptions( $this->getOptions() ), true
);
}
# DropdownInput
$dropdownAttribs = [
'name' => $this->mName,
'options' => $this->getOptionsOOUI(),
'value' => $valInSelect ? $value : 'other',
];
$allowedParams = [
'disabled',
'tabindex',
];
$dropdownAttribs += \OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( $allowedParams )
);
# TextInput
$textAttribs = [
'name' => $this->mName . '-other',
'size' => $this->getSize(),
'value' => $valInSelect ? '' : $value,
];
$allowedParams = [
'required',
'autofocus',
'multiple',
'disabled',
'tabindex',
'maxlength',
'minlength',
];
$textAttribs += \OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( $allowedParams )
);
if ( $this->mPlaceholder !== '' ) {
$textAttribs['placeholder'] = $this->mPlaceholder;
}
$disabled = false;
if ( isset( $this->mParams[ 'disabled' ] ) && $this->mParams[ 'disabled' ] ) {
$disabled = true;
}
$inputClasses = $this->getFieldClasses();
if ( $this->mClass !== '' ) {
$inputClasses = array_merge( $inputClasses, explode( ' ', $this->mClass ) );
}
return $this->getInputWidget( [
'id' => $this->mID,
'classes' => $inputClasses,
'disabled' => $disabled,
'textinput' => $textAttribs,
'dropdowninput' => $dropdownAttribs,
'required' => $this->mParams[ 'required' ] ?? false,
'or' => true,
] );
}
public function getInputWidget( $params ) {
return new \MediaWiki\Widget\SelectWithInputWidget( $params );
}
public function getInputCodex( $value, $hasErrors ) {
// Figure out the value of the select.
$valInSelect = false;
if ( $value !== false ) {
$value = strval( $value );
$valInSelect = in_array(
$value, HTMLFormField::flattenOptions( $this->getOptions() ), true
);
}
$selected = $valInSelect ? $value : 'other';
// Create the <select> element.
$select = new XmlSelect( $this->mName, false, $selected );
// TODO: Add support for error class once it's implemented in the Codex CSS-only Select.
$select->setAttribute( 'class', 'cdx-select' );
$select->addOptions( $this->getOptions() );
// Set up attributes for the select and the text input.
$textInputAttribs = [ 'size' => $this->getSize() ];
$textInputAttribs['name'] = $this->mName . '-other';
if ( !empty( $this->mParams['disabled'] ) ) {
$select->setAttribute( 'disabled', 'disabled' );
$textInputAttribs['disabled'] = 'disabled';
}
if ( isset( $this->mParams['tabindex'] ) ) {
$select->setAttribute( 'tabindex', $this->mParams['tabindex'] );
$textInputAttribs['tabindex'] = $this->mParams['tabindex'];
}
if ( isset( $this->mParams['maxlength'] ) ) {
$textInputAttribs['maxlength'] = $this->mParams['maxlength'];
}
if ( isset( $this->mParams['minlength'] ) ) {
$textInputAttribs['minlength'] = $this->mParams['minlength'];
}
// Get HTML of the select and text input.
$select = $select->getHTML();
$textInput = parent::buildCodexComponent(
$valInSelect ? '' : $value,
$hasErrors,
'text',
$this->mName . '-other',
$textInputAttribs
);
// Set up the wrapper element and return the entire component.
$wrapperAttribs = [
'id' => $this->mID,
'class' => $this->getFieldClasses()
];
if ( $this->mClass !== '' ) {
$wrapperAttribs['class'][] = $this->mClass;
}
return Html::rawElement(
'div',
$wrapperAttribs,
"$select\n$textInput"
);
}
/**
* @param WebRequest $request
*
* @return string
*/
public function loadDataFromRequest( $request ) {
if ( $request->getCheck( $this->mName ) ) {
$val = $request->getText( $this->mName );
if ( $val === 'other' ) {
$val = $request->getText( $this->mName . '-other' );
}
return $val;
} else {
return $this->getDefault();
}
}
/**
* Returns a list of classes that should be applied to the widget itself. Unfortunately, we can't use
* $this->mClass or the 'cssclass' config option, because they're also added to the outer field wrapper
* (which includes the label). This method exists a temporary workaround until HTMLFormField will have
* a stable way for subclasses to specify additional classes for the widget itself.
* @internal Should only be used in HTMLTimezoneField
* @return string[]
*/
protected function getFieldClasses(): array {
return [ self::FIELD_CLASS ];
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLSelectOrOtherField::class, 'HTMLSelectOrOtherField' );
|