summaryrefslogtreecommitdiff
path: root/includes/widget/NamespaceInputWidget.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/widget/NamespaceInputWidget.php')
-rw-r--r--includes/widget/NamespaceInputWidget.php66
1 files changed, 66 insertions, 0 deletions
diff --git a/includes/widget/NamespaceInputWidget.php b/includes/widget/NamespaceInputWidget.php
new file mode 100644
index 00000000..696c8adf
--- /dev/null
+++ b/includes/widget/NamespaceInputWidget.php
@@ -0,0 +1,66 @@
+<?php
+/**
+ * MediaWiki Widgets – NamespaceInputWidget class.
+ *
+ * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
+ * @license The MIT License (MIT); see LICENSE.txt
+ */
+namespace MediaWiki\Widget;
+
+/**
+ * Namespace input widget. Displays a dropdown box with the choice of available namespaces.
+ */
+class NamespaceInputWidget extends \OOUI\DropdownInputWidget {
+
+ protected $includeAllValue = null;
+
+ /**
+ * @param array $config Configuration options
+ * @param string $config['includeAllValue'] If specified, add a "all namespaces" option to the
+ * namespace dropdown, and use this as the input value for it
+ * @param number[] $config['exclude'] List of namespace numbers to exclude from the selector
+ */
+ public function __construct( array $config = array() ) {
+ // Configuration initialization
+ $config['options'] = $this->getNamespaceDropdownOptions( $config );
+
+ // Parent constructor
+ parent::__construct( $config );
+
+ // Properties
+ $this->includeAllValue = isset( $config['includeAllValue'] ) ? $config['includeAllValue'] : null;
+ $this->exclude = isset( $config['exclude'] ) ? $config['exclude'] : array();
+
+ // Initialization
+ $this->addClasses( array( 'mw-widget-namespaceInputWidget' ) );
+ }
+
+ protected function getNamespaceDropdownOptions( array $config ) {
+ $namespaceOptionsParams = array(
+ 'all' => isset( $config['includeAllValue'] ) ? $config['includeAllValue'] : null,
+ 'exclude' => isset( $config['exclude'] ) ? $config['exclude'] : null
+ );
+ $namespaceOptions = \Html::namespaceSelectorOptions( $namespaceOptionsParams );
+
+ $options = array();
+ foreach ( $namespaceOptions as $id => $name ) {
+ $options[] = array(
+ '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
+ return \OOUI\InputWidget::getConfig( $config );
+ }
+}