MediaWiki REL1_39
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Widget\TagMultiselectWidget Class Reference

Base class for widgets to select multiple users, titles, namespaces, etc. More...

Inheritance diagram for MediaWiki\Widget\TagMultiselectWidget:
Inheritance graph
[legend]
Collaboration diagram for MediaWiki\Widget\TagMultiselectWidget:
Collaboration graph
[legend]

Public Member Functions

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

Protected Member Functions

 getJavaScriptClassName ()
 

Protected Attributes

bool $allowArbitrary
 
string[] null $allowedValues
 
array $input
 
string null $inputName
 
string null $inputPlaceholder
 
array $selectedArray
 
int null $tagLimit
 

Detailed Description

Base class for widgets to select multiple users, titles, namespaces, etc.

Note
2017 MediaWiki Widgets Team and others; see AUTHORS.txt
MIT

Definition at line 14 of file TagMultiselectWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\TagMultiselectWidget::__construct ( array $config = [])
Parameters
array$configConfiguration options
  • array $config['default'] Array of items to use as preset data
  • string $config['name'] Name attribute (used in forms)
  • string $config['placeholder'] Placeholder message for input
  • array $config['input'] Config options for the input widget
  • int $config['tagLimit'] Maximum number of selected items
  • bool $config['allowArbitrary'] Allow data items not present in the menu.
  • array $config['allowedValues'] Allowed items

Reimplemented in MediaWiki\Widget\NamespacesMultiselectWidget, MediaWiki\Widget\TitlesMultiselectWidget, and MediaWiki\Widget\UsersMultiselectWidget.

Definition at line 40 of file TagMultiselectWidget.php.

Member Function Documentation

◆ getConfig()

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

Reimplemented in MediaWiki\Widget\NamespacesMultiselectWidget, MediaWiki\Widget\TitlesMultiselectWidget, and MediaWiki\Widget\UsersMultiselectWidget.

Definition at line 67 of file TagMultiselectWidget.php.

References MediaWiki\Widget\TagMultiselectWidget\$allowArbitrary, MediaWiki\Widget\TagMultiselectWidget\$allowedValues, MediaWiki\Widget\TagMultiselectWidget\$input, MediaWiki\Widget\TagMultiselectWidget\$inputName, MediaWiki\Widget\TagMultiselectWidget\$inputPlaceholder, MediaWiki\Widget\TagMultiselectWidget\$selectedArray, and MediaWiki\Widget\TagMultiselectWidget\$tagLimit.

◆ getJavaScriptClassName()

MediaWiki\Widget\TagMultiselectWidget::getJavaScriptClassName ( )
protected

Reimplemented in MediaWiki\Widget\NamespacesMultiselectWidget, MediaWiki\Widget\TitlesMultiselectWidget, and MediaWiki\Widget\UsersMultiselectWidget.

Definition at line 94 of file TagMultiselectWidget.php.

Member Data Documentation

◆ $allowArbitrary

bool MediaWiki\Widget\TagMultiselectWidget::$allowArbitrary
protected

Definition at line 26 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

◆ $allowedValues

string [] null MediaWiki\Widget\TagMultiselectWidget::$allowedValues
protected

Definition at line 28 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

◆ $input

array MediaWiki\Widget\TagMultiselectWidget::$input
protected

Definition at line 22 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

◆ $inputName

string null MediaWiki\Widget\TagMultiselectWidget::$inputName
protected

Definition at line 18 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

◆ $inputPlaceholder

string null MediaWiki\Widget\TagMultiselectWidget::$inputPlaceholder
protected

Definition at line 20 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

◆ $selectedArray

array MediaWiki\Widget\TagMultiselectWidget::$selectedArray
protected

Definition at line 16 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

◆ $tagLimit

int null MediaWiki\Widget\TagMultiselectWidget::$tagLimit
protected

Definition at line 24 of file TagMultiselectWidget.php.

Referenced by MediaWiki\Widget\TagMultiselectWidget\getConfig().

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