MediaWiki  master
HTMLSelectOrOtherField.php
Go to the documentation of this file.
1 <?php
2 
10  public function __construct( $params ) {
11  parent::__construct( $params );
12  $this->getOptions();
13  if ( !in_array( 'other', $this->mOptions, true ) ) {
14  $msg =
15  $params['other'] ?? wfMessage( 'htmlform-selectorother-other' )->text();
16  // Have 'other' always as first element
17  $this->mOptions = [ $msg => 'other' ] + $this->mOptions;
18  }
19  }
20 
21  public function getInputHTML( $value ) {
22  $valInSelect = false;
23 
24  if ( $value !== false ) {
25  $value = strval( $value );
26  $valInSelect = in_array(
28  );
29  }
30 
31  $selected = $valInSelect ? $value : 'other';
32 
33  $select = new XmlSelect( $this->mName, $this->mID, $selected );
34  $select->addOptions( $this->getOptions() );
35 
36  $select->setAttribute( 'class', 'mw-htmlform-select-or-other' );
37 
38  $tbAttribs = [ 'id' => $this->mID . '-other', 'size' => $this->getSize() ];
39 
40  if ( !empty( $this->mParams['disabled'] ) ) {
41  $select->setAttribute( 'disabled', 'disabled' );
42  $tbAttribs['disabled'] = 'disabled';
43  }
44 
45  if ( isset( $this->mParams['tabindex'] ) ) {
46  $select->setAttribute( 'tabindex', $this->mParams['tabindex'] );
47  $tbAttribs['tabindex'] = $this->mParams['tabindex'];
48  }
49 
50  $select = $select->getHTML();
51 
52  if ( isset( $this->mParams['maxlength'] ) ) {
53  $tbAttribs['maxlength'] = $this->mParams['maxlength'];
54  }
55 
56  if ( $this->mClass !== '' ) {
57  $tbAttribs['class'] = $this->mClass;
58  }
59 
60  $textbox = Html::input( $this->mName . '-other', $valInSelect ? '' : $value, 'text', $tbAttribs );
61 
62  return "$select<br />\n$textbox";
63  }
64 
65  protected function shouldInfuseOOUI() {
66  return true;
67  }
68 
69  protected function getOOUIModules() {
70  return [ 'mediawiki.widgets.SelectWithInputWidget' ];
71  }
72 
73  public function getInputOOUI( $value ) {
74  $this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.SelectWithInputWidget.styles' );
75 
76  $valInSelect = false;
77  if ( $value !== false ) {
78  $value = strval( $value );
79  $valInSelect = in_array(
81  );
82  }
83 
84  # DropdownInput
85  $dropdownAttribs = [
86  'name' => $this->mName,
87  'options' => $this->getOptionsOOUI(),
88  'value' => $valInSelect ? $value : 'other',
89  'class' => [ 'mw-htmlform-select-or-other' ],
90  ];
91 
92  $allowedParams = [
93  'disabled',
94  'tabindex',
95  ];
96 
97  $dropdownAttribs += OOUI\Element::configFromHtmlAttributes(
98  $this->getAttributes( $allowedParams )
99  );
100 
101  # TextInput
102  $textAttribs = [
103  'name' => $this->mName . '-other',
104  'size' => $this->getSize(),
105  'value' => $valInSelect ? '' : $value,
106  ];
107 
108  $allowedParams = [
109  'required',
110  'autofocus',
111  'multiple',
112  'disabled',
113  'tabindex',
114  'maxlength',
115  ];
116 
117  $textAttribs += OOUI\Element::configFromHtmlAttributes(
118  $this->getAttributes( $allowedParams )
119  );
120 
121  if ( $this->mClass !== '' ) {
122  $textAttribs['classes'] = [ $this->mClass ];
123  }
124  if ( $this->mPlaceholder !== '' ) {
125  $textAttribs['placeholder'] = $this->mPlaceholder;
126  }
127 
128  $disabled = false;
129  if ( isset( $this->mParams[ 'disabled' ] ) && $this->mParams[ 'disabled' ] ) {
130  $disabled = true;
131  }
132 
133  return $this->getInputWidget( [
134  'id' => $this->mID,
135  'disabled' => $disabled,
136  'textinput' => $textAttribs,
137  'dropdowninput' => $dropdownAttribs,
138  'or' => true,
139  ] );
140  }
141 
142  public function getInputWidget( $params ) {
144  }
145 
151  public function loadDataFromRequest( $request ) {
152  if ( $request->getCheck( $this->mName ) ) {
153  $val = $request->getText( $this->mName );
154 
155  if ( $val === 'other' ) {
156  $val = $request->getText( $this->mName . '-other' );
157  }
158 
159  return $val;
160  } else {
161  return $this->getDefault();
162  }
163  }
164 }
getOptions()
Fetch the array of options from the field&#39;s parameters.
Select dropdown field, with an additional "other" textbox.
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
$value
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
$params
static input( $name, $value='', $type='text', array $attribs=[])
Convenience function to produce an "<input>" element.
Definition: Html.php:668
getOptionsOOUI()
Get options and make them into arrays suitable for OOUI.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
<input> field.
getAttributes(array $list)
Returns the given attributes from the parameters.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2633
static flattenOptions( $options)
flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>...
array bool null $mOptions