includes/htmlform/fields/HTMLNamespacesMultiselectField.php

   1 <?php
   2
   3 use MediaWiki\Widget\NamespacesMultiselectWidget;
   4
   5 /**
   6  * Implements a tag multiselect input field for namespaces.
   7  *
   8  * The result is the array of namespaces
   9  *
  10  * TODO: This widget duplicates a lot from HTMLTitlesMultiselectField,
  11  * which itself duplicates HTMLUsersMultiselectField. These classes
  12  * should be refactored.
  13  *
  14  * @note This widget is not likely to remain functional in non-OOUI forms.
  15  */
  16 class HTMLNamespacesMultiselectField extends HTMLSelectNamespace {
  17         public function loadDataFromRequest( $request ) {
  18                 $value = $request->getText( $this->mName, $this->getDefault() );
  19
  20                 $namespaces = explode( "\n", $value );
  21                 // Remove empty lines
  22                 $namespaces = array_values( array_filter( $namespaces, function ( $namespace ) {
  23                         return trim( $namespace ) !== '';
  24                 } ) );
  25                 // This function is expected to return a string
  26                 return implode( "\n", $namespaces );
  27         }
  28
  29         public function validate( $value, $alldata ) {
  30                 if ( !$this->mParams['exists'] ) {
  31                         return true;
  32                 }
  33
  34                 if ( is_null( $value ) ) {
  35                         return false;
  36                 }
  37
  38                 // $value is a string, because HTMLForm fields store their values as strings
  39                 $namespaces = explode( "\n", $value );
  40
  41                 if ( isset( $this->mParams['max'] ) && ( count( $namespaces ) > $this->mParams['max'] ) ) {
  42                         return $this->msg( 'htmlform-int-toohigh', $this->mParams['max'] );
  43                 }
  44
  45                 foreach ( $namespaces as $namespace ) {
  46                         if ( $namespace < 0 ) {
  47                                 return $this->msg( 'htmlform-select-badoption' );
  48                         }
  49
  50                         $result = parent::validate( $namespace, $alldata );
  51                         if ( $result !== true ) {
  52                                 return $result;
  53                         }
  54                 }
  55
  56                 return true;
  57         }
  58
  59         public function getInputHTML( $value ) {
  60                 $this->mParent->getOutput()->enableOOUI();
  61                 return $this->getInputOOUI( $value );
  62         }
  63
  64         public function getInputOOUI( $value ) {
  65                 $params = [
  66                         'id' => $this->mID,
  67                         'name' => $this->mName,
  68                         'dir' => $this->mDir,
  69                 ];
  70
  71                 if ( isset( $this->mParams['disabled'] ) ) {
  72                         $params['disabled'] = $this->mParams['disabled'];
  73                 }
  74
  75                 if ( isset( $this->mParams['default'] ) ) {
  76                         $params['default'] = $this->mParams['default'];
  77                 }
  78
  79                 if ( isset( $this->mParams['placeholder'] ) ) {
  80                         $params['placeholder'] = $this->mParams['placeholder'];
  81                 } else {
  82                         $params['placeholder'] = $this->msg( 'mw-widgets-titlesmultiselect-placeholder' )->plain();
  83                 }
  84
  85                 if ( isset( $this->mParams['max'] ) ) {
  86                         $params['tagLimit'] = $this->mParams['max'];
  87                 }
  88
  89                 if ( isset( $this->mParams['input'] ) ) {
  90                         $params['input'] = $this->mParams['input'];
  91                 }
  92
  93                 if ( !is_null( $value ) ) {
  94                         // $value is a string, but the widget expects an array
  95                         $params['default'] = $value === '' ? [] : explode( "\n", $value );
  96                 }
  97
  98                 // Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
  99                 $params['infusable'] = true;
 100                 $params['classes'] = [ 'mw-htmlform-field-autoinfuse' ];
 101                 $widget = new NamespacesMultiselectWidget( $params );
 102                 $widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
 103
 104                 return $widget;
 105         }
 106
 107         protected function shouldInfuseOOUI() {
 108                 return true;
 109         }
 110
 111         protected function getOOUIModules() {
 112                 return [ 'mediawiki.widgets.NamespacesMultiselectWidget' ];
 113         }
 114
 115 }