wiki.techinc.nl/includes/htmlform/VFormHTMLForm.php
Umherirrender aed646001c htmlform: Add missing documentation to class properties
Add doc-typehints to class properties found by the PropertyDocumentation
sniff to improve the documentation.

Once the sniff is enabled it avoids that new code is missing type
declarations. This is focused on documentation and does not change code.

Change-Id: I1f306a3925d6768209a06e70082598b2f70cd319
2024-09-14 11:49:05 +00:00

81 lines
2.2 KiB
PHP

<?php
namespace MediaWiki\HTMLForm;
/**
* 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
*/
use MediaWiki\Html\Html;
/**
* Compact stacked vertical format for forms.
*
* @stable to extend
*/
class VFormHTMLForm extends HTMLForm {
/**
* Wrapper and its legend are never generated in VForm mode.
* @var bool
*/
protected $mWrapperLegend = false;
/** @inheritDoc */
protected $displayFormat = 'vform';
public static function loadInputFromParameters( $fieldname, $descriptor,
HTMLForm $parent = null
) {
$field = parent::loadInputFromParameters( $fieldname, $descriptor, $parent );
$field->setShowEmptyLabel( false );
return $field;
}
public function getHTML( $submitResult ) {
$this->getOutput()->addModuleStyles( [
'mediawiki.ui',
'mediawiki.ui.button',
'mediawiki.ui.input',
'mediawiki.ui.checkbox',
] );
return parent::getHTML( $submitResult );
}
/**
* @inheritDoc
*/
protected function formatField( HTMLFormField $field, $value ) {
return $field->getVForm( $value );
}
protected function getFormAttributes() {
return [ 'class' => [ 'mw-htmlform', 'mw-ui-vform', 'mw-ui-container' ] ] +
parent::getFormAttributes();
}
public function wrapForm( $html ) {
// Always discard $this->mWrapperLegend
return Html::rawElement( 'form', $this->getFormAttributes(), $html );
}
}
/** @deprecated class alias since 1.42 */
class_alias( VFormHTMLForm::class, 'VFormHTMLForm' );