NamespaceInputWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Widget;
 
use MediaWiki\Html\Html;
use OOUI\DropdownInputWidget;
use OOUI\InputWidget;
 
class NamespaceInputWidget extends DropdownInputWidget {
    protected $includeAllValue;
    protected $userLang;
    protected $exclude;
 
    public function __construct( array $config = [] ) {
        // Configuration initialization
        $config['options'] = $this->getNamespaceDropdownOptions( $config );
 
        parent::__construct( $config );
 
        // Properties
        $this->includeAllValue = $config['includeAllValue'] ?? null;
        $this->userLang = $config['userLang'] ?? false;
        $this->exclude = $config['exclude'] ?? [];
 
        // Initialization
        $this->addClasses( [ 'mw-widget-namespaceInputWidget' ] );
    }
 
    protected function getNamespaceDropdownOptions( array $config ) {
        $namespaceOptionsParams = [
            'all' => $config['includeAllValue'] ?? null,
            'in-user-lang' => $config['userLang'] ?? false,
            'exclude' => $config['exclude'] ?? null
        ];
        $namespaceOptions = Html::namespaceSelectorOptions( $namespaceOptionsParams );
 
        $options = [];
        foreach ( $namespaceOptions as $id => $name ) {
            $options[] = [
                'data' => (string)$id,
                'label' => $name,
            ];
        }
 
        return $options;
    }
 
    protected function getJavaScriptClassName() {
        return 'mw.widgets.NamespaceInputWidget';
    }
 
    public function getConfig( &$config ) {
        $config['includeAllValue'] = $this->includeAllValue;
        $config['userLang'] = $this->userLang;
        $config['exclude'] = $this->exclude;
        // Skip DropdownInputWidget's getConfig(), we don't need 'options' config
        $config['dropdown']['$overlay'] = true;
        return InputWidget::getConfig( $config );
    }
}