f338a1cf31
…and in general, work with the existing HTMLForm design for defining
display formats, rather than against it.
Breaking changes:
* HTMLForm::isVForm() is now deprecated.
* You can no longer do this:
$form = new HTMLForm( … );
$form->setDisplayFormat( 'vform' ); // throws exception
Instead, do this:
$form = HTMLForm::factory( 'vform', … );
When using FormSpecialPage, override the new getDisplayFormat() method
instead of calling $form->setDisplayFormat() in the alterForm() method.
(Other display formats are not affected, only 'vform'.)
Bug fixes:
* Correctly suppress empty labels for VForm fields
* Correctly disable <fieldset/> wrappers for VForms
Other benefits:
* Reduce code duplication related to $getFieldHtmlMethod
* Introduce HTMLForm::factory() method for constructing HTMLForms
Related cleanup:
* Correctly style 'reset' buttons in MediaWiki UI mode
* Label $wgHTMLFormAllowTableFormat as a mobile-specific hack
* Display checkboxes normally in MediaWiki UI mode (removed weird
override that only broke things). Also, always render checkboxes
in VForms as .mw-ui-checkbox.
* self:: → static::
Bug: T85285
Change-Id: I086a84f1c8cc6a16710709b7806c7f5f96462b32
140 lines
3.7 KiB
PHP
140 lines
3.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* HTML form generation and submission handling, vertical-form style.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* Compact stacked vertical format for forms.
|
|
*/
|
|
class VFormHTMLForm extends HTMLForm {
|
|
/**
|
|
* Wrapper and its legend are never generated in VForm mode.
|
|
* @var boolean
|
|
*/
|
|
protected $mWrapperLegend = false;
|
|
|
|
/**
|
|
* Symbolic display format name.
|
|
* @var string
|
|
*/
|
|
protected $displayFormat = 'vform';
|
|
|
|
public function isVForm() {
|
|
return true;
|
|
}
|
|
|
|
public static function loadInputFromParameters( $fieldname, $descriptor, HTMLForm $parent = null ) {
|
|
$field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
|
|
$field->setShowEmptyLabel( false );
|
|
return $field;
|
|
}
|
|
|
|
function getHTML( $submitResult ) {
|
|
// This is required for VForm HTMLForms that use that style regardless
|
|
// of wgUseMediaWikiUIEverywhere (since they pre-date it).
|
|
// When wgUseMediaWikiUIEverywhere is removed, this should be consolidated
|
|
// with the addModuleStyles in SpecialPage->setHeaders.
|
|
$this->getOutput()->addModuleStyles( array(
|
|
'mediawiki.ui',
|
|
'mediawiki.ui.button',
|
|
'mediawiki.ui.input',
|
|
'mediawiki.ui.checkbox',
|
|
) );
|
|
|
|
return parent::getHTML( $submitResult );
|
|
}
|
|
|
|
protected function getFormAttributes() {
|
|
$attribs = parent::getFormAttributes();
|
|
array_push( $attribs['class'], 'mw-ui-vform', 'mw-ui-container' );
|
|
return $attribs;
|
|
}
|
|
|
|
function wrapForm( $html ) {
|
|
// Always discard $this->mWrapperLegend
|
|
return Html::rawElement( 'form', $this->getFormAttributes(), $html );
|
|
}
|
|
|
|
function getButtons() {
|
|
$buttons = '';
|
|
|
|
if ( $this->mShowSubmit ) {
|
|
$attribs = array();
|
|
|
|
if ( isset( $this->mSubmitID ) ) {
|
|
$attribs['id'] = $this->mSubmitID;
|
|
}
|
|
|
|
if ( isset( $this->mSubmitName ) ) {
|
|
$attribs['name'] = $this->mSubmitName;
|
|
}
|
|
|
|
if ( isset( $this->mSubmitTooltip ) ) {
|
|
$attribs += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
|
|
}
|
|
|
|
$attribs['class'] = array(
|
|
'mw-htmlform-submit',
|
|
'mw-ui-button mw-ui-big mw-ui-block',
|
|
$this->mSubmitModifierClass,
|
|
);
|
|
|
|
$buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
|
|
}
|
|
|
|
if ( $this->mShowReset ) {
|
|
$buttons .= Html::element(
|
|
'input',
|
|
array(
|
|
'type' => 'reset',
|
|
'value' => $this->msg( 'htmlform-reset' )->text(),
|
|
'class' => 'mw-ui-button mw-ui-big mw-ui-block',
|
|
)
|
|
) . "\n";
|
|
}
|
|
|
|
foreach ( $this->mButtons as $button ) {
|
|
$attrs = array(
|
|
'type' => 'submit',
|
|
'name' => $button['name'],
|
|
'value' => $button['value']
|
|
);
|
|
|
|
if ( $button['attribs'] ) {
|
|
$attrs += $button['attribs'];
|
|
}
|
|
|
|
if ( isset( $button['id'] ) ) {
|
|
$attrs['id'] = $button['id'];
|
|
}
|
|
|
|
$attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : array();
|
|
$attrs['class'][] = 'mw-ui-button mw-ui-big mw-ui-block';
|
|
|
|
$buttons .= Html::element( 'input', $attrs ) . "\n";
|
|
}
|
|
|
|
$html = Html::rawElement( 'div',
|
|
array( 'class' => 'mw-htmlform-submit-buttons' ), "\n$buttons" ) . "\n";
|
|
|
|
return $html;
|
|
}
|
|
}
|