e8b10f6804
Most notably: The documentation header repeats the file name. This appears to be fully automatically generated, but does not add helpful information. Change-Id: I9edf15dd25ef6cc52fe931fffde69f0bd9042474
64 lines
2 KiB
PHP
64 lines
2 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Widget;
|
|
|
|
/**
|
|
* Namespace input widget. Displays a dropdown box with the choice of available namespaces.
|
|
*
|
|
* @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
|
|
* @license MIT
|
|
*/
|
|
class NamespaceInputWidget extends \OOUI\DropdownInputWidget {
|
|
|
|
protected $includeAllValue = null;
|
|
|
|
/**
|
|
* @param array $config Configuration options
|
|
* - string $config['includeAllValue'] If specified, add a "all namespaces" option to the
|
|
* namespace dropdown, and use this as the input value for it
|
|
* - int[] $config['exclude'] List of namespace numbers to exclude from the selector
|
|
*/
|
|
public function __construct( array $config = [] ) {
|
|
// Configuration initialization
|
|
$config['options'] = $this->getNamespaceDropdownOptions( $config );
|
|
|
|
parent::__construct( $config );
|
|
|
|
// Properties
|
|
$this->includeAllValue = isset( $config['includeAllValue'] ) ? $config['includeAllValue'] : null;
|
|
$this->exclude = isset( $config['exclude'] ) ? $config['exclude'] : [];
|
|
|
|
// Initialization
|
|
$this->addClasses( [ 'mw-widget-namespaceInputWidget' ] );
|
|
}
|
|
|
|
protected function getNamespaceDropdownOptions( array $config ) {
|
|
$namespaceOptionsParams = [
|
|
'all' => isset( $config['includeAllValue'] ) ? $config['includeAllValue'] : null,
|
|
'exclude' => isset( $config['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['exclude'] = $this->exclude;
|
|
// Skip DropdownInputWidget's getConfig(), we don't need 'options' config
|
|
$config['dropdown']['$overlay'] = true;
|
|
return \OOUI\InputWidget::getConfig( $config );
|
|
}
|
|
}
|