MediaWiki
master
Toggle main menu visibility
HTMLToggleSwitchField.php
Go to the documentation of this file.
1
<?php
2
3
namespace
MediaWiki\HTMLForm\Field;
4
5
use MediaWiki\Widget\ToggleSwitchWidget;
6
7
class
HTMLToggleSwitchField
extends
HTMLCheckField
{
8
16
public
function
getInputOOUI
( $value ) {
17
if
( !empty( $this->mParams[
'invert'
] ) ) {
18
$value = !$value;
19
}
20
21
$attr = $this->
getTooltipAndAccessKeyOOUI
();
22
$attr[
'id'
] =
$this->mID
;
23
$attr[
'name'
] =
$this->mName
;
24
25
$attr += \OOUI\Element::configFromHtmlAttributes(
26
$this->
getAttributes
( [
'disabled'
,
'tabindex'
] )
27
);
28
29
if
( $this->mClass !==
''
) {
30
$attr[
'classes'
] = [
$this->mClass
];
31
}
32
33
// For the underlying CheckboxInputWidget
34
$attr[
'selected'
] = $value;
35
$attr[
'value'
] =
'1'
;
36
37
return
new
ToggleSwitchWidget
( $attr );
38
}
39
43
protected
function
shouldInfuseOOUI
() {
44
// Always infuse, as we want a toggle widget when JS is enabled.
45
return
true
;
46
}
47
49
protected
function
getOOUIModules
() {
50
return
[
'mediawiki.widgets.ToggleSwitchWidget'
];
51
}
52
}
53
55
class_alias( HTMLToggleSwitchField::class,
'HTMLToggleSwitchField'
);
MediaWiki\HTMLForm\Field\HTMLCheckField
A checkbox field.
Definition
HTMLCheckField.php:16
MediaWiki\HTMLForm\Field\HTMLToggleSwitchField
Definition
HTMLToggleSwitchField.php:7
MediaWiki\HTMLForm\Field\HTMLToggleSwitchField\shouldInfuseOOUI
shouldInfuseOOUI()
Whether the field should be automatically infused.Note that all OOUI HTMLForm fields are infusable (y...
Definition
HTMLToggleSwitchField.php:43
MediaWiki\HTMLForm\Field\HTMLToggleSwitchField\getOOUIModules
getOOUIModules()
Get the list of extra ResourceLoader modules which must be loaded client-side before it's possible to...
Definition
HTMLToggleSwitchField.php:49
MediaWiki\HTMLForm\Field\HTMLToggleSwitchField\getInputOOUI
getInputOOUI( $value)
Get the OOUI version of this field.
Definition
HTMLToggleSwitchField.php:16
MediaWiki\HTMLForm\HTMLFormField\$mClass
string $mClass
Definition
HTMLFormField.php:45
MediaWiki\HTMLForm\HTMLFormField\getTooltipAndAccessKeyOOUI
getTooltipAndAccessKeyOOUI()
Returns the attributes required for the tooltip and accesskey, for OOUI widgets' config.
Definition
HTMLFormField.php:1367
MediaWiki\HTMLForm\HTMLFormField\$mID
string $mID
Definition
HTMLFormField.php:43
MediaWiki\HTMLForm\HTMLFormField\getAttributes
getAttributes(array $list)
Returns the given attributes from the parameters.
Definition
HTMLFormField.php:1385
MediaWiki\HTMLForm\HTMLFormField\$mName
string $mName
Definition
HTMLFormField.php:37
MediaWiki\Widget\ToggleSwitchWidget
Base class for widgets to warp a checkbox into toggle widget.
Definition
ToggleSwitchWidget.php:13
includes
HTMLForm
Field
HTMLToggleSwitchField.php
Generated on
for MediaWiki by
1.18.0