MediaWiki  master
MediaWiki\Widget\NamespaceInputWidget Class Reference

Namespace input widget. More...

Inheritance diagram for MediaWiki\Widget\NamespaceInputWidget:
Collaboration diagram for MediaWiki\Widget\NamespaceInputWidget:

Public Member Functions

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

Protected Member Functions

 getJavaScriptClassName ()
 
 getNamespaceDropdownOptions (array $config)
 

Protected Attributes

int [] $exclude
 
string $includeAllValue
 

Detailed Description

Namespace input widget.

Displays a dropdown box with the choice of available namespaces.

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

Definition at line 11 of file NamespaceInputWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\NamespaceInputWidget::__construct ( array  $config = [])
Parameters
array$configConfiguration options
  • string $config['includeAllValue'] If specified, add a "all namespaces" option to the namespace dropdown, and use this as the input value for it
  • int[] $config['exclude'] List of namespace numbers to exclude from the selector

Definition at line 23 of file NamespaceInputWidget.php.

References MediaWiki\$config, and MediaWiki\Widget\NamespaceInputWidget\getNamespaceDropdownOptions().

Member Function Documentation

◆ getConfig()

MediaWiki\Widget\NamespaceInputWidget::getConfig ( $config)

◆ getJavaScriptClassName()

MediaWiki\Widget\NamespaceInputWidget::getJavaScriptClassName ( )
protected

Definition at line 55 of file NamespaceInputWidget.php.

◆ getNamespaceDropdownOptions()

MediaWiki\Widget\NamespaceInputWidget::getNamespaceDropdownOptions ( array  $config)
protected

Member Data Documentation

◆ $exclude

int [] MediaWiki\Widget\NamespaceInputWidget::$exclude
protected

◆ $includeAllValue

string MediaWiki\Widget\NamespaceInputWidget::$includeAllValue
protected

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