includes/htmlform/HTMLCheckField.php

   1 <?php
   2
   3 /**
   4  * A checkbox field
   5  */
   6 class HTMLCheckField extends HTMLFormField {
   7         function getInputHTML( $value ) {
   8                 global $wgUseMediaWikiUIEverywhere;
   9
  10                 if ( !empty( $this->mParams['invert'] ) ) {
  11                         $value = !$value;
  12                 }
  13
  14                 $attr = $this->getTooltipAndAccessKey();
  15                 $attr['id'] = $this->mID;
  16
  17                 $attr += $this->getAttributes( [ 'disabled', 'tabindex' ] );
  18
  19                 if ( $this->mClass !== '' ) {
  20                         $attr['class'] = $this->mClass;
  21                 }
  22
  23                 $attrLabel = [ 'for' => $this->mID ];
  24                 if ( isset( $attr['title'] ) ) {
  25                         // propagate tooltip to label
  26                         $attrLabel['title'] = $attr['title'];
  27                 }
  28
  29                 $chkLabel = Xml::check( $this->mName, $value, $attr ) .
  30                         '&#160;' .
  31                         Html::rawElement( 'label', $attrLabel, $this->mLabel );
  32
  33                 if ( $wgUseMediaWikiUIEverywhere || $this->mParent instanceof VFormHTMLForm ) {
  34                         $chkLabel = Html::rawElement(
  35                                 'div',
  36                                 [ 'class' => 'mw-ui-checkbox' ],
  37                                 $chkLabel
  38                         );
  39                 }
  40
  41                 return $chkLabel;
  42         }
  43
  44         /**
  45          * Get the OOUI version of this field.
  46          * @since 1.26
  47          * @param string $value
  48          * @return OOUI\CheckboxInputWidget The checkbox widget.
  49          */
  50         public function getInputOOUI( $value ) {
  51                 if ( !empty( $this->mParams['invert'] ) ) {
  52                         $value = !$value;
  53                 }
  54
  55                 $attr = $this->getTooltipAndAccessKey();
  56                 $attr['id'] = $this->mID;
  57                 $attr['name'] = $this->mName;
  58
  59                 $attr += $this->getAttributes(
  60                         [ 'disabled', 'tabindex' ],
  61                         [ 'tabindex' => 'tabIndex' ]
  62                 );
  63
  64                 if ( $this->mClass !== '' ) {
  65                         $attr['classes'] = [ $this->mClass ];
  66                 }
  67
  68                 $attr['selected'] = $value;
  69                 $attr['value'] = '1'; // Nasty hack, but needed to make this work
  70
  71                 return new OOUI\CheckboxInputWidget( $attr );
  72         }
  73
  74         /**
  75          * For a checkbox, the label goes on the right hand side, and is
  76          * added in getInputHTML(), rather than HTMLFormField::getRow()
  77          *
  78          * ...unless OOUI is being used, in which case we actually return
  79          * the label here.
  80          *
  81          * @return string
  82          */
  83         function getLabel() {
  84                 if ( $this->mParent instanceof OOUIHTMLForm ) {
  85                         return $this->mLabel;
  86                 } elseif (
  87                         $this->mParent instanceof HTMLForm &&
  88                         $this->mParent->getDisplayFormat() === 'div'
  89                 ) {
  90                         return '';
  91                 } else {
  92                         return '&#160;';
  93                 }
  94         }
  95
  96         /**
  97          * Get label alignment when generating field for OOUI.
  98          * @return string 'left', 'right', 'top' or 'inline'
  99          */
 100         protected function getLabelAlignOOUI() {
 101                 return 'inline';
 102         }
 103
 104         /**
 105          * checkboxes don't need a label.
 106          * @return bool
 107          */
 108         protected function needsLabel() {
 109                 return false;
 110         }
 111
 112         /**
 113          * @param WebRequest $request
 114          *
 115          * @return string
 116          */
 117         function loadDataFromRequest( $request ) {
 118                 $invert = isset( $this->mParams['invert'] ) && $this->mParams['invert'];
 119
 120                 // GetCheck won't work like we want for checks.
 121                 // Fetch the value in either one of the two following case:
 122                 // - we have a valid token (form got posted or GET forged by the user)
 123                 // - checkbox name has a value (false or true), ie is not null
 124                 if ( $request->getCheck( 'wpEditToken' ) || $request->getVal( $this->mName ) !== null ) {
 125                         return $invert
 126                                 ? !$request->getBool( $this->mName )
 127                                 : $request->getBool( $this->mName );
 128                 } else {
 129                         return $this->getDefault();
 130                 }
 131         }
 132 }