MediaWiki  master
HTMLNamespacesMultiselectField.php
Go to the documentation of this file.
1 <?php
2 
5 
19  public function loadDataFromRequest( $request ) {
20  $value = $request->getText( $this->mName, $this->getDefault() );
21 
22  $namespaces = explode( "\n", $value );
23  // Remove empty lines
24  $namespaces = array_values( array_filter( $namespaces, function ( $namespace ) {
25  return trim( $namespace ) !== '';
26  } ) );
27  // This function is expected to return a string
28  return implode( "\n", $namespaces );
29  }
30 
31  public function validate( $value, $alldata ) {
32  if ( !$this->mParams['exists'] || $value === '' ) {
33  return true;
34  }
35 
36  if ( $value === null ) {
37  return false;
38  }
39 
40  // $value is a string, because HTMLForm fields store their values as strings
41  $namespaces = explode( "\n", $value );
42 
43  if ( isset( $this->mParams['max'] ) && ( count( $namespaces ) > $this->mParams['max'] ) ) {
44  return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
45  }
46 
47  foreach ( $namespaces as $namespace ) {
48  if (
49  $namespace < 0 ||
50  !MediaWikiServices::getInstance()->getNamespaceInfo()->exists( $namespace )
51  ) {
52  return $this->msg( 'htmlform-select-badoption' );
53  }
54 
55  $result = parent::validate( $namespace, $alldata );
56  if ( $result !== true ) {
57  return $result;
58  }
59  }
60 
61  return true;
62  }
63 
64  public function getInputHTML( $value ) {
65  $this->mParent->getOutput()->enableOOUI();
66  return $this->getInputOOUI( $value );
67  }
68 
69  public function getInputOOUI( $value ) {
70  $params = [
71  'id' => $this->mID,
72  'name' => $this->mName,
73  'dir' => $this->mDir,
74  ];
75 
76  if ( isset( $this->mParams['disabled'] ) ) {
77  $params['disabled'] = $this->mParams['disabled'];
78  }
79 
80  if ( isset( $this->mParams['default'] ) ) {
81  $params['default'] = $this->mParams['default'];
82  }
83 
84  if ( isset( $this->mParams['placeholder'] ) ) {
85  $params['placeholder'] = $this->mParams['placeholder'];
86  } else {
87  $params['placeholder'] = $this->msg( 'mw-widgets-titlesmultiselect-placeholder' )->plain();
88  }
89 
90  if ( isset( $this->mParams['max'] ) ) {
91  $params['tagLimit'] = $this->mParams['max'];
92  }
93 
94  if ( isset( $this->mParams['input'] ) ) {
95  $params['input'] = $this->mParams['input'];
96  }
97 
98  if ( $value !== null ) {
99  // $value is a string, but the widget expects an array
100  $params['default'] = $value === '' ? [] : explode( "\n", $value );
101  }
102 
103  // Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
104  $params['infusable'] = true;
105  $params['classes'] = [ 'mw-htmlform-field-autoinfuse' ];
106  $widget = new NamespacesMultiselectWidget( $params );
107  $widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
108 
109  return $widget;
110  }
111 
112  protected function shouldInfuseOOUI() {
113  return true;
114  }
115 
116  protected function getOOUIModules() {
117  return [ 'mediawiki.widgets.NamespacesMultiselectWidget' ];
118  }
119 
120 }
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:160
HTMLNamespacesMultiselectField\getInputOOUI
getInputOOUI( $value)
Same as getInputHTML, but returns an OOUI object.Defaults to false, which getOOUI will interpret as "...
Definition: HTMLNamespacesMultiselectField.php:69
HTMLSelectNamespace
Wrapper for Html::namespaceSelector to use in HTMLForm.
Definition: HTMLSelectNamespace.php:7
HTMLNamespacesMultiselectField\validate
validate( $value, $alldata)
Override this function to add specific validation checks on the field input.
Definition: HTMLNamespacesMultiselectField.php:31
HTMLFormField\$mDir
$mDir
Definition: HTMLFormField.php:16
HTMLFormField\$mName
$mName
Definition: HTMLFormField.php:15
HTMLNamespacesMultiselectField\shouldInfuseOOUI
shouldInfuseOOUI()
Whether the field should be automatically infused.Note that all OOUI HTMLForm fields are infusable (y...
Definition: HTMLNamespacesMultiselectField.php:112
HTMLNamespacesMultiselectField\getInputHTML
getInputHTML( $value)
This function must be implemented to return the HTML to generate the input object itself....
Definition: HTMLNamespacesMultiselectField.php:64
HTMLFormField\$mID
$mID
Definition: HTMLFormField.php:18
MediaWiki\Widget\NamespacesMultiselectWidget
Widget to select multiple namespaces.
Definition: NamespacesMultiselectWidget.php:11
HTMLFormField\getDefault
getDefault()
Stable to override.
Definition: HTMLFormField.php:999
HTMLNamespacesMultiselectField\loadDataFromRequest
loadDataFromRequest( $request)
Get the value that this input has been set to from a posted form, or the input's default value if it ...
Definition: HTMLNamespacesMultiselectField.php:19
HTMLFormField\msg
msg( $key,... $params)
Get a translated interface message.
Definition: HTMLFormField.php:87
HTMLNamespacesMultiselectField\getOOUIModules
getOOUIModules()
Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to...
Definition: HTMLNamespacesMultiselectField.php:116
HTMLNamespacesMultiselectField
Implements a tag multiselect input field for namespaces.
Definition: HTMLNamespacesMultiselectField.php:18