MediaWiki  1.34.4
HTMLSelectField.php
Go to the documentation of this file.
1 <?php
2 
7  public function validate( $value, $alldata ) {
8  $p = parent::validate( $value, $alldata );
9 
10  if ( $p !== true ) {
11  return $p;
12  }
13 
14  $validOptions = HTMLFormField::flattenOptions( $this->getOptions() );
15 
16  if ( in_array( strval( $value ), $validOptions, true ) ) {
17  return true;
18  } else {
19  return $this->msg( 'htmlform-select-badoption' );
20  }
21  }
22 
23  public function getInputHTML( $value ) {
24  $select = new XmlSelect( $this->mName, $this->mID, strval( $value ) );
25 
26  if ( !empty( $this->mParams['disabled'] ) ) {
27  $select->setAttribute( 'disabled', 'disabled' );
28  }
29 
30  $allowedParams = [ 'tabindex', 'size' ];
31  $customParams = $this->getAttributes( $allowedParams );
32  foreach ( $customParams as $name => $value ) {
33  $select->setAttribute( $name, $value );
34  }
35 
36  if ( $this->mClass !== '' ) {
37  $select->setAttribute( 'class', $this->mClass );
38  }
39 
40  $select->addOptions( $this->getOptions() );
41 
42  return $select->getHTML();
43  }
44 
45  public function getInputOOUI( $value ) {
46  $disabled = false;
47  $allowedParams = [ 'tabindex' ];
48  $attribs = OOUI\Element::configFromHtmlAttributes(
49  $this->getAttributes( $allowedParams )
50  );
51 
52  if ( $this->mClass !== '' ) {
53  $attribs['classes'] = [ $this->mClass ];
54  }
55 
56  if ( !empty( $this->mParams['disabled'] ) ) {
57  $disabled = true;
58  }
59 
60  return new OOUI\DropdownInputWidget( [
61  'name' => $this->mName,
62  'id' => $this->mID,
63  'options' => $this->getOptionsOOUI(),
64  'value' => strval( $value ),
65  'disabled' => $disabled,
66  ] + $attribs );
67  }
68 
69  protected function shouldInfuseOOUI() {
70  return true;
71  }
72 }
HTMLFormField\getOptions
getOptions()
Fetch the array of options from the field's parameters.
Definition: HTMLFormField.php:1054
HTMLSelectField\getInputHTML
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself.
Definition: HTMLSelectField.php:23
HTMLFormField\$mClass
$mClass
Definition: HTMLFormField.php:17
XmlSelect
Class for generating HTML <select> or <datalist> elements.
Definition: XmlSelect.php:26
HTMLSelectField\shouldInfuseOOUI
shouldInfuseOOUI()
Whether the field should be automatically infused.
Definition: HTMLSelectField.php:69
HTMLSelectField
A select dropdown field.
Definition: HTMLSelectField.php:6
HTMLFormField
The parent class to generate form fields.
Definition: HTMLFormField.php:7
HTMLSelectField\getInputOOUI
getInputOOUI( $value)
Same as getInputHTML, but returns an OOUI object.
Definition: HTMLSelectField.php:45
HTMLSelectField\validate
validate( $value, $alldata)
Override this function to add specific validation checks on the field input.
Definition: HTMLSelectField.php:7
HTMLFormField\flattenOptions
static flattenOptions( $options)
flatten an array of options to a single array, for instance, a set of "<options>" inside "<optgroups>...
Definition: HTMLFormField.php:1093
HTMLFormField\msg
msg( $key,... $params)
Get a translated interface message.
Definition: HTMLFormField.php:83
HTMLFormField\getOptionsOOUI
getOptionsOOUI()
Get options and make them into arrays suitable for OOUI.
Definition: HTMLFormField.php:1076
HTMLFormField\getAttributes
getAttributes(array $list)
Returns the given attributes from the parameters.
Definition: HTMLFormField.php:998