Simplify documentation headers of includes/widgets/…Widget.php files

[lhc/web/wiklou.git] / includes / widget / ComplexNamespaceInputWidget.php

diff --git a/includes/widget/ComplexNamespaceInputWidget.php b/includes/widget/ComplexNamespaceInputWidget.php
index 21c5709..5f5d1cd 100644 (file)
--- a/includes/widget/ComplexNamespaceInputWidget.php
+++ b/includes/widget/ComplexNamespaceInputWidget.php
@@ -1,15 +1,13 @@
 <?php
-/**
- * MediaWiki Widgets – ComplexNamespaceInputWidget 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, plus two
  * checkboxes to include associated namespace or to invert selection.
+ *
+ * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
+ * @license MIT
  */
 class ComplexNamespaceInputWidget extends \OOUI\Widget {
 
@@ -22,36 +20,35 @@ class ComplexNamespaceInputWidget extends \OOUI\Widget {
 
        /**
         * @param array $config Configuration options
-        * @param array $config['namespace'] Configuration for the NamespaceInputWidget dropdown with list
-        *     of namespaces
-        * @param string $config['namespace']['includeAllValue'] If specified, add a "all namespaces"
-        *     option to the dropdown, and use this as the input value for it
-        * @param array|null $config['invert'] Configuration for the "invert selection" CheckboxInputWidget. If
-        *     null, the checkbox will not be generated.
-        * @param array|null $config['associated'] Configuration for the "include associated namespace"
+        *   - array $config['namespace'] Configuration for the NamespaceInputWidget
+        *     dropdown with list of namespaces
+        *   - string $config['namespace']['includeAllValue'] If specified,
+        *     add an "all namespaces" option to the dropdown, and use this as the input value for it
+        *   - array|null $config['invert'] Configuration for the "invert selection"
         *     CheckboxInputWidget. If null, the checkbox will not be generated.
-        * @param array $config['invertLabel'] Configuration for the FieldLayout with label wrapping the
-        *     "invert selection" checkbox
-        * @param string $config['invertLabel']['label'] Label text for the label
-        * @param array $config['associatedLabel'] Configuration for the FieldLayout with label wrapping
-        *     the "include associated namespace" checkbox
-        * @param string $config['associatedLabel']['label'] Label text for the label
+        *   - array|null $config['associated'] Configuration for the "include associated namespace"
+        *     CheckboxInputWidget. If null, the checkbox will not be generated.
+        *   - array $config['invertLabel'] Configuration for the FieldLayout with label
+        *     wrapping the "invert selection" checkbox
+        *   - string $config['invertLabel']['label'] Label text for the label
+        *   - array $config['associatedLabel'] Configuration for the FieldLayout with label
+        *     wrapping the "include associated namespace" checkbox
+        *   - string $config['associatedLabel']['label'] Label text for the label
         */
-       public function __construct( array $config = array() ) {
+       public function __construct( array $config = [] ) {
                // Configuration initialization
                $config = array_merge(
-                       array(
+                       [
                                // Config options for nested widgets
-                               'namespace' => array(),
-                               'invert' => array(),
-                               'invertLabel' => array(),
-                               'associated' => array(),
-                               'associatedLabel' => array(),
-                       ),
+                               'namespace' => [],
+                               'invert' => [],
+                               'invertLabel' => [],
+                               'associated' => [],
+                               'associatedLabel' => [],
+                       ],
                        $config
                );
 
-               // Parent constructor
                parent::__construct( $config );
 
                // Properties
@@ -60,28 +57,28 @@ class ComplexNamespaceInputWidget extends \OOUI\Widget {
                $this->namespace = new NamespaceInputWidget( $config['namespace'] );
                if ( $config['associated'] !== null ) {
                        $this->associated = new \OOUI\CheckboxInputWidget( array_merge(
-                               array( 'value' => '1' ),
+                               [ 'value' => '1' ],
                                $config['associated']
                        ) );
                        // TODO Should use a LabelWidget? But they don't work like HTML <label>s yet
                        $this->associatedLabel = new \OOUI\FieldLayout(
                                $this->associated,
                                array_merge(
-                                       array( 'align' => 'inline' ),
+                                       [ 'align' => 'inline' ],
                                        $config['associatedLabel']
                                )
                        );
                }
                if ( $config['invert'] !== null ) {
                        $this->invert = new \OOUI\CheckboxInputWidget( array_merge(
-                               array( 'value' => '1' ),
+                               [ 'value' => '1' ],
                                $config['invert']
                        ) );
                        // TODO Should use a LabelWidget? But they don't work like HTML <label>s yet
                        $this->invertLabel = new \OOUI\FieldLayout(
                                $this->invert,
                                array_merge(
-                                       array( 'align' => 'inline' ),
+                                       [ 'align' => 'inline' ],
                                        $config['invertLabel']
                                )
                        );
@@ -89,7 +86,7 @@ class ComplexNamespaceInputWidget extends \OOUI\Widget {
 
                // Initialization
                $this
-                       ->addClasses( array( 'mw-widget-complexNamespaceInputWidget' ) )
+                       ->addClasses( [ 'mw-widget-complexNamespaceInputWidget' ] )
                        ->appendContent( $this->namespace, $this->associatedLabel, $this->invertLabel );
        }
 
@@ -102,9 +99,19 @@ class ComplexNamespaceInputWidget extends \OOUI\Widget {
                        $config,
                        array_intersect_key(
                                $this->config,
-                               array_fill_keys( array( 'namespace', 'invert', 'invertLabel', 'associated', 'associatedLabel' ), true )
+                               array_fill_keys(
+                                       [
+                                               'namespace',
+                                               'invert',
+                                               'invertLabel',
+                                               'associated',
+                                               'associatedLabel'
+                                       ],
+                                       true
+                               )
                        )
                );
+               $config['namespace']['dropdown']['$overlay'] = true;
                return parent::getConfig( $config );
        }
 }