HTMLButtonField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\Message\Message;
 
class HTMLButtonField extends HTMLFormField {
    protected $buttonType = 'button';
    protected $buttonLabel = null;
 
    protected $mFlags = [];
 
    protected $mFormnovalidate = false;
 
    public function __construct( $info ) {
        $info['nodata'] = true;
 
        $this->setShowEmptyLabel( false );
 
        parent::__construct( $info );
 
        if ( isset( $info['flags'] ) ) {
            $this->mFlags = $info['flags'];
        }
 
        if ( isset( $info['formnovalidate'] ) ) {
            $this->mFormnovalidate = $info['formnovalidate'];
        }
 
        # Generate the label from a message, if possible
        if ( isset( $info['buttonlabel-message'] ) ) {
            $this->buttonLabel = $this->getMessage( $info['buttonlabel-message'] )->parse();
        } elseif ( isset( $info['buttonlabel'] ) ) {
            if ( $info['buttonlabel'] === '&#160;' || $info['buttonlabel'] === "\u{00A0}" ) {
                // Apparently some things set &nbsp directly and in an odd format
                $this->buttonLabel = "\u{00A0}";
            } else {
                $this->buttonLabel = htmlspecialchars( $info['buttonlabel'] );
            }
        } elseif ( isset( $info['buttonlabel-raw'] ) ) {
            $this->buttonLabel = $info['buttonlabel-raw'];
        }
    }
 
    public function getInputHTML( $value ) {
        $flags = '';
        $prefix = 'mw-htmlform-';
        foreach ( $this->mFlags as $flag ) {
            $flags .= ' ' . $prefix . $flag;
        }
        $attr = [
            'class' => 'mw-htmlform-submit ' . $this->mClass . $flags,
            'id' => $this->mID,
            'type' => $this->buttonType,
            'name' => $this->mName,
            'value' => $this->getDefault(),
            'formnovalidate' => $this->mFormnovalidate,
        ] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
 
        return Html::rawElement( 'button', $attr,
            $this->buttonLabel ?: htmlspecialchars( $this->getDefault() ) );
    }
 
    public function getInputOOUI( $value ) {
        return new \OOUI\ButtonInputWidget( [
            'name' => $this->mName,
            'value' => $this->getDefault(),
            'label' => $this->buttonLabel
                ? new \OOUI\HtmlSnippet( $this->buttonLabel )
                : $this->getDefault(),
            'type' => $this->buttonType,
            'classes' => [ 'mw-htmlform-submit', $this->mClass ],
            'id' => $this->mID,
            'flags' => $this->mFlags,
            'formNoValidate' => $this->mFormnovalidate,
        ] + \OOUI\Element::configFromHtmlAttributes(
            $this->getAttributes( [ 'disabled', 'tabindex' ] )
        ) );
    }
 
    public function getInputCodex( $value, $hasErrors ) {
        $buttonClasses = [ 'mw-htmlform-submit', 'cdx-button' ];
        if ( isset( $this->mParams['size'] ) ) {
            $codexSizeKeywords = [ 'small', 'medium', 'large' ];
            if ( !in_array( $this->mParams['size'], $codexSizeKeywords, true ) ) {
                throw new \InvalidArgumentException(
                    'Invalid size for button: "' . $this->mParams['size'] . '". Please use one of the Codex keywords.'
                );
            }
 
            $sizeClass = 'cdx-button--size-' . $this->mParams['size'];
            $buttonClasses[] = $sizeClass;
        }
        $flags = $this->mFlags;
        $buttonLabel = $this->buttonLabel ?: htmlspecialchars( $this->getDefault() );
        $buttonAttribs = [
            'class' => $buttonClasses,
            'id' => $this->mID,
            'type' => $this->buttonType,
            'name' => $this->mName,
            'value' => $this->getDefault(),
            'formnovalidate' => $this->mFormnovalidate,
        ] + $this->getAttributes( [ 'disabled', 'tabindex' ] );
 
        return static::buildCodexComponent(
            $flags,
            $buttonLabel,
            $buttonAttribs
        );
    }
 
    public static function buildCodexComponent(
        $flags,
        $buttonLabel,
        $attribs
    ) {
        $flagClasses = [];
        $flagClassMap = [
            'progressive' => 'cdx-button--action-progressive',
            'destructive' => 'cdx-button--action-destructive',
            'primary' => 'cdx-button--weight-primary',
            'quiet' => 'cdx-button--weight-quiet',
        ];
 
        foreach ( $flags as $flag ) {
            if ( isset( $flagClassMap[$flag] ) ) {
                $flagClasses[] = $flagClassMap[$flag];
            }
        }
 
        $buttonClassesAndFlags = array_merge( $attribs[ 'class' ], $flagClasses );
        $attribs['class'] = $buttonClassesAndFlags;
 
        $buttonHtml = Html::rawElement(
            'button', $attribs, $buttonLabel
        );
 
        return $buttonHtml;
    }
 
    protected function needsLabel() {
        return false;
    }
 
    public function validate( $value, $alldata ) {
        return true;
    }
}
 
class_alias( HTMLButtonField::class, 'HTMLButtonField' );