VFormHTMLForm.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Html\Html;
use MediaWiki\Linker\Linker;
 
class VFormHTMLForm extends HTMLForm {
    protected $mWrapperLegend = false;
 
    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 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( [
            'mediawiki.ui',
            'mediawiki.ui.button',
            'mediawiki.ui.input',
            'mediawiki.ui.checkbox',
        ] );
 
        return parent::getHTML( $submitResult );
    }
 
    protected function getFormAttributes() {
        $attribs = parent::getFormAttributes();
        $attribs['class'] = [ 'mw-htmlform', 'mw-ui-vform', 'mw-ui-container' ];
        return $attribs;
    }
 
    public function wrapForm( $html ) {
        // Always discard $this->mWrapperLegend
        return Html::rawElement( 'form', $this->getFormAttributes(), $html );
    }
 
    public function getButtons() {
        $buttons = '';
 
        if ( $this->mShowSubmit ) {
            $attribs = [];
 
            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'] = [
                'mw-htmlform-submit',
                'mw-ui-button mw-ui-big mw-ui-block',
            ];
            foreach ( $this->mSubmitFlags as $flag ) {
                $attribs['class'][] = 'mw-ui-' . $flag;
            }
 
            $buttons .= Xml::submitButton( $this->getSubmitText(), $attribs ) . "\n";
        }
 
        if ( $this->mShowReset ) {
            $buttons .= Html::element(
                'input',
                [
                    'type' => 'reset',
                    'value' => $this->msg( 'htmlform-reset' )->text(),
                    'class' => 'mw-ui-button mw-ui-big mw-ui-block',
                ]
            ) . "\n";
        }
 
        if ( $this->mShowCancel ) {
            $target = $this->getCancelTargetURL();
            $buttons .= Html::element(
                    'a',
                    [
                        'class' => 'mw-ui-button mw-ui-big mw-ui-block',
                        'href' => $target,
                    ],
                    $this->msg( 'cancel' )->text()
                ) . "\n";
        }
 
        foreach ( $this->mButtons as $button ) {
            $attrs = [
                'type' => 'submit',
                'name' => $button['name'],
                'value' => $button['value']
            ];
 
            // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in HTMLForm::addButton
            if ( $button['attribs'] ) {
                // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in HTMLForm::addButton
                $attrs += $button['attribs'];
            }
 
            if ( isset( $button['id'] ) ) {
                $attrs['id'] = $button['id'];
            }
 
            $attrs['class'] = isset( $attrs['class'] ) ? (array)$attrs['class'] : [];
            $attrs['class'][] = 'mw-ui-button mw-ui-big mw-ui-block';
 
            $buttons .= Html::element( 'input', $attrs ) . "\n";
        }
 
        if ( !$buttons ) {
            return '';
        }
 
        return Html::rawElement( 'div',
            [ 'class' => 'mw-htmlform-submit-buttons' ], "\n$buttons" ) . "\n";
    }
}