1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
<?php
namespace MediaWiki\HTMLForm\Field;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\HTMLForm\VFormHTMLForm;
use MediaWiki\Message\Message;
/**
* Adds a generic button inline to the form. Does not do anything, you must add
* click handling code in JavaScript. Use a HTMLSubmitField if you merely
* wish to add a submit button to a form.
*
* Additional recognized configuration parameters include:
* - flags: OOUI flags for the button, see OOUI\FlaggedElement
* - buttonlabel-message: Message to use for the button display text, instead
* of the value from 'default'. Overrides 'buttonlabel' and 'buttonlabel-raw'.
* - buttonlabel: Text to display for the button display text, instead
* of the value from 'default'. Overrides 'buttonlabel-raw'.
* - buttonlabel-raw: HTMLto display for the button display text, instead
* of the value from 'default'.
* - formnovalidate: Set to true if clicking this button should suppress
* client-side form validation. Used in HTMLFormFieldCloner for add/remove
* buttons.
*
* @stable to extend
* @since 1.22
*/
class HTMLButtonField extends HTMLFormField {
/** @var string */
protected $buttonType = 'button';
/** @var string|null */
protected $buttonLabel = null;
/** @var array Flags to add to OOUI Button widget */
protected $mFlags = [];
/** @var bool */
protected $mFormnovalidate = false;
/**
* @stable to call
* @inheritDoc
*/
public function __construct( $info ) {
$info['nodata'] = true;
$this->setShowEmptyLabel( false );
parent::__construct( $info );
if ( isset( $info['flags'] ) ) {
$this->mFlags = $info['flags'];
}
if ( isset( $info['formnovalidate'] ) ) {
$this->mFormnovalidate = $info['formnovalidate'];
}
# Generate the label from a message, if possible
if ( isset( $info['buttonlabel-message'] ) ) {
$this->buttonLabel = $this->getMessage( $info['buttonlabel-message'] )->parse();
} elseif ( isset( $info['buttonlabel'] ) ) {
if ( $info['buttonlabel'] === ' ' || $info['buttonlabel'] === "\u{00A0}" ) {
// Apparently some things set   directly and in an odd format
$this->buttonLabel = "\u{00A0}";
} else {
$this->buttonLabel = htmlspecialchars( $info['buttonlabel'] );
}
} elseif ( isset( $info['buttonlabel-raw'] ) ) {
$this->buttonLabel = $info['buttonlabel-raw'];
}
}
public function getInputHTML( $value ) {
$flags = '';
$prefix = 'mw-htmlform-';
if ( $this->mParent instanceof VFormHTMLForm ) {
$prefix = 'mw-ui-';
// add mw-ui-button separately, so the descriptor doesn't need to set it
$flags .= ' ' . $prefix . 'button';
}
foreach ( $this->mFlags as $flag ) {
$flags .= ' ' . $prefix . $flag;
}
$attr = [
'class' => 'mw-htmlform-submit ' . $this->mClass . $flags,
'id' => $this->mID,
'type' => $this->buttonType,
'name' => $this->mName,
'value' => $this->getDefault(),
'formnovalidate' => $this->mFormnovalidate,
] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
return Html::rawElement( 'button', $attr,
$this->buttonLabel ?: htmlspecialchars( $this->getDefault() ) );
}
/**
* Get the OOUI widget for this field.
* @stable to override
* @param string $value
* @return \OOUI\ButtonInputWidget
*/
public function getInputOOUI( $value ) {
return new \OOUI\ButtonInputWidget( [
'name' => $this->mName,
'value' => $this->getDefault(),
'label' => $this->buttonLabel
? new \OOUI\HtmlSnippet( $this->buttonLabel )
: $this->getDefault(),
'type' => $this->buttonType,
'classes' => [ 'mw-htmlform-submit', $this->mClass ],
'id' => $this->mID,
'flags' => $this->mFlags,
] + \OOUI\Element::configFromHtmlAttributes(
$this->getAttributes( [ 'disabled', 'tabindex' ] )
) );
}
public function getInputCodex( $value, $hasErrors ) {
$flags = $this->mFlags;
$buttonLabel = $this->buttonLabel ?: htmlspecialchars( $this->getDefault() );
$buttonClasses = [ 'mw-htmlform-submit', 'cdx-button', $this->mClass ];
$buttonAttribs = [
'class' => $buttonClasses,
'id' => $this->mID,
'type' => $this->buttonType,
'name' => $this->mName,
'value' => $this->getDefault(),
'formnovalidate' => $this->mFormnovalidate,
] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
return static::buildCodexComponent(
$flags,
$buttonLabel,
$buttonAttribs
);
}
/**
* Build the markup of the Codex component
*
* @param array $flags The button's flag classes.
* @param string $buttonLabel The button's label attribute.
* @param array $attribs The button's list of attributes.
* @return string Raw HTML.
*/
public static function buildCodexComponent(
$flags,
$buttonLabel,
$attribs
) {
$flagClasses = [];
$flagClassMap = [
'progressive' => 'cdx-button--action-progressive',
'destructive' => 'cdx-button--action-destructive',
'primary' => 'cdx-button--weight-primary',
'quiet' => 'cdx-button--weight-quiet',
];
foreach ( $flags as $flag ) {
if ( isset( $flagClassMap[$flag] ) ) {
$flagClasses[] = $flagClassMap[$flag];
}
}
$buttonClassesAndFlags = array_merge( $attribs[ 'class' ], $flagClasses );
$attribs['class'] = $buttonClassesAndFlags;
$buttonHtml = Html::rawElement(
'button', $attribs, $buttonLabel
);
return $buttonHtml;
}
/**
* @inheritDoc
* @stable to override
*/
protected function needsLabel() {
return false;
}
/**
* Button cannot be invalid
* @stable to override
*
* @param string $value
* @param array $alldata
*
* @return bool|string|Message
*/
public function validate( $value, $alldata ) {
return true;
}
}
/** @deprecated class alias since 1.42 */
class_alias( HTMLButtonField::class, 'HTMLButtonField' );
|
