MediaWiki master
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...

Inherits Widget.

Inherited by MediaWiki\Widget\MenuTagMultiselectWidget, MediaWiki\Widget\NamespacesMultiselectWidget, MediaWiki\Widget\OrderedMultiselectWidget, MediaWiki\Widget\TitlesMultiselectWidget, and MediaWiki\Widget\UsersMultiselectWidget.

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

Public Member Functions

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

Protected Member Functions

 getJavaScriptClassName ()
 
 getNoJavaScriptFallback ()
 Provide the implementation for clients with JavaScript disabled.
 

Protected Attributes

bool $allowArbitrary
 
string[] null $allowedValues
 
bool $allowReordering
 
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 16 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.
  • bool $config['allowReordering'] Allow reordering of the items
  • array $config['allowedValues'] Allowed items

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

Definition at line 45 of file TagMultiselectWidget.php.

References MediaWiki\Widget\TagMultiselectWidget\getNoJavaScriptFallback().

Member Function Documentation

◆ getConfig()

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

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

Definition at line 68 of file TagMultiselectWidget.php.

References MediaWiki\Widget\TagMultiselectWidget\$allowArbitrary, MediaWiki\Widget\TagMultiselectWidget\$allowedValues, MediaWiki\Widget\TagMultiselectWidget\$allowReordering, 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\MenuTagMultiselectWidget, MediaWiki\Widget\NamespacesMultiselectWidget, MediaWiki\Widget\OrderedMultiselectWidget, MediaWiki\Widget\TitlesMultiselectWidget, and MediaWiki\Widget\UsersMultiselectWidget.

Definition at line 115 of file TagMultiselectWidget.php.

◆ getNoJavaScriptFallback()

MediaWiki\Widget\TagMultiselectWidget::getNoJavaScriptFallback ( )
protected

Provide the implementation for clients with JavaScript disabled.

Stability: stable
to override
Since
1.44
Returns
Widget[]

Reimplemented in MediaWiki\Widget\MenuTagMultiselectWidget.

Definition at line 105 of file TagMultiselectWidget.php.

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

Member Data Documentation

◆ $allowArbitrary

bool MediaWiki\Widget\TagMultiselectWidget::$allowArbitrary
protected

Definition at line 28 of file TagMultiselectWidget.php.

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

◆ $allowedValues

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

Definition at line 32 of file TagMultiselectWidget.php.

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

◆ $allowReordering

bool MediaWiki\Widget\TagMultiselectWidget::$allowReordering
protected

Definition at line 30 of file TagMultiselectWidget.php.

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

◆ $input

array MediaWiki\Widget\TagMultiselectWidget::$input
protected

Definition at line 24 of file TagMultiselectWidget.php.

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

◆ $inputName

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

Definition at line 20 of file TagMultiselectWidget.php.

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

◆ $inputPlaceholder

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

Definition at line 22 of file TagMultiselectWidget.php.

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

◆ $selectedArray

array MediaWiki\Widget\TagMultiselectWidget::$selectedArray
protected

Definition at line 18 of file TagMultiselectWidget.php.

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

◆ $tagLimit

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

Definition at line 26 of file TagMultiselectWidget.php.

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

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