HTMLCheckField.php

Go to the documentation of this file.

<?php

class HTMLCheckField extends HTMLFormField {
    function getInputHTML( $value ) {
        if ( !empty( $this->mParams['invert'] ) ) {
            $value = !$value;
        }

        $attr = $this->getTooltipAndAccessKey();
        $attr['id'] = $this->mID;

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

        if ( $this->mClass !== '' ) {
            $attr['class'] = $this->mClass;
        }

        if ( $this->mParent->isVForm() ) {
            // Nest checkbox inside label.
            return Html::rawElement( 'label',
                array(
                    'class' => 'mw-ui-checkbox-label'
                ),
                Xml::check( $this->mName, $value, $attr ) . // Html:rawElement doesn't escape contents.
                htmlspecialchars( $this->mLabel ) );
        } else {
            return Xml::check( $this->mName, $value, $attr )
            . '&#160;'
            . Html::rawElement( 'label', array( 'for' => $this->mID ), $this->mLabel );
        }
    }

    function getLabel() {
        return '&#160;';
    }

    protected function needsLabel() {
        return false;
    }

    function loadDataFromRequest( $request ) {
        $invert = false;
        if ( isset( $this->mParams['invert'] ) && $this->mParams['invert'] ) {
            $invert = true;
        }

        // GetCheck won't work like we want for checks.
        // Fetch the value in either one of the two following case:
        // - we have a valid token (form got posted or GET forged by the user)
        // - checkbox name has a value (false or true), ie is not null
        if ( $request->getCheck( 'wpEditToken' ) || $request->getVal( $this->mName ) !== null ) {
            // XOR has the following truth table, which is what we want
            // INVERT VALUE | OUTPUT
            // true   true  | false
            // false  true  | true
            // false  false | false
            // true   false | true
            return $request->getBool( $this->mName ) xor $invert;
        } else {
            return $this->getDefault();
        }
    }
}