MediaWiki  master
HTMLCheckField.php
Go to the documentation of this file.
1 <?php
2 
7  public function getInputHTML( $value ) {
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  "\u{00A0}" .
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 
50  public function getInputOOUI( $value ) {
51  if ( !empty( $this->mParams['invert'] ) ) {
52  $value = !$value;
53  }
54 
55  $attr = $this->getTooltipAndAccessKeyOOUI();
56  $attr['id'] = $this->mID;
57  $attr['name'] = $this->mName;
58 
59  $attr += OOUI\Element::configFromHtmlAttributes(
60  $this->getAttributes( [ 'disabled', 'tabindex' ] )
61  );
62 
63  if ( $this->mClass !== '' ) {
64  $attr['classes'] = [ $this->mClass ];
65  }
66 
67  $attr['selected'] = $value;
68  $attr['value'] = '1'; // Nasty hack, but needed to make this work
69 
70  return new OOUI\CheckboxInputWidget( $attr );
71  }
72 
82  public function getLabel() {
83  if ( $this->mParent instanceof OOUIHTMLForm ) {
84  return $this->mLabel;
85  } elseif (
86  $this->mParent instanceof HTMLForm &&
87  $this->mParent->getDisplayFormat() === 'div'
88  ) {
89  return '';
90  } else {
91  return "\u{00A0}";
92  }
93  }
94 
99  protected function getLabelAlignOOUI() {
100  return 'inline';
101  }
102 
107  protected function needsLabel() {
108  return false;
109  }
110 
116  public function loadDataFromRequest( $request ) {
117  $invert = isset( $this->mParams['invert'] ) && $this->mParams['invert'];
118 
119  // Fetch the value in either one of the two following case:
120  // - we have a valid submit attempt (form was just submitted)
121  // - we have a value (an URL manually built by the user, or GET form with no wpFormIdentifier)
122  if ( $this->isSubmitAttempt( $request ) || $request->getCheck( $this->mName ) ) {
123  return $invert
124  ? !$request->getBool( $this->mName )
125  : $request->getBool( $this->mName );
126  } else {
127  return (bool)$this->getDefault();
128  }
129  }
130 }
getLabelAlignOOUI()
Get label alignment when generating field for OOUI.
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
getTooltipAndAccessKey()
Returns the attributes required for the tooltip and accesskey, for Html::element() etc...
getTooltipAndAccessKeyOOUI()
Returns the attributes required for the tooltip and accesskey, for OOUI widgets&#39; config.
$wgUseMediaWikiUIEverywhere
Temporary variable that applies MediaWiki UI wherever it can be supported.
getInputOOUI( $value)
Get the OOUI version of this field.
A checkbox field.
getInputHTML( $value)
getLabel()
For a checkbox, the label goes on the right hand side, and is added in getInputHTML(), rather than HTMLFormField::getRow()
Compact stacked vertical format for forms.
loadDataFromRequest( $request)
Compact stacked vertical format for forms, implemented using OOUI widgets.
needsLabel()
checkboxes don&#39;t need a label.
isSubmitAttempt(WebRequest $request)
Can we assume that the request is an attempt to submit a HTMLForm, as opposed to an attempt to just v...
getAttributes(array $list)
Returns the given attributes from the parameters.
static check( $name, $checked=false, $attribs=[])
Convenience function to build an HTML checkbox.
Definition: Xml.php:323