MediaWiki  1.32.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
MediaWiki\Widget\UsersMultiselectWidget Class Reference

Widget to select multiple users. More...

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

Public Member Functions

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

Protected Member Functions

 getJavaScriptClassName ()
 

Protected Attributes

 $inputName = null
 
 $inputPlaceholder = null
 
 $usersArray = []
 

Detailed Description

Widget to select multiple users.

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

Definition at line 13 of file UsersMultiselectWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\UsersMultiselectWidget::__construct ( array  $config = [])
Parameters
array$configConfiguration options
  • array $config['users'] Array of usernames to use as preset data
  • array $config['placeholder'] Placeholder message for input
  • array $config['name'] Name attribute (used in forms)

Definition at line 25 of file UsersMultiselectWidget.php.

References MediaWiki\$config.

Member Function Documentation

◆ getConfig()

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

Definition at line 51 of file UsersMultiselectWidget.php.

References MediaWiki\$config, MediaWiki\Widget\UsersMultiselectWidget\$inputName, MediaWiki\Widget\UsersMultiselectWidget\$inputPlaceholder, and MediaWiki\Widget\UsersMultiselectWidget\$usersArray.

◆ getJavaScriptClassName()

MediaWiki\Widget\UsersMultiselectWidget::getJavaScriptClassName ( )
protected

Definition at line 47 of file UsersMultiselectWidget.php.

Member Data Documentation

◆ $inputName

MediaWiki\Widget\UsersMultiselectWidget::$inputName = null
protected

Definition at line 16 of file UsersMultiselectWidget.php.

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

◆ $inputPlaceholder

MediaWiki\Widget\UsersMultiselectWidget::$inputPlaceholder = null
protected

Definition at line 17 of file UsersMultiselectWidget.php.

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

◆ $usersArray

MediaWiki\Widget\UsersMultiselectWidget::$usersArray = []
protected

Definition at line 15 of file UsersMultiselectWidget.php.

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

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