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

Namespace input widget. More...

Inherits DropdownInputWidget.

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

Public Member Functions

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

Protected Member Functions

 getJavaScriptClassName ()
 
 getNamespaceDropdownOptions (array $config)
 

Protected Attributes

int[] $exclude
 
int[] null $include
 
string $includeAllValue
 
bool $userLang
 

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 15 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
  • bool $config['userLang'] Display namespaces in user language
  • int[] $config['exclude'] List of namespace numbers to exclude from the selector
  • int[]|null $config['include'] List of namespace numbers to only include in the selector, or null to not apply this filter.

Definition at line 34 of file NamespaceInputWidget.php.

References MediaWiki\Widget\NamespaceInputWidget\getNamespaceDropdownOptions().

Member Function Documentation

◆ getConfig()

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

Definition at line 76 of file NamespaceInputWidget.php.

◆ getJavaScriptClassName()

MediaWiki\Widget\NamespaceInputWidget::getJavaScriptClassName ( )
protected

Definition at line 71 of file NamespaceInputWidget.php.

◆ getNamespaceDropdownOptions()

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

Definition at line 50 of file NamespaceInputWidget.php.

Referenced by MediaWiki\Widget\NamespaceInputWidget\__construct().

Member Data Documentation

◆ $exclude

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

Definition at line 21 of file NamespaceInputWidget.php.

◆ $include

int [] null MediaWiki\Widget\NamespaceInputWidget::$include
protected

Definition at line 23 of file NamespaceInputWidget.php.

◆ $includeAllValue

string MediaWiki\Widget\NamespaceInputWidget::$includeAllValue
protected

Definition at line 17 of file NamespaceInputWidget.php.

◆ $userLang

bool MediaWiki\Widget\NamespaceInputWidget::$userLang
protected

Definition at line 19 of file NamespaceInputWidget.php.

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