HTMLCheckField.php

Go to the documentation of this file.

<?php
 
class HTMLCheckField extends HTMLFormField {
    public function getInputHTML( $value ) {
        global $wgUseMediaWikiUIEverywhere;
 
        if ( !empty( $this->mParams['invert'] ) ) {
            $value = !$value;
        }
 
        $attr = $this->getTooltipAndAccessKey();
        $attr['id'] = $this->mID;
 
        $attr += $this->getAttributes( [ 'disabled', 'tabindex' ] );
 
        if ( $this->mClass !== '' ) {
            $attr['class'] = $this->mClass;
        }
 
        $attrLabel = [ 'for' => $this->mID ];
        if ( isset( $attr['title'] ) ) {
            // propagate tooltip to label
            $attrLabel['title'] = $attr['title'];
        }
 
        $chkLabel = Xml::check( $this->mName, $value, $attr ) .
            '&#160;' .
            Html::rawElement( 'label', $attrLabel, $this->mLabel );
 
        if ( $wgUseMediaWikiUIEverywhere || $this->mParent instanceof VFormHTMLForm ) {
            $chkLabel = Html::rawElement(
                'div',
                [ 'class' => 'mw-ui-checkbox' ],
                $chkLabel
            );
        }
 
        return $chkLabel;
    }
 
    public function getInputOOUI( $value ) {
        if ( !empty( $this->mParams['invert'] ) ) {
            $value = !$value;
        }
 
        $attr = $this->getTooltipAndAccessKeyOOUI();
        $attr['id'] = $this->mID;
        $attr['name'] = $this->mName;
 
        $attr += OOUI\Element::configFromHtmlAttributes(
            $this->getAttributes( [ 'disabled', 'tabindex' ] )
        );
 
        if ( $this->mClass !== '' ) {
            $attr['classes'] = [ $this->mClass ];
        }
 
        $attr['selected'] = $value;
        $attr['value'] = '1'; // Nasty hack, but needed to make this work
 
        return new OOUI\CheckboxInputWidget( $attr );
    }
 
    public function getLabel() {
        if ( $this->mParent instanceof OOUIHTMLForm ) {
            return $this->mLabel;
        } elseif (
            $this->mParent instanceof HTMLForm &&
            $this->mParent->getDisplayFormat() === 'div'
        ) {
            return '';
        } else {
            return '&#160;';
        }
    }
 
    protected function getLabelAlignOOUI() {
        return 'inline';
    }
 
    protected function needsLabel() {
        return false;
    }
 
    public function loadDataFromRequest( $request ) {
        $invert = isset( $this->mParams['invert'] ) && $this->mParams['invert'];
 
        // GetCheck won't work like we want for checks.
        // Fetch the value in either one of the two following case:
        // - we have a valid submit attempt (form was just submitted, or a GET URL forged by the user)
        // - checkbox name has a value (false or true), ie is not null
        if ( $this->isSubmitAttempt( $request ) || $request->getVal( $this->mName ) !== null ) {
            return $invert
                ? !$request->getBool( $this->mName )
                : $request->getBool( $this->mName );
        } else {
            return (bool)$this->getDefault();
        }
    }
}