CheckMatrixWidget.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Widget;
 
use OOUI\CheckboxInputWidget;
use OOUI\FieldLayout;
use OOUI\HtmlSnippet;
use OOUI\Tag;
use OOUI\Widget;
 
class CheckMatrixWidget extends Widget {
    protected $name;
    protected $id;
    protected $columns;
    protected $rows;
    protected $tooltips;
    protected $tooltipsHtml;
    protected $values;
    protected $forcedOn;
    protected $forcedOff;
 
    public function __construct( array $config = [] ) {
        // Configuration initialization
 
        parent::__construct( $config );
 
        $this->name = $config['name'] ?? null;
        $this->id = $config['id'] ?? null;
 
        // Properties
        $this->rows = $config['rows'] ?? [];
        $this->columns = $config['columns'] ?? [];
        $this->tooltips = $config['tooltips'] ?? [];
        $this->tooltipsHtml = $config['tooltips-html'] ?? [];
 
        $this->values = $config['values'] ?? [];
 
        $this->forcedOn = $config['forcedOn'] ?? [];
        $this->forcedOff = $config['forcedOff'] ?? [];
 
        // Build the table
        $table = new Tag( 'table' );
        $table->addClasses( [ 'mw-htmlform-matrix mw-widget-checkMatrixWidget-matrix' ] );
        $thead = new Tag( 'thead' );
        $table->appendContent( $thead );
        $tr = new Tag( 'tr' );
 
        // Build the header
        $tr->appendContent( $this->getCellTag( "\u{00A0}" ) );
        foreach ( $this->columns as $columnLabel => $columnTag ) {
            $tr->appendContent(
                $this->getCellTag( new HtmlSnippet( $columnLabel ), 'th' )
            );
        }
        $thead->appendContent( $tr );
 
        // Build the options matrix
        $tbody = new Tag( 'tbody' );
        $table->appendContent( $tbody );
        foreach ( $this->rows as $rowLabel => $rowTag ) {
            $tbody->appendContent(
                $this->getTableRow( $rowLabel, $rowTag )
            );
        }
 
        // Initialization
        $this->addClasses( [ 'mw-widget-checkMatrixWidget' ] );
        $this->appendContent( $table );
    }
 
    private function getTableRow( $label, $tag ) {
        $row = new Tag( 'tr' );
        $tooltip = $this->getTooltip( $label );
        $labelFieldConfig = $tooltip ? [ 'help' => $tooltip ] : [];
        // Build label cell
        $labelField = new FieldLayout(
            new Widget(), // Empty widget, since we don't have the checkboxes here
            [
                'label' => new HtmlSnippet( $label ),
                'align' => 'inline',
            ] + $labelFieldConfig
        );
        $row->appendContent( $this->getCellTag( $labelField ) );
 
        // Build checkbox column cells
        foreach ( $this->columns as $columnTag ) {
            $thisTag = "$columnTag-$tag";
 
            // Construct a checkbox
            $checkbox = new CheckboxInputWidget( [
                'value' => $thisTag,
                'name' => $this->name ? "{$this->name}[]" : null,
                'id' => $this->id ? "{$this->id}-$thisTag" : null,
                'selected' => $this->isTagChecked( $thisTag ),
                'disabled' => $this->isTagDisabled( $thisTag ),
            ] );
 
            $row->appendContent( $this->getCellTag( $checkbox ) );
        }
        return $row;
    }
 
    private function getCellTag( $content, $tagElement = 'td' ) {
        $cell = new Tag( $tagElement );
        $cell->appendContent( $content );
        return $cell;
    }
 
    private function isTagChecked( $tagName ) {
        // If the tag is in the value list
        return in_array( $tagName, (array)$this->values, true ) ||
            // Or if the tag is forced on
            in_array( $tagName, (array)$this->forcedOn, true );
    }
 
    private function isTagDisabled( $tagName ) {
        return (
            // If the entire widget is disabled
            $this->isDisabled() ||
            // If the tag is 'forced on' or 'forced off'
            in_array( $tagName, (array)$this->forcedOn, true ) ||
            in_array( $tagName, (array)$this->forcedOff, true )
        );
    }
 
    private function getTooltip( $label ) {
        if ( isset( $this->tooltipsHtml[ $label ] ) ) {
            return new HtmlSnippet( $this->tooltipsHtml[ $label ] );
        } else {
            return $this->tooltips[ $label ] ?? null;
        }
    }
 
    protected function getJavaScriptClassName() {
        return 'mw.widgets.CheckMatrixWidget';
    }
 
    public function getConfig( &$config ) {
        $config += [
            'name' => $this->name,
            'id' => $this->id,
            'rows' => $this->rows,
            'columns' => $this->columns,
            'tooltips' => $this->tooltips,
            'tooltipsHtml' => $this->tooltipsHtml,
            'forcedOff' => $this->forcedOff,
            'forcedOn' => $this->forcedOn,
            'values' => $this->values,
        ];
        return parent::getConfig( $config );
    }
}