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'] ) ) {
  42                         if ( count( $namespaces ) > $this->mParams['max'] ) {
  43                                 return $this->msg( 'htmlform-int-toohigh', $this->mParams['max'] );
  44                         }
  45                 }
  46
  47                 foreach ( $namespaces as $namespace ) {
  48                         $result = parent::validate( $namespace, $alldata );
  49                         if ( $result !== true ) {
  50                                 return $result;
  51                         }
  52                 }
  53
  54                 return true;
  55         }
  56
  57         public function getInputHTML( $value ) {
  58                 $this->mParent->getOutput()->enableOOUI();
  59                 return $this->getInputOOUI( $value );
  60         }
  61
  62         public function getInputOOUI( $value ) {
  63                 $params = [
  64                         'id' => $this->mID,
  65                         'name' => $this->mName,
  66                         'dir' => $this->mDir,
  67                 ];
  68
  69                 if ( isset( $this->mParams['disabled'] ) ) {
  70                         $params['disabled'] = $this->mParams['disabled'];
  71                 }
  72
  73                 if ( isset( $this->mParams['default'] ) ) {
  74                         $params['default'] = $this->mParams['default'];
  75                 }
  76
  77                 if ( isset( $this->mParams['placeholder'] ) ) {
  78                         $params['placeholder'] = $this->mParams['placeholder'];
  79                 } else {
  80                         $params['placeholder'] = $this->msg( 'mw-widgets-titlesmultiselect-placeholder' )->plain();
  81                 }
  82
  83                 if ( isset( $this->mParams['max'] ) ) {
  84                         $params['tagLimit'] = $this->mParams['max'];
  85                 }
  86
  87                 if ( isset( $this->mParams['input'] ) ) {
  88                         $params['input'] = $this->mParams['input'];
  89                 }
  90
  91                 if ( !is_null( $value ) ) {
  92                         // $value is a string, but the widget expects an array
  93                         $params['default'] = $value === '' ? [] : explode( "\n", $value );
  94                 }
  95
  96                 // Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
  97                 $params['infusable'] = true;
  98                 $params['classes'] = [ 'mw-htmlform-field-autoinfuse' ];
  99                 $widget = new NamespacesMultiselectWidget( $params );
 100                 $widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
 101
 102                 return $widget;
 103         }
 104
 105         protected function shouldInfuseOOUI() {
 106                 return true;
 107         }
 108
 109         protected function getOOUIModules() {
 110                 return [ 'mediawiki.widgets.NamespacesMultiselectWidget' ];
 111         }
 112
 113 }