includes/widget/NamespaceInputWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget;
   4
   5 /**
   6  * Namespace input widget. Displays a dropdown box with the choice of available namespaces.
   7  *
   8  * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
   9  * @license MIT
  10  */
  11 class NamespaceInputWidget extends \OOUI\DropdownInputWidget {
  12         /** @var string */
  13         protected $includeAllValue;
  14         /** @var int[] */
  15         protected $exclude;
  16
  17         /**
  18          * @param array $config Configuration options
  19          *   - string $config['includeAllValue'] If specified, add a "all namespaces" option to the
  20          *     namespace dropdown, and use this as the input value for it
  21          *   - int[] $config['exclude'] List of namespace numbers to exclude from the selector
  22          */
  23         public function __construct( array $config = [] ) {
  24                 // Configuration initialization
  25                 $config['options'] = $this->getNamespaceDropdownOptions( $config );
  26
  27                 parent::__construct( $config );
  28
  29                 // Properties
  30                 $this->includeAllValue = $config['includeAllValue'] ?? null;
  31                 $this->exclude = $config['exclude'] ?? [];
  32
  33                 // Initialization
  34                 $this->addClasses( [ 'mw-widget-namespaceInputWidget' ] );
  35         }
  36
  37         protected function getNamespaceDropdownOptions( array $config ) {
  38                 $namespaceOptionsParams = [
  39                         'all' => $config['includeAllValue'] ?? null,
  40                         'exclude' => $config['exclude'] ?? null
  41                 ];
  42                 $namespaceOptions = \Html::namespaceSelectorOptions( $namespaceOptionsParams );
  43
  44                 $options = [];
  45                 foreach ( $namespaceOptions as $id => $name ) {
  46                         $options[] = [
  47                                 'data' => (string)$id,
  48                                 'label' => $name,
  49                         ];
  50                 }
  51
  52                 return $options;
  53         }
  54
  55         protected function getJavaScriptClassName() {
  56                 return 'mw.widgets.NamespaceInputWidget';
  57         }
  58
  59         public function getConfig( &$config ) {
  60                 $config['includeAllValue'] = $this->includeAllValue;
  61                 $config['exclude'] = $this->exclude;
  62                 // Skip DropdownInputWidget's getConfig(), we don't need 'options' config
  63                 $config['dropdown']['$overlay'] = true;
  64                 return \OOUI\InputWidget::getConfig( $config );
  65         }
  66 }