HTMLCheckMatrix.php

Go to the documentation of this file.

<?php

class HTMLCheckMatrix extends HTMLFormField implements HTMLNestedFilterable {
    static private $requiredParams = array(
        // Required by underlying HTMLFormField
        'fieldname',
        // Required by HTMLCheckMatrix
        'rows',
        'columns'
    );

    public function __construct( $params ) {
        $missing = array_diff( self::$requiredParams, array_keys( $params ) );
        if ( $missing ) {
            throw new HTMLFormFieldRequiredOptionsException( $this, $missing );
        }
        parent::__construct( $params );
    }

    function validate( $value, $alldata ) {
        $rows = $this->mParams['rows'];
        $columns = $this->mParams['columns'];

        // Make sure user-defined validation callback is run
        $p = parent::validate( $value, $alldata );
        if ( $p !== true ) {
            return $p;
        }

        // Make sure submitted value is an array
        if ( !is_array( $value ) ) {
            return false;
        }

        // If all options are valid, array_intersect of the valid options
        // and the provided options will return the provided options.
        $validOptions = array();
        foreach ( $rows as $rowTag ) {
            foreach ( $columns as $columnTag ) {
                $validOptions[] = $columnTag . '-' . $rowTag;
            }
        }
        $validValues = array_intersect( $value, $validOptions );
        if ( count( $validValues ) == count( $value ) ) {
            return true;
        } else {
            return $this->msg( 'htmlform-select-badoption' )->parse();
        }
    }

    function getInputHTML( $value ) {
        $html = '';
        $tableContents = '';
        $rows = $this->mParams['rows'];
        $columns = $this->mParams['columns'];

        $attribs = $this->getAttributes( array( 'disabled', 'tabindex' ) );

        // Build the column headers
        $headerContents = Html::rawElement( 'td', array(), '&#160;' );
        foreach ( $columns as $columnLabel => $columnTag ) {
            $headerContents .= Html::rawElement( 'td', array(), $columnLabel );
        }
        $tableContents .= Html::rawElement( 'tr', array(), "\n$headerContents\n" );

        $tooltipClass = 'mw-icon-question';
        if ( isset( $this->mParams['tooltip-class'] ) ) {
            $tooltipClass = $this->mParams['tooltip-class'];
        }

        // Build the options matrix
        foreach ( $rows as $rowLabel => $rowTag ) {
            // Append tooltip if configured
            if ( isset( $this->mParams['tooltips'][$rowLabel] ) ) {
                $tooltipAttribs = array(
                    'class' => "mw-htmlform-tooltip $tooltipClass",
                    'title' => $this->mParams['tooltips'][$rowLabel],
                );
                $rowLabel .= ' ' . Html::element( 'span', $tooltipAttribs, '' );
            }
            $rowContents = Html::rawElement( 'td', array(), $rowLabel );
            foreach ( $columns as $columnTag ) {
                $thisTag = "$columnTag-$rowTag";
                // Construct the checkbox
                $thisId = "{$this->mID}-$thisTag";
                $thisAttribs = array(
                    'id' => $thisId,
                    'value' => $thisTag,
                );
                $checked = in_array( $thisTag, (array)$value, true );
                if ( $this->isTagForcedOff( $thisTag ) ) {
                    $checked = false;
                    $thisAttribs['disabled'] = 1;
                } elseif ( $this->isTagForcedOn( $thisTag ) ) {
                    $checked = true;
                    $thisAttribs['disabled'] = 1;
                }
                $chkBox = Xml::check( "{$this->mName}[]", $checked, $attribs + $thisAttribs );
                if ( $this->mParent->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
                    $chkBox = Html::openElement( 'div', array( 'class' => 'mw-ui-checkbox' ) ) .
                        $chkBox .
                        Html::element( 'label', array( 'for' => $thisId ) ) .
                        Html::closeElement( 'div' );
                }
                $rowContents .= Html::rawElement(
                    'td',
                    array(),
                    $chkBox
                );
            }
            $tableContents .= Html::rawElement( 'tr', array(), "\n$rowContents\n" );
        }

        // Put it all in a table
        $html .= Html::rawElement( 'table',
                array( 'class' => 'mw-htmlform-matrix' ),
                Html::rawElement( 'tbody', array(), "\n$tableContents\n" ) ) . "\n";

        return $html;
    }

    protected function isTagForcedOff( $tag ) {
        return isset( $this->mParams['force-options-off'] )
            && in_array( $tag, $this->mParams['force-options-off'] );
    }

    protected function isTagForcedOn( $tag ) {
        return isset( $this->mParams['force-options-on'] )
            && in_array( $tag, $this->mParams['force-options-on'] );
    }

    function getTableRow( $value ) {
        list( $errors, $errorClass ) = $this->getErrorsAndErrorClass( $value );
        $inputHtml = $this->getInputHTML( $value );
        $fieldType = get_class( $this );
        $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
        $cellAttributes = array( 'colspan' => 2 );

        $label = $this->getLabelHtml( $cellAttributes );

        $field = Html::rawElement(
            'td',
            array( 'class' => 'mw-input' ) + $cellAttributes,
            $inputHtml . "\n$errors"
        );

        $html = Html::rawElement( 'tr', array( 'class' => 'mw-htmlform-vertical-label' ), $label );
        $html .= Html::rawElement( 'tr',
            array( 'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass" ),
            $field );

        return $html . $helptext;
    }

    function loadDataFromRequest( $request ) {
        if ( $this->mParent->getMethod() == 'post' ) {
            if ( $request->wasPosted() ) {
                // Checkboxes are not added to the request arrays if they're not checked,
                // so it's perfectly possible for there not to be an entry at all
                return $request->getArray( $this->mName, array() );
            } else {
                // That's ok, the user has not yet submitted the form, so show the defaults
                return $this->getDefault();
            }
        } else {
            // This is the impossible case: if we look at $_GET and see no data for our
            // field, is it because the user has not yet submitted the form, or that they
            // have submitted it with all the options unchecked. We will have to assume the
            // latter, which basically means that you can't specify 'positive' defaults
            // for GET forms.
            return $request->getArray( $this->mName, array() );
        }
    }

    function getDefault() {
        if ( isset( $this->mDefault ) ) {
            return $this->mDefault;
        } else {
            return array();
        }
    }

    function filterDataForSubmit( $data ) {
        $columns = HTMLFormField::flattenOptions( $this->mParams['columns'] );
        $rows = HTMLFormField::flattenOptions( $this->mParams['rows'] );
        $res = array();
        foreach ( $columns as $column ) {
            foreach ( $rows as $row ) {
                // Make sure option hasn't been forced
                $thisTag = "$column-$row";
                if ( $this->isTagForcedOff( $thisTag ) ) {
                    $res[$thisTag] = false;
                } elseif ( $this->isTagForcedOn( $thisTag ) ) {
                    $res[$thisTag] = true;
                } else {
                    $res[$thisTag] = in_array( $thisTag, $data );
                }
            }
        }

        return $res;
    }
}