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

Check matrix widget. More...

Inherits Widget.

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

Public Member Functions

 __construct (array $config=[])
 Operates similarly to MultiSelectWidget, but instead of using an array of options, uses an array of rows and an array of columns to dynamically construct a matrix of options.
 
 getConfig (&$config)
 

Protected Member Functions

 getJavaScriptClassName ()
 

Protected Attributes

array $columns
 
array $forcedOff
 
array $forcedOn
 
string null $id
 
string null $name
 
array $rows
 
array $tooltips
 
array $tooltipsHtml
 
array $values
 

Detailed Description

Check matrix widget.

Displays a matrix of checkboxes for given options

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

Definition at line 17 of file CheckMatrixWidget.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Widget\CheckMatrixWidget::__construct ( array $config = [])

Operates similarly to MultiSelectWidget, but instead of using an array of options, uses an array of rows and an array of columns to dynamically construct a matrix of options.

The tags used to identify a particular cell are of the form "columnName-rowName"

Parameters
array$configConfiguration array with the following options:
  • columns
    • Required associative array mapping column labels (as HTML) to their tags.
  • rows
    • Required associative array mapping row labels (as HTML) to their tags.
  • force-options-on
    • Array of column-row tags to be displayed as enabled but unavailable to change.
  • force-options-off
    • Array of column-row tags to be displayed as disabled but unavailable to change.
  • tooltips
    • Optional associative array mapping row labels to tooltips (as text, will be escaped).
  • tooltips-html
    • Optional associative array mapping row labels to tooltips (as HTML). Takes precedence over text tooltips.

Definition at line 58 of file CheckMatrixWidget.php.

Member Function Documentation

◆ getConfig()

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

Definition at line 213 of file CheckMatrixWidget.php.

References MediaWiki\Widget\CheckMatrixWidget\$columns, MediaWiki\Widget\CheckMatrixWidget\$forcedOff, MediaWiki\Widget\CheckMatrixWidget\$forcedOn, MediaWiki\Widget\CheckMatrixWidget\$id, MediaWiki\Widget\CheckMatrixWidget\$name, MediaWiki\Widget\CheckMatrixWidget\$rows, MediaWiki\Widget\CheckMatrixWidget\$tooltips, MediaWiki\Widget\CheckMatrixWidget\$tooltipsHtml, and MediaWiki\Widget\CheckMatrixWidget\$values.

◆ getJavaScriptClassName()

MediaWiki\Widget\CheckMatrixWidget::getJavaScriptClassName ( )
protected

Definition at line 208 of file CheckMatrixWidget.php.

Member Data Documentation

◆ $columns

array MediaWiki\Widget\CheckMatrixWidget::$columns
protected

Definition at line 23 of file CheckMatrixWidget.php.

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

◆ $forcedOff

array MediaWiki\Widget\CheckMatrixWidget::$forcedOff
protected

Definition at line 35 of file CheckMatrixWidget.php.

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

◆ $forcedOn

array MediaWiki\Widget\CheckMatrixWidget::$forcedOn
protected

Definition at line 33 of file CheckMatrixWidget.php.

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

◆ $id

string null MediaWiki\Widget\CheckMatrixWidget::$id
protected

Definition at line 21 of file CheckMatrixWidget.php.

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

◆ $name

string null MediaWiki\Widget\CheckMatrixWidget::$name
protected

Definition at line 19 of file CheckMatrixWidget.php.

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

◆ $rows

array MediaWiki\Widget\CheckMatrixWidget::$rows
protected

Definition at line 25 of file CheckMatrixWidget.php.

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

◆ $tooltips

array MediaWiki\Widget\CheckMatrixWidget::$tooltips
protected

Definition at line 27 of file CheckMatrixWidget.php.

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

◆ $tooltipsHtml

array MediaWiki\Widget\CheckMatrixWidget::$tooltipsHtml
protected

Definition at line 29 of file CheckMatrixWidget.php.

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

◆ $values

array MediaWiki\Widget\CheckMatrixWidget::$values
protected

Definition at line 31 of file CheckMatrixWidget.php.

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

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