4 * HTML form generation and submission handling, OOUI style.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
25 * Compact stacked vertical format for forms, implemented using OOUI widgets.
27 class OOUIHTMLForm
extends HTMLForm
{
29 private $oouiWarnings;
31 public function __construct( $descriptor, $context = null, $messagePrefix = '' ) {
32 parent
::__construct( $descriptor, $context, $messagePrefix );
33 $this->getOutput()->enableOOUI();
34 $this->getOutput()->addModuleStyles( 'mediawiki.htmlform.ooui.styles' );
38 * Symbolic display format name.
41 protected $displayFormat = 'ooui';
43 public static function loadInputFromParameters( $fieldname, $descriptor,
44 HTMLForm
$parent = null
46 $field = parent
::loadInputFromParameters( $fieldname, $descriptor, $parent );
47 $field->setShowEmptyLabel( false );
51 public function getButtons() {
54 // IE<8 has bugs with <button>, so we'll need to avoid them.
55 $isBadIE = preg_match( '/MSIE [1-7]\./i', $this->getRequest()->getHeader( 'User-Agent' ) );
57 if ( $this->mShowSubmit
) {
58 $attribs = [ 'infusable' => true ];
60 if ( isset( $this->mSubmitID
) ) {
61 $attribs['id'] = $this->mSubmitID
;
64 if ( isset( $this->mSubmitName
) ) {
65 $attribs['name'] = $this->mSubmitName
;
68 if ( isset( $this->mSubmitTooltip
) ) {
70 'title' => Linker
::titleAttrib( $this->mSubmitTooltip
),
71 'accessKey' => Linker
::accesskey( $this->mSubmitTooltip
),
75 $attribs['classes'] = [ 'mw-htmlform-submit' ];
76 $attribs['type'] = 'submit';
77 $attribs['label'] = $this->getSubmitText();
78 $attribs['value'] = $this->getSubmitText();
79 $attribs['flags'] = $this->mSubmitFlags
;
80 $attribs['useInputTag'] = $isBadIE;
82 $buttons .= new OOUI\
ButtonInputWidget( $attribs );
85 if ( $this->mShowReset
) {
86 $buttons .= new OOUI\
ButtonInputWidget( [
88 'label' => $this->msg( 'htmlform-reset' )->text(),
89 'useInputTag' => $isBadIE,
93 if ( $this->mShowCancel
) {
94 $target = $this->mCancelTarget ?
: Title
::newMainPage();
95 if ( $target instanceof Title
) {
96 $target = $target->getLocalURL();
98 $buttons .= new OOUI\
ButtonWidget( [
99 'label' => $this->msg( 'cancel' )->text(),
104 foreach ( $this->mButtons
as $button ) {
107 if ( $button['attribs'] ) {
108 $attrs +
= $button['attribs'];
111 if ( isset( $button['id'] ) ) {
112 $attrs['id'] = $button['id'];
116 $label = $button['value'];
117 } elseif ( isset( $button['label-message'] ) ) {
118 $label = new OOUI\
HtmlSnippet( $this->getMessage( $button['label-message'] )->parse() );
119 } elseif ( isset( $button['label'] ) ) {
120 $label = $button['label'];
121 } elseif ( isset( $button['label-raw'] ) ) {
122 $label = new OOUI\
HtmlSnippet( $button['label-raw'] );
124 $label = $button['value'];
127 $attrs['classes'] = isset( $attrs['class'] ) ?
(array)$attrs['class'] : [];
129 $buttons .= new OOUI\
ButtonInputWidget( [
131 'name' => $button['name'],
132 'value' => $button['value'],
134 'flags' => $button['flags'],
135 'framed' => $button['framed'],
136 'useInputTag' => $isBadIE,
144 return Html
::rawElement( 'div',
145 [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
148 protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
149 // to get a user visible effect, wrap the fieldset into a framed panel layout
150 $layout = new OOUI\
PanelLayout( [
154 'infusable' => false,
157 $layout->appendContent(
158 new OOUI\
FieldsetLayout( [
160 'infusable' => false,
163 'content' => new OOUI\
HtmlSnippet( $section )
172 * Put a form section together from the individual fields' HTML, merging it and wrapping.
173 * @param OOUI\FieldLayout[] $fieldsHtml
174 * @param string $sectionName
175 * @param bool $anyFieldHasLabel Unused
176 * @return string HTML
178 protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
179 if ( !$fieldsHtml ) {
180 // Do not generate any wrappers for empty sections. Sections may be empty if they only have
181 // subsections, but no fields. A legend will still be added in wrapFieldSetSection().
185 $html = implode( '', $fieldsHtml );
187 if ( $sectionName ) {
188 $html = Html
::rawElement(
190 [ 'id' => Sanitizer
::escapeIdForAttribute( $sectionName ) ],
198 * @param string|array|Status $elements
199 * @param string $elementsType
202 public function getErrorsOrWarnings( $elements, $elementsType ) {
203 if ( $elements === '' ) {
207 if ( !in_array( $elementsType, [ 'error', 'warning' ], true ) ) {
208 throw new DomainException( $elementsType . ' is not a valid type.' );
211 if ( $elements instanceof Status
) {
212 if ( !$elements->isGood() ) {
213 $errors = $elements->getErrorsByType( $elementsType );
214 foreach ( $errors as &$error ) {
215 // Input: [ 'message' => 'foo', 'errors' => [ 'a', 'b', 'c' ] ]
216 // Output: [ 'foo', 'a', 'b', 'c' ]
217 $error = array_merge( [ $error['message'] ], $error['params'] );
220 } elseif ( $elementsType === 'error' ) {
221 if ( is_array( $elements ) ) {
223 } elseif ( is_string( $elements ) ) {
224 $errors = [ $elements ];
228 foreach ( $errors as &$error ) {
229 $error = $this->getMessage( $error )->parse();
230 $error = new OOUI\
HtmlSnippet( $error );
234 if ( $elementsType === 'error' ) {
235 $this->oouiErrors
= $errors;
237 $this->oouiWarnings
= $errors;
242 public function getHeaderText( $section = null ) {
243 if ( is_null( $section ) ) {
244 // We handle $this->mHeader elsewhere, in getBody()
247 return parent
::getHeaderText( $section );
251 public function getBody() {
252 $html = parent
::getBody();
253 if ( $this->mHeader ||
$this->oouiErrors ||
$this->oouiWarnings
) {
254 $classes = [ 'mw-htmlform-ooui-header' ];
255 if ( $this->oouiErrors
) {
256 $classes[] = 'mw-htmlform-ooui-header-errors';
258 if ( $this->oouiWarnings
) {
259 $classes[] = 'mw-htmlform-ooui-header-warnings';
261 // if there's no header, don't create an (empty) LabelWidget, simply use a placeholder
262 if ( $this->mHeader
) {
263 $element = new OOUI\
LabelWidget( [ 'label' => new OOUI\
HtmlSnippet( $this->mHeader
) ] );
265 $element = new OOUI\
Widget( [] );
267 $html = new OOUI\
FieldLayout(
271 'errors' => $this->oouiErrors
,
272 'notices' => $this->oouiWarnings
,
273 'classes' => $classes,
280 public function wrapForm( $html ) {
281 if ( is_string( $this->mWrapperLegend
) ) {
282 $content = new OOUI\
FieldsetLayout( [
283 'label' => $this->mWrapperLegend
,
286 'content' => new OOUI\
HtmlSnippet( $html )
291 $content = new OOUI\
HtmlSnippet( $html );
294 $form = new OOUI\
FormLayout( $this->getFormAttributes() +
[
295 'classes' => [ 'mw-htmlform', 'mw-htmlform-ooui' ],
296 'content' => $content,
299 // Include a wrapper for style, if requested.
300 $form = new OOUI\
PanelLayout( [
301 'classes' => [ 'mw-htmlform-ooui-wrapper' ],
303 'padded' => $this->mWrapperLegend
!== false,
304 'framed' => $this->mWrapperLegend
!== false,