bbc74d93b0
This patch refactors various widget classes in the includes/widget directory to use cleaner namespacing. The patches remove redundant backslash prefixes in class extending statements and add use statements for OOUI classes and other MediaWiki-specific classes. This patch improves readability and maintainability of the code by following the MediaWiki coding conventions and leverages the benefits of PHP's namespacing system. List of affected classes: - CheckMatrixWidget - DateInputWidget - DateTimeInputWidget - NamespaceInputWidget - SearchInputWidget - SelectWithInputWidget - SizeFilterWidget - SpinnerWidget - TagMultiselectWidget - TitleInputWidget - UserInputWidget Additionally, the code now correctly documents exceptions thrown by constructors where missing, enforcing clearer developer expectations. Change-Id: I0fdaf68a412a1c3b7049a79222f4dbeaa95a6bbc
76 lines
2.2 KiB
PHP
76 lines
2.2 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Widget;
|
|
|
|
use MediaWiki\Html\Html;
|
|
use OOUI\DropdownInputWidget;
|
|
use OOUI\InputWidget;
|
|
|
|
/**
|
|
* 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 DropdownInputWidget {
|
|
/** @var string */
|
|
protected $includeAllValue;
|
|
/** @var bool */
|
|
protected $userLang;
|
|
/** @var int[] */
|
|
protected $exclude;
|
|
|
|
/**
|
|
* @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
|
|
* - bool $config['userLang'] Display namespaces in user language
|
|
* - 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 = $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 );
|
|
}
|
|
}
|