MediaWiki master
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Widget\ComplexNamespaceInputWidget Class Reference

Namespace input widget. More...

Inherits Widget.

Collaboration diagram for MediaWiki\Widget\ComplexNamespaceInputWidget:
Collaboration graph
[legend]

Public Member Functions

 __construct (array $config=[])
 
 getConfig (&$config)
 

Protected Member Functions

 getJavaScriptClassName ()
 

Protected Attributes

CheckboxInputWidget null $associated = null
 
FieldLayout null $associatedLabel = null
 
array $config
 
CheckboxInputWidget null $invert = null
 
FieldLayout null $invertLabel = null
 
NamespaceInputWidget $namespace
 

Detailed Description

Namespace input widget.

Displays a dropdown box with the choice of available namespaces, plus two checkboxes to include associated namespace or to invert selection.

Note
2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
MIT

Definition at line 17 of file ComplexNamespaceInputWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\ComplexNamespaceInputWidget::__construct ( array $config = [])
Parameters
array$configConfiguration options
  • 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.
  • 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
Exceptions
Exception

Definition at line 51 of file ComplexNamespaceInputWidget.php.

References MediaWiki\Widget\ComplexNamespaceInputWidget\$config.

Member Function Documentation

◆ getConfig()

MediaWiki\Widget\ComplexNamespaceInputWidget::getConfig ( & $config)

Definition at line 110 of file ComplexNamespaceInputWidget.php.

References MediaWiki\Widget\ComplexNamespaceInputWidget\$config.

◆ getJavaScriptClassName()

MediaWiki\Widget\ComplexNamespaceInputWidget::getJavaScriptClassName ( )
protected

Definition at line 106 of file ComplexNamespaceInputWidget.php.

Member Data Documentation

◆ $associated

CheckboxInputWidget null MediaWiki\Widget\ComplexNamespaceInputWidget::$associated = null
protected

Definition at line 24 of file ComplexNamespaceInputWidget.php.

◆ $associatedLabel

FieldLayout null MediaWiki\Widget\ComplexNamespaceInputWidget::$associatedLabel = null
protected

Definition at line 26 of file ComplexNamespaceInputWidget.php.

◆ $config

array MediaWiki\Widget\ComplexNamespaceInputWidget::$config
protected

Definition at line 20 of file ComplexNamespaceInputWidget.php.

Referenced by MediaWiki\Widget\ComplexNamespaceInputWidget\__construct(), and MediaWiki\Widget\ComplexNamespaceInputWidget\getConfig().

◆ $invert

CheckboxInputWidget null MediaWiki\Widget\ComplexNamespaceInputWidget::$invert = null
protected

Definition at line 28 of file ComplexNamespaceInputWidget.php.

◆ $invertLabel

FieldLayout null MediaWiki\Widget\ComplexNamespaceInputWidget::$invertLabel = null
protected

Definition at line 30 of file ComplexNamespaceInputWidget.php.

◆ $namespace

NamespaceInputWidget MediaWiki\Widget\ComplexNamespaceInputWidget::$namespace
protected

Definition at line 22 of file ComplexNamespaceInputWidget.php.

The documentation for this class was generated from the following file: