CodexHTMLForm.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm;
 
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\Field\HTMLButtonField;
use MediaWiki\Linker\Linker;
use MediaWiki\Parser\Sanitizer;
 
class CodexHTMLForm extends HTMLForm {
 
    protected $displayFormat = 'codex';
 
    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( [
            'codex-styles',
            'mediawiki.htmlform.codex.styles',
        ] );
 
        return parent::getHTML( $submitResult );
    }
 
    protected function formatField( HTMLFormField $field, $value ) {
        return $field->getCodex( $value );
    }
 
    protected function getFormAttributes() {
        $attribs = parent::getFormAttributes();
        $attribs['class'] = [ 'mw-htmlform', 'mw-htmlform-codex' ];
        return $attribs;
    }
 
    public function wrapForm( $html ) {
        return Html::rawElement( 'form', $this->getFormAttributes(), $html );
    }
 
    protected function wrapFieldSetSection( $legend, $section, $attributes, $isRoot ) {
        $attributes['class'] = 'cdx-field';
        $legendElement = Html::rawElement( 'legend', [ 'class' => [ 'cdx-label' ] ], $legend );
        return Html::rawElement( 'fieldset', $attributes, "$legendElement\n$section" ) . "\n";
    }
 
    public function getLegend( $key ) {
        $legendText = $this->msg(
            $this->mMessagePrefix ? "{$this->mMessagePrefix}-$key" : $key
        )->text();
        $legendTextMarkup = Html::element(
            'span',
            [ 'class' => [ 'cdx-label__label__text' ] ],
            $legendText
        );
 
        $isOptional = $this->mSections[$key]['optional'] ?? false;
        $optionalFlagMarkup = '';
        if ( $isOptional ) {
            $optionalFlagMarkup = Html::element(
                'span',
                [ 'class' => [ 'cdx-label__label__optional-flag' ] ],
                $this->msg( 'word-separator' )->text() . $this->msg( 'htmlform-optional-flag' )->text()
            );
        }
 
        $descriptionMarkup = '';
        if ( isset( $this->mSections[$key]['description-message'] ) ) {
            $needsParse = $this->mSections[ $key ][ 'description-message-parse' ] ?? false;
            $descriptionMessage = $this->msg( $this->mSections[ $key ][ 'description-message' ] );
            $descriptionMarkup = Html::rawElement(
                'span',
                [ 'class' => [ 'cdx-label__description' ] ],
                $needsParse ? $descriptionMessage->parse() : $descriptionMessage->escaped()
            );
        } elseif ( isset( $this->mSections[$key]['description'] ) ) {
            $descriptionMarkup = Html::element(
                'span',
                [ 'class' => [ 'cdx-label__description' ] ],
                $this->mSections[ $key ][ 'description' ]
            );
        }
 
        return Html::rawElement(
            'span',
            [ 'class' => [ 'cdx-label__label' ] ],
            $legendTextMarkup . $optionalFlagMarkup
        ) . $descriptionMarkup;
    }
 
    protected function formatSection( array $fieldsHtml, $sectionName, $anyFieldHasLabel ) {
        if ( !$fieldsHtml ) {
            // Do not generate any wrappers for empty sections. Sections may be empty if they only
            // have subsections, but no fields. A legend will still be added in
            // wrapFieldSetSection().
            return '';
        }
 
        $html = implode( '', $fieldsHtml );
 
        if ( $sectionName ) {
            $attribs = [
                'id' => Sanitizer::escapeIdForAttribute( $sectionName ),
                'class' => [ 'cdx-field__control' ]
            ];
 
            return Html::rawElement( 'div', $attribs, $html );
        }
 
        return $html;
    }
 
    public function getButtons() {
        $buttons = [];
 
        if ( $this->mShowSubmit ) {
            $value = $this->getSubmitText();
            // Define flag classes for the submit button
            $submitFlags = $this->mSubmitFlags;
            $submitClasses = [ 'mw-htmlform-submit', 'cdx-button' ];
            $submitButtonLabel = $this->getSubmitText();
            $submitID = $this->mSubmitID;
            $submitName = $this->mSubmitName;
            $submitTooltip = [];
 
            if ( isset( $this->mSubmitTooltip ) ) {
                $submitTooltip += Linker::tooltipAndAccesskeyAttribs( $this->mSubmitTooltip );
            }
 
            $buttonAttribs = [
                'value' => $value,
                'type' => 'submit',
                'name' => $submitName,
                'id' => $submitID,
                'class' => $submitClasses,
                'formnovalidate' => false,
            ] + $submitTooltip;
 
            $button = HTMLButtonField::buildCodexComponent(
                $submitFlags,
                $submitButtonLabel,
                $buttonAttribs
            );
            $buttons[] = $button;
        }
 
        // The reset button is unused and will be removed from HTMLForm (T361032).
 
        if ( $this->mShowCancel ) {
            $target = $this->getCancelTargetURL();
            $buttonClasses = [
                'cdx-button',
                'cdx-button--fake-button',
                'cdx-button--fake-button--enabled',
            ];
            $attr = [
                'href' => $target,
                'class' => $buttonClasses,
                'role' => 'button',
            ];
            $cancelButton = Html::element(
                'a', $attr, $this->msg( 'cancel' )->text()
            );
            $buttons[] = $cancelButton;
        }
 
        foreach ( $this->mButtons as $button ) {
            $attrs = [
                'type' => 'submit',
                'name' => $button['name'],
                'value' => $button['value']
            ];
 
            if ( isset( $button['label-message'] ) ) {
                $label = $this->getMessage( $button['label-message'] )->parse();
            } elseif ( isset( $button['label'] ) ) {
                $label = htmlspecialchars( $button['label'] );
            } elseif ( isset( $button['label-raw'] ) ) {
                $label = $button['label-raw'];
            } else {
                $label = htmlspecialchars( $button['value'] );
            }
 
            // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in self::addButton
            if ( $button['attribs'] ) {
                // @phan-suppress-next-line PhanTypePossiblyInvalidDimOffset Always set in self::addButton
                $attrs += $button['attribs'];
            }
 
            if ( isset( $button['id'] ) ) {
                $attrs['id'] = $button['id'];
            }
 
            if ( isset( $attrs['class'] ) ) {
                // Ensure $attrs['class'] is always treated as an array whether it's initially set
                // as an array or a string.
                $attrs['class'] = (array)( $attrs['class'] ?? [] );
            }
 
            $attrs['class'][] = 'cdx-button';
 
            $buttons[] = Html::rawElement( 'button', $attrs, $label ) . "\n";
        }
 
        if ( !$buttons ) {
            return '';
        }
 
        return Html::rawElement(
            'div',
            [ 'class' => 'mw-htmlform-submit-buttons' ],
            implode( "\n", $buttons )
        ) . "\n";
    }
}
 
class_alias( CodexHTMLForm::class, 'CodexHTMLForm' );