includes/widget/ComplexNamespaceInputWidget.php

   1 <?php
   2
   3 namespace MediaWiki\Widget;
   4
   5 /**
   6  * Namespace input widget. Displays a dropdown box with the choice of available namespaces, plus two
   7  * checkboxes to include associated namespace or to invert selection.
   8  *
   9  * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
  10  * @license MIT
  11  */
  12 class ComplexNamespaceInputWidget extends \OOUI\Widget {
  13
  14         protected $config;
  15         protected $namespace;
  16         protected $associated = null;
  17         protected $associatedLabel = null;
  18         protected $invert = null;
  19         protected $invertLabel = null;
  20
  21         /**
  22          * @param array $config Configuration options
  23          *   - array $config['namespace'] Configuration for the NamespaceInputWidget
  24          *     dropdown with list of namespaces
  25          *   - string $config['namespace']['includeAllValue'] If specified,
  26          *     add an "all namespaces" option to the dropdown, and use this as the input value for it
  27          *   - array|null $config['invert'] Configuration for the "invert selection"
  28          *     CheckboxInputWidget. If null, the checkbox will not be generated.
  29          *   - array|null $config['associated'] Configuration for the "include associated namespace"
  30          *     CheckboxInputWidget. If null, the checkbox will not be generated.
  31          *   - array $config['invertLabel'] Configuration for the FieldLayout with label
  32          *     wrapping the "invert selection" checkbox
  33          *   - string $config['invertLabel']['label'] Label text for the label
  34          *   - array $config['associatedLabel'] Configuration for the FieldLayout with label
  35          *     wrapping the "include associated namespace" checkbox
  36          *   - string $config['associatedLabel']['label'] Label text for the label
  37          */
  38         public function __construct( array $config = [] ) {
  39                 // Configuration initialization
  40                 $config = array_merge(
  41                         [
  42                                 // Config options for nested widgets
  43                                 'namespace' => [],
  44                                 'invert' => [],
  45                                 'invertLabel' => [],
  46                                 'associated' => [],
  47                                 'associatedLabel' => [],
  48                         ],
  49                         $config
  50                 );
  51
  52                 parent::__construct( $config );
  53
  54                 // Properties
  55                 $this->config = $config;
  56
  57                 $this->namespace = new NamespaceInputWidget( $config['namespace'] );
  58                 if ( $config['associated'] !== null ) {
  59                         $this->associated = new \OOUI\CheckboxInputWidget( array_merge(
  60                                 [ 'value' => '1' ],
  61                                 $config['associated']
  62                         ) );
  63                         // TODO Should use a LabelWidget? But they don't work like HTML <label>s yet
  64                         $this->associatedLabel = new \OOUI\FieldLayout(
  65                                 $this->associated,
  66                                 array_merge(
  67                                         [ 'align' => 'inline' ],
  68                                         $config['associatedLabel']
  69                                 )
  70                         );
  71                 }
  72                 if ( $config['invert'] !== null ) {
  73                         $this->invert = new \OOUI\CheckboxInputWidget( array_merge(
  74                                 [ 'value' => '1' ],
  75                                 $config['invert']
  76                         ) );
  77                         // TODO Should use a LabelWidget? But they don't work like HTML <label>s yet
  78                         $this->invertLabel = new \OOUI\FieldLayout(
  79                                 $this->invert,
  80                                 array_merge(
  81                                         [ 'align' => 'inline' ],
  82                                         $config['invertLabel']
  83                                 )
  84                         );
  85                 }
  86
  87                 // Initialization
  88                 $this
  89                         ->addClasses( [ 'mw-widget-complexNamespaceInputWidget' ] )
  90                         ->appendContent( $this->namespace, $this->associatedLabel, $this->invertLabel );
  91         }
  92
  93         protected function getJavaScriptClassName() {
  94                 return 'mw.widgets.ComplexNamespaceInputWidget';
  95         }
  96
  97         public function getConfig( &$config ) {
  98                 $config = array_merge(
  99                         $config,
 100                         array_intersect_key(
 101                                 $this->config,
 102                                 array_fill_keys(
 103                                         [
 104                                                 'namespace',
 105                                                 'invert',
 106                                                 'invertLabel',
 107                                                 'associated',
 108                                                 'associatedLabel'
 109                                         ],
 110                                         true
 111                                 )
 112                         )
 113                 );
 114                 $config['namespace']['dropdown']['$overlay'] = true;
 115                 return parent::getConfig( $config );
 116         }
 117 }