includes/htmlform/fields/HTMLUsersMultiselectField.php

   1 <?php
   2
   3 use MediaWiki\Widget\UsersMultiselectWidget;
   4
   5 /**
   6  * Implements a capsule multiselect input field for user names.
   7  *
   8  * Besides the parameters recognized by HTMLUserTextField, additional recognized
   9  * parameters are:
  10  *  default - (optional) Array of usernames to use as preset data
  11  *  placeholder - (optional) Custom placeholder message for input
  12  *
  13  * The result is the array of usernames
  14  *
  15  * @note This widget is not likely to remain functional in non-OOUI forms.
  16  */
  17 class HTMLUsersMultiselectField extends HTMLUserTextField {
  18         public function loadDataFromRequest( $request ) {
  19                 $value = $request->getText( $this->mName, $this->getDefault() );
  20
  21                 $usersArray = explode( "\n", $value );
  22                 // Remove empty lines
  23                 $usersArray = array_values( array_filter( $usersArray, function ( $username ) {
  24                         return trim( $username ) !== '';
  25                 } ) );
  26                 // This function is expected to return a string
  27                 return implode( "\n", $usersArray );
  28         }
  29
  30         public function validate( $value, $alldata ) {
  31                 if ( !$this->mParams['exists'] ) {
  32                         return true;
  33                 }
  34
  35                 if ( is_null( $value ) ) {
  36                         return false;
  37                 }
  38
  39                 // $value is a string, because HTMLForm fields store their values as strings
  40                 $usersArray = explode( "\n", $value );
  41                 foreach ( $usersArray as $username ) {
  42                         $result = parent::validate( $username, $alldata );
  43                         if ( $result !== true ) {
  44                                 return $result;
  45                         }
  46                 }
  47
  48                 return true;
  49         }
  50
  51         public function getInputHTML( $value ) {
  52                 $this->mParent->getOutput()->enableOOUI();
  53                 return $this->getInputOOUI( $value );
  54         }
  55
  56         public function getInputOOUI( $value ) {
  57                 $params = [ 'name' => $this->mName ];
  58
  59                 if ( isset( $this->mParams['default'] ) ) {
  60                         $params['default'] = $this->mParams['default'];
  61                 }
  62
  63                 if ( isset( $this->mParams['placeholder'] ) ) {
  64                         $params['placeholder'] = $this->mParams['placeholder'];
  65                 } else {
  66                         $params['placeholder'] = $this->msg( 'mw-widgets-usersmultiselect-placeholder' )
  67                                                         ->inContentLanguage()
  68                                                         ->plain();
  69                 }
  70
  71                 if ( !is_null( $value ) ) {
  72                         // $value is a string, but the widget expects an array
  73                         $params['default'] = explode( "\n", $value );
  74                 }
  75
  76                 // Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
  77                 $params['infusable'] = true;
  78                 $params['classes'] = [ 'mw-htmlform-field-autoinfuse' ];
  79                 $widget = new UsersMultiselectWidget( $params );
  80                 $widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
  81
  82                 return $widget;
  83         }
  84
  85         protected function shouldInfuseOOUI() {
  86                 return true;
  87         }
  88
  89         protected function getOOUIModules() {
  90                 return [ 'mediawiki.widgets.UsersMultiselectWidget' ];
  91         }
  92
  93 }