HTMLFormField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm;
 
use InvalidArgumentException;
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\Field\HTMLCheckField;
use MediaWiki\HTMLForm\Field\HTMLFormFieldCloner;
use MediaWiki\Json\FormatJson;
use MediaWiki\Language\MessageLocalizer;
use MediaWiki\Linker\Linker;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Message\Message;
use MediaWiki\Request\WebRequest;
use MediaWiki\Status\Status;
use RuntimeException;
use StatusValue;
use Wikimedia\HtmlArmor\HtmlArmor;
use Wikimedia\Message\MessageParam;
use Wikimedia\Message\MessageSpecifier;
 
abstract class HTMLFormField implements MessageLocalizer {
    public $mParams;
 
    protected $mValidationCallback;
    protected $mFilterCallback;
    protected $mName;
    protected $mDir;
    protected $mLabel;
    protected $mID;
    protected $mClass = '';
    protected $mHelpClass = false;
    protected $mDefault;
    private $mNotices;
 
    protected $mOptions = false;
    protected $mOptionsLabelsNotFromMessage = false;
    protected $mCondState = [];
    protected $mCondStateClass = [];
 
    protected $mShowEmptyLabels = true;
 
    public $mParent;
 
    abstract public function getInputHTML( $value );
 
    public function getInputOOUI( $value ) {
        return false;
    }
 
    public function getInputCodex( $value, $hasErrors ) {
        // If not overridden, fall back to getInputHTML()
        return $this->getInputHTML( $value );
    }
 
    public function canDisplayErrors() {
        return $this->hasVisibleOutput();
    }
 
    public function msg( $key, ...$params ) {
        return $this->mParent->msg( $key, ...$params );
    }
 
    public function hasVisibleOutput() {
        return true;
    }
 
    public function getName() {
        return $this->mName;
    }
 
    protected function getNearestField( $name, $backCompat = false ) {
        // When the field is belong to a HTMLFormFieldCloner
        $cloner = $this->mParams['cloner'] ?? null;
        if ( $cloner instanceof HTMLFormFieldCloner ) {
            $field = $cloner->findNearestField( $this, $name );
            if ( $field ) {
                return $field;
            }
        }
 
        if ( $backCompat && str_starts_with( $name, 'wp' ) &&
            !$this->mParent->hasField( $name )
        ) {
            // Don't break the existed use cases.
            return $this->mParent->getField( substr( $name, 2 ) );
        }
        return $this->mParent->getField( $name );
    }
 
    protected function getNearestFieldValue( $alldata, $name, $asDisplay = false, $backCompat = false ) {
        $field = $this->getNearestField( $name, $backCompat );
        // When the field belongs to a HTMLFormFieldCloner
        $cloner = $field->mParams['cloner'] ?? null;
        if ( $cloner instanceof HTMLFormFieldCloner ) {
            $value = $cloner->extractFieldData( $field, $alldata );
        } else {
            // Note $alldata is an empty array when first rendering a form with a formIdentifier.
            // In that case, $alldata[$field->mParams['fieldname']] is unset and we use the
            // field's default value
            $value = $alldata[$field->mParams['fieldname']] ?? $field->getDefault();
        }
 
        // Check invert state for HTMLCheckField
        if ( $asDisplay && $field instanceof HTMLCheckField && ( $field->mParams['invert'] ?? false ) ) {
            $value = !$value;
        }
 
        return $value;
    }
 
    protected function getNearestFieldByName( $alldata, $name, $asDisplay = false ) {
        return (string)$this->getNearestFieldValue( $alldata, $name, $asDisplay );
    }
 
    protected function validateCondState( $params ) {
        $origParams = $params;
        $op = array_shift( $params );
 
        $makeException = function ( string $details ) use ( $origParams ): InvalidArgumentException {
            return new InvalidArgumentException(
                "Invalid hide-if or disable-if specification for $this->mName: " .
                $details . " in " . var_export( $origParams, true )
            );
        };
 
        switch ( $op ) {
            case 'NOT':
                if ( count( $params ) !== 1 ) {
                    throw $makeException( "NOT takes exactly one parameter" );
                }
                // Fall-through intentionally
 
            case 'AND':
            case 'OR':
            case 'NAND':
            case 'NOR':
                foreach ( $params as $i => $p ) {
                    if ( !is_array( $p ) ) {
                        $type = get_debug_type( $p );
                        throw $makeException( "Expected array, found $type at index $i" );
                    }
                    $this->validateCondState( $p );
                }
                break;
 
            case '===':
            case '!==':
            case 'CONTAINS':
                if ( count( $params ) !== 2 ) {
                    throw $makeException( "$op takes exactly two parameters" );
                }
                [ $name, $value ] = $params;
                if ( !is_string( $name ) || !is_string( $value ) ) {
                    throw $makeException( "Parameters for $op must be strings" );
                }
                break;
 
            default:
                throw $makeException( "Unknown operation" );
        }
    }
 
    protected function checkStateRecurse( array $alldata, array $params ) {
        $op = array_shift( $params );
        $valueChk = [ 'AND' => false, 'OR' => true, 'NAND' => false, 'NOR' => true ];
        $valueRet = [ 'AND' => true, 'OR' => false, 'NAND' => false, 'NOR' => true ];
 
        switch ( $op ) {
            case 'AND':
            case 'OR':
            case 'NAND':
            case 'NOR':
                foreach ( $params as $p ) {
                    if ( $valueChk[$op] === $this->checkStateRecurse( $alldata, $p ) ) {
                        return !$valueRet[$op];
                    }
                }
                return $valueRet[$op];
 
            case 'NOT':
                return !$this->checkStateRecurse( $alldata, $params[0] );
 
            case '===':
            case '!==':
            case 'CONTAINS':
                [ $field, $value ] = $params;
                $testValue = $this->getNearestFieldValue( $alldata, $field, true, true );
                switch ( $op ) {
                    case '===':
                        return ( $value === (string)$testValue );
                    case '!==':
                        return ( $value !== (string)$testValue );
                    case 'CONTAINS':
                        return in_array( $value, $testValue, true );
                }
        }
    }
 
    protected function parseCondState( $params ) {
        $op = array_shift( $params );
 
        switch ( $op ) {
            case 'AND':
            case 'OR':
            case 'NAND':
            case 'NOR':
                $ret = [ $op ];
                foreach ( $params as $p ) {
                    $ret[] = $this->parseCondState( $p );
                }
                return $ret;
 
            case 'NOT':
                return [ 'NOT', $this->parseCondState( $params[0] ) ];
 
            case '===':
            case '!==':
            case 'CONTAINS':
                [ $name, $value ] = $params;
                $field = $this->getNearestField( $name, true );
                return [ $op, $field->getName(), $value ];
        }
    }
 
    protected function parseCondStateForClient() {
        $parsed = [];
        foreach ( $this->mCondState as $type => $params ) {
            // Omit 'hide-nojs' and 'disable-nojs' here, not needed.
            if ( in_array( $type, [ 'hide', 'disable' ], true ) ) {
                $parsed[$type] = $this->parseCondState( $params );
            }
        }
        // Needed to distinguish fields that are initially disabled because of 'hide-if-nojs' or
        // 'disable-if-nojs', from fields that are always disabled because of their parameters.
        $parsed['alwaysDisabled'] = ( $this->mParams['disabled'] ?? false );
        return $parsed;
    }
 
    public function isHidden( $alldata ) {
        return isset( $this->mCondState['hide'] ) &&
            $this->checkStateRecurse( $alldata, $this->mCondState['hide'] );
    }
 
    public function isHiddenNoJs( $alldata ) {
        return isset( $this->mCondState['hide-nojs'] ) &&
            $this->checkStateRecurse( $alldata, $this->mCondState['hide-nojs'] );
    }
 
    public function isDisabled( $alldata ) {
        return ( $this->mParams['disabled'] ?? false ) ||
            $this->isHidden( $alldata ) ||
            ( isset( $this->mCondState['disable'] )
                && $this->checkStateRecurse( $alldata, $this->mCondState['disable'] ) );
    }
 
    public function isDisabledNoJs( $alldata ) {
        return ( $this->mParams['disabled'] ?? false ) ||
            $this->isHiddenNoJs( $alldata ) ||
            ( isset( $this->mCondState['disable-nojs'] )
                && $this->checkStateRecurse( $alldata, $this->mCondState['disable-nojs'] ) );
    }
 
    public function cancelSubmit( $value, $alldata ) {
        return false;
    }
 
    public function validate( $value, $alldata ) {
        if ( $this->isHidden( $alldata ) ) {
            return true;
        }
 
        if ( isset( $this->mParams['required'] )
            && $this->mParams['required'] !== false
            && ( $value === '' || $value === false || $value === null )
        ) {
            return $this->msg( 'htmlform-required' );
        }
 
        if ( $this->mValidationCallback === null ) {
            return true;
        }
 
        $p = ( $this->mValidationCallback )( $value, $alldata, $this->mParent );
 
        if ( $p instanceof StatusValue ) {
            $language = $this->mParent->getLanguage();
 
            return $p->isGood() ? true : Status::wrap( $p )->getHTML( false, false, $language );
        }
 
        return $p;
    }
 
    public function filter( $value, $alldata ) {
        if ( $this->mFilterCallback !== null ) {
            $value = ( $this->mFilterCallback )( $value, $alldata, $this->mParent );
        }
 
        return $value;
    }
 
    protected function needsLabel() {
        return true;
    }
 
    public function setShowEmptyLabel( $show ) {
        $this->mShowEmptyLabels = $show;
    }
 
    protected function isSubmitAttempt( WebRequest $request ) {
        // HTMLForm would add a hidden field of edit token for forms that require to be posted.
        return ( $request->wasPosted() && $request->getCheck( 'wpEditToken' ) )
            // The identifier matching or not has been checked in HTMLForm::prepareForm()
            || $request->getCheck( 'wpFormIdentifier' );
    }
 
    public function loadDataFromRequest( $request ) {
        if ( $request->getCheck( $this->mName ) ) {
            return $request->getText( $this->mName );
        } else {
            return $this->getDefault();
        }
    }
 
    public function __construct( $params ) {
        $this->mParams = $params;
 
        if ( !( isset( $params['parent'] ) && $params['parent'] instanceof HTMLForm ) ) {
            throw new RuntimeException( "Parent must be set." );
        }
        $this->mParent = $params['parent'];
 
        # Generate the label from a message, if possible
        if ( isset( $params['label-message'] ) ) {
            $this->mLabel = $this->getMessage( $params['label-message'] )->parse();
        } elseif ( isset( $params['label'] ) ) {
            if ( $params['label'] === '&#160;' || $params['label'] === "\u{00A0}" ) {
                // Apparently some things set &nbsp directly and in an odd format
                $this->mLabel = "\u{00A0}";
            } else {
                $this->mLabel = htmlspecialchars( $params['label'] );
            }
        } elseif ( isset( $params['label-raw'] ) ) {
            $this->mLabel = $params['label-raw'];
        }
 
        $this->mName = $params['name'] ?? 'wp' . $params['fieldname'];
 
        if ( isset( $params['dir'] ) ) {
            $this->mDir = $params['dir'];
        }
 
        $this->mID = "mw-input-{$this->mName}";
 
        if ( isset( $params['default'] ) ) {
            $this->mDefault = $params['default'];
        }
 
        if ( isset( $params['id'] ) ) {
            $this->mID = $params['id'];
        }
 
        if ( isset( $params['cssclass'] ) ) {
            $this->mClass = $params['cssclass'];
        }
 
        if ( isset( $params['csshelpclass'] ) ) {
            $this->mHelpClass = $params['csshelpclass'];
        }
 
        if ( isset( $params['validation-callback'] ) ) {
            $this->mValidationCallback = $params['validation-callback'];
        }
 
        if ( isset( $params['filter-callback'] ) ) {
            $this->mFilterCallback = $params['filter-callback'];
        }
 
        if ( isset( $params['hidelabel'] ) ) {
            $this->mShowEmptyLabels = false;
        }
        if ( isset( $params['notices'] ) ) {
            $this->mNotices = $params['notices'];
        }
 
        if ( isset( $params['hide-if'] ) && $params['hide-if'] ) {
            $this->validateCondState( $params['hide-if'] );
            $this->mCondState['hide'] = $params['hide-if'];
        }
        if ( isset( $params['hide-if-nojs'] ) && $params['hide-if-nojs'] ) {
            $this->validateCondState( $params['hide-if-nojs'] );
            $this->mCondState['hide-nojs'] = $params['hide-if-nojs'];
            // Merge the rules here so that we don't have to handle two options everywhere else.
            // This value is sent to the client-side JS, so that stays consistent as well.
            $this->mCondState['hide'] = isset( $this->mCondState['hide'] ) ?
                [ 'OR', $this->mCondState['hide'], $params['hide-if-nojs'] ] :
                $params['hide-if-nojs'];
        }
        if ( isset( $this->mCondState['hide'] ) ) {
            $this->mCondStateClass[] = 'mw-htmlform-hide-if';
        }
 
        if ( !( isset( $params['disabled'] ) && $params['disabled'] ) &&
            isset( $params['disable-if'] ) && $params['disable-if']
        ) {
            $this->validateCondState( $params['disable-if'] );
            $this->mCondState['disable'] = $params['disable-if'];
        }
        if ( !( isset( $params['disabled'] ) && $params['disabled'] ) &&
            isset( $params['disable-if-nojs'] ) && $params['disable-if-nojs']
        ) {
            $this->validateCondState( $params['disable-if-nojs'] );
            $this->mCondState['disable-nojs'] = $params['disable-if-nojs'];
            // Merge the rules here so that we don't have to handle two options everywhere else.
            // This value is sent to the client-side JS, so that stays consistent as well.
            $this->mCondState['disable'] = isset( $this->mCondState['disable'] ) ?
                [ 'OR', $this->mCondState['disable'], $params['disable-if-nojs'] ] :
                $params['disable-if-nojs'];
        }
        if ( isset( $this->mCondState['disable'] ) ) {
            $this->mCondStateClass[] = 'mw-htmlform-disable-if';
        }
    }
 
    public function getTableRow( $value ) {
        [ $errors, $errorClass ] = $this->getErrorsAndErrorClass( $value );
        $inputHtml = $this->getInputHTML( $value );
        $fieldType = $this->getClassName();
        $helptext = $this->getHelpTextHtmlTable( $this->getHelpText() );
        $cellAttributes = [];
        $rowAttributes = [];
        $rowClasses = '';
 
        if ( !empty( $this->mParams['vertical-label'] ) ) {
            $cellAttributes['colspan'] = 2;
            $verticalLabel = true;
        } else {
            $verticalLabel = false;
        }
 
        $label = $this->getLabelHtml( $cellAttributes );
 
        $field = Html::rawElement(
            'td',
            [ 'class' => 'mw-input' ] + $cellAttributes,
            $inputHtml . "\n$errors"
        );
 
        if ( $this->mCondState ) {
            $rowAttributes['data-cond-state'] = FormatJson::encode( $this->parseCondStateForClient() );
            $rowClasses .= implode( ' ', $this->mCondStateClass );
            if ( $this->isHiddenNoJs( $this->mParent->mFieldData ) ) {
                $rowClasses .= ' mw-htmlform-hide-if-hidden-nojs';
            } elseif ( $this->isHidden( $this->mParent->mFieldData ) ) {
                $rowClasses .= ' mw-htmlform-hide-if-hidden';
            }
        }
 
        if ( $verticalLabel ) {
            $html = Html::rawElement( 'tr',
                $rowAttributes + [ 'class' => "mw-htmlform-vertical-label $rowClasses" ], $label );
            $html .= Html::rawElement( 'tr',
                $rowAttributes + [
                    'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
                ],
                $field );
        } else {
            $html = Html::rawElement( 'tr',
                $rowAttributes + [
                    'class' => "mw-htmlform-field-$fieldType {$this->mClass} $errorClass $rowClasses"
                ],
                $label . $field );
        }
 
        return $html . $helptext;
    }
 
    public function getDiv( $value ) {
        [ $errors, $errorClass ] = $this->getErrorsAndErrorClass( $value );
        $inputHtml = $this->getInputHTML( $value );
        $fieldType = $this->getClassName();
        $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText() );
        $cellAttributes = [];
        $label = $this->getLabelHtml( $cellAttributes );
 
        $outerDivClass = [
            'mw-input',
            'mw-htmlform-nolabel' => ( $label === '' )
        ];
 
        $horizontalLabel = $this->mParams['horizontal-label'] ?? false;
 
        if ( $horizontalLabel ) {
            $field = "\u{00A0}" . $inputHtml . "\n$errors";
        } else {
            $field = Html::rawElement(
                'div',
                // @phan-suppress-next-line PhanUselessBinaryAddRight
                [ 'class' => $outerDivClass ] + $cellAttributes,
                $inputHtml . "\n$errors"
            );
        }
 
        $wrapperAttributes = [ 'class' => [
            "mw-htmlform-field-$fieldType",
            $this->mClass,
            $errorClass,
        ] ];
        if ( $this->mCondState ) {
            $wrapperAttributes['data-cond-state'] = FormatJson::encode( $this->parseCondStateForClient() );
            $wrapperAttributes['class'] = array_merge( $wrapperAttributes['class'], $this->mCondStateClass );
            if ( $this->isHiddenNoJs( $this->mParent->mFieldData ) ) {
                $wrapperAttributes['class'][] = 'mw-htmlform-hide-if-hidden-nojs';
            } elseif ( $this->isHidden( $this->mParent->mFieldData ) ) {
                $wrapperAttributes['class'][] = 'mw-htmlform-hide-if-hidden';
            }
        }
        return Html::rawElement( 'div', $wrapperAttributes, $label . $field ) .
            $helptext;
    }
 
    public function getOOUI( $value ) {
        if ( $this->getDescriptionMessages() !== [] ) {
            throw new InvalidArgumentException(
                "OOUIHTMLForm does not support the descriptions for fields. Please use Codex"
            );
        }
        $inputField = $this->getInputOOUI( $value );
 
        if ( !$inputField ) {
            // This field doesn't have an OOUI implementation yet at all. Fall back to getDiv() to
            // generate the whole field, label and errors and all, then wrap it in a Widget.
            // It might look weird, but it'll work OK.
            return $this->getFieldLayoutOOUI(
                new \OOUI\Widget( [ 'content' => new \OOUI\HtmlSnippet( $this->getDiv( $value ) ) ] ),
                [ 'align' => 'top' ]
            );
        }
 
        $infusable = true;
        if ( is_string( $inputField ) ) {
            // We have an OOUI implementation, but it's not proper, and we got a load of HTML.
            // Cheat a little and wrap it in a widget. It won't be infusable, though, since client-side
            // JavaScript doesn't know how to rebuilt the contents.
            $inputField = new \OOUI\Widget( [ 'content' => new \OOUI\HtmlSnippet( $inputField ) ] );
            $infusable = false;
        }
 
        $fieldType = $this->getClassName();
        $help = $this->getHelpText();
        $errors = $this->getErrorsRaw( $value );
        foreach ( $errors as &$error ) {
            $error = new \OOUI\HtmlSnippet( $error );
        }
 
        $config = [
            'classes' => [ "mw-htmlform-field-$fieldType" ],
            'align' => $this->getLabelAlignOOUI(),
            'help' => ( $help !== null && $help !== '' ) ? new \OOUI\HtmlSnippet( $help ) : null,
            'errors' => $errors,
            'infusable' => $infusable,
            'helpInline' => $this->isHelpInline(),
            'notices' => $this->mNotices ?: [],
        ];
        if ( $this->mClass !== '' ) {
            $config['classes'][] = $this->mClass;
        }
 
        $preloadModules = false;
 
        if ( $infusable && $this->shouldInfuseOOUI() ) {
            $preloadModules = true;
            $config['classes'][] = 'mw-htmlform-autoinfuse';
        }
        if ( $this->mCondState ) {
            $config['classes'] = array_merge( $config['classes'], $this->mCondStateClass );
            if ( $this->isHiddenNoJs( $this->mParent->mFieldData ) ) {
                $config['classes'][] = 'mw-htmlform-hide-if-hidden-nojs';
            } elseif ( $this->isHidden( $this->mParent->mFieldData ) ) {
                $config['classes'][] = 'mw-htmlform-hide-if-hidden';
            }
        }
 
        // the element could specify, that the label doesn't need to be added
        $label = $this->getLabel();
        if ( $label && $label !== "\u{00A0}" && $label !== '&#160;' ) {
            $config['label'] = new \OOUI\HtmlSnippet( $label );
        }
 
        if ( $this->mCondState ) {
            $preloadModules = true;
            $config['condState'] = $this->parseCondStateForClient();
        }
 
        $config['modules'] = $this->getOOUIModules();
 
        if ( $preloadModules ) {
            $this->mParent->getOutput()->addModules( 'mediawiki.htmlform.ooui' );
            $this->mParent->getOutput()->addModules( $this->getOOUIModules() );
        }
 
        return $this->getFieldLayoutOOUI( $inputField, $config );
    }
 
    public function getCodex( $value ) {
        $isDisabled = ( $this->mParams['disabled'] ?? false );
 
        // Label
        $labelDiv = '';
        $labelValue = trim( $this->getLabel() );
        // For weird historical reasons, a non-breaking space is treated as an empty label
        // Check for both a literal nbsp ("\u{00A0}") and the HTML-encoded version
        if ( $labelValue !== '' && $labelValue !== "\u{00A0}" && $labelValue !== '&#160;' ) {
            $labelFor = $this->needsLabel() ? [ 'for' => $this->mID ] : [];
            $labelClasses = [ 'cdx-label' ];
            if ( $isDisabled ) {
                $labelClasses[] = 'cdx-label--disabled';
            }
            $descriptionHtml = $this->getDescriptionHtmlSpan(
                $this->getDescriptionText(),
                [ 'cdx-label__description' ]
            );
            $optionalHtml = '';
            if ( $this->showOptionalFlag() ) {
                $messageKey = $this->mParams['optional-message'] ?? 'htmlform-optional-flag';
                $optionalHtml = Html::rawElement(
                    'span',
                    [ 'class' => 'cdx-label__label__optional-flag' ],
                    ' ' . $this->getMessage( $messageKey )->parse(),
                );
            }
            // <div class="cdx-label">
            $labelDiv = Html::rawElement( 'div', [ 'class' => $labelClasses ],
                // <label class="cdx-label__label" for="ID">
                Html::rawElement( 'label', [ 'class' => 'cdx-label__label' ] + $labelFor,
                    // <span class="cdx-label__label__text">
                    Html::rawElement( 'span', [ 'class' => 'cdx-label__label__text' ],
                        $labelValue,
                    ) . $optionalHtml,
                ) . $descriptionHtml,
            );
        }
 
        // Help text
        // <div class="cdx-field__help-text">
        $helptext = $this->getHelpTextHtmlDiv( $this->getHelpText(), [ 'cdx-field__help-text' ] );
 
        // Validation message
        // <div class="cdx-field__validation-message">
        // $errors is a <div class="cdx-message">
        // FIXME right now this generates a block message (cdx-message--block), we want an inline message instead
        $validationMessage = '';
        [ $errors, $errorClass ] = $this->getErrorsAndErrorClass( $value );
        if ( $errors !== '' ) {
            $validationMessage = Html::rawElement( 'div', [ 'class' => 'cdx-field__validation-message' ],
                $errors
            );
        }
 
        // Control
        $inputHtml = $this->getInputCodex( $value, $errors !== '' );
        // <div class="cdx-field__control cdx-field__control--has-help-text">
        $controlClasses = [ 'cdx-field__control' ];
        if ( $helptext ) {
            $controlClasses[] = 'cdx-field__control--has-help-text';
        }
        $control = Html::rawElement( 'div', [ 'class' => $controlClasses ], $inputHtml );
 
        // <div class="cdx-field">
        $fieldClasses = [
            "mw-htmlform-field-{$this->getClassName()}",
            $this->mClass,
            $errorClass,
            'cdx-field'
        ];
        if ( $isDisabled ) {
            $fieldClasses[] = 'cdx-field--disabled';
        }
        $fieldAttributes = [];
        // Set data attribute and CSS class for client side handling of hide-if / disable-if
        if ( $this->mCondState ) {
            $fieldAttributes['data-cond-state'] = FormatJson::encode( $this->parseCondStateForClient() );
            $fieldClasses = array_merge( $fieldClasses, $this->mCondStateClass );
            if ( $this->isHiddenNoJs( $this->mParent->mFieldData ) ) {
                $fieldClasses[] = 'mw-htmlform-hide-if-hidden-nojs';
            } elseif ( $this->isHidden( $this->mParent->mFieldData ) ) {
                $fieldClasses[] = 'mw-htmlform-hide-if-hidden';
            }
        }
 
        return Html::rawElement( 'div', [ 'class' => $fieldClasses ] + $fieldAttributes,
            $labelDiv . $control . $helptext . $validationMessage
        );
    }
 
    private function showOptionalFlag(): bool {
        $shouldShowOptionalFlag = $this->mParams['show-optional-flag'] ?? false;
        if ( !$shouldShowOptionalFlag ) {
            return false;
        }
 
        $isRequired = $this->mParams['required'] ?? false;
        if ( $isRequired ) {
            // field is both required AND set to show a label-suffix "(optional)". Something is wrong
            throw new \InvalidArgumentException( 'A field cannot be both optional and required.' );
        }
        return true;
    }
 
    protected function getClassName() {
        $name = explode( '\\', static::class );
        return end( $name );
    }
 
    protected function getLabelAlignOOUI() {
        return 'top';
    }
 
    protected function getFieldLayoutOOUI( $inputField, $config ) {
        return new HTMLFormFieldLayout( $inputField, $config );
    }
 
    protected function shouldInfuseOOUI() {
        // Always infuse fields with popup help text, since the interface for it is nicer with JS
        return !$this->isHelpInline() && $this->getHelpMessages();
    }
 
    protected function getOOUIModules() {
        return [];
    }
 
    public function getRaw( $value ) {
        [ $errors, ] = $this->getErrorsAndErrorClass( $value );
        return "\n" . $errors .
            $this->getLabelHtml() .
            $this->getInputHTML( $value ) .
            $this->getHelpTextHtmlRaw( $this->getHelpText() );
    }
 
    public function getInline( $value ) {
        [ $errors, ] = $this->getErrorsAndErrorClass( $value );
        return "\n" . $errors .
            $this->getLabelHtml() .
            "\u{00A0}" .
            $this->getInputHTML( $value ) .
            $this->getHelpTextHtmlDiv( $this->getHelpText() );
    }
 
    public function getHelpTextHtmlTable( $helptext ) {
        if ( $helptext === null ) {
            return '';
        }
 
        $rowAttributes = [];
        if ( $this->mCondState ) {
            $rowAttributes['data-cond-state'] = FormatJson::encode( $this->parseCondStateForClient() );
            $rowAttributes['class'] = $this->mCondStateClass;
        }
 
        $tdClasses = [ 'htmlform-tip' ];
        if ( $this->mHelpClass !== false ) {
            $tdClasses[] = $this->mHelpClass;
        }
        return Html::rawElement( 'tr', $rowAttributes,
            Html::rawElement( 'td', [ 'colspan' => 2, 'class' => $tdClasses ], $helptext )
        );
    }
 
    public function getHelpTextHtmlDiv( $helptext, $cssClasses = [] ) {
        if ( $helptext === null ) {
            return '';
        }
 
        $wrapperAttributes = [
            'class' => array_merge( $cssClasses, [ 'htmlform-tip' ] ),
        ];
        if ( $this->mHelpClass !== false ) {
            $wrapperAttributes['class'][] = $this->mHelpClass;
        }
        if ( $this->mCondState ) {
            $wrapperAttributes['data-cond-state'] = FormatJson::encode( $this->parseCondStateForClient() );
            $wrapperAttributes['class'] = array_merge( $wrapperAttributes['class'], $this->mCondStateClass );
        }
        return Html::rawElement( 'div', $wrapperAttributes, $helptext );
    }
 
    public function getDescriptionHtmlSpan( ?string $descriptionHtml, array $cssClasses = [] ): string {
        if ( $descriptionHtml === null ) {
            return '';
        }
 
        return Html::rawElement( 'span', [ 'class' => $cssClasses ], $descriptionHtml );
    }
 
    public function getHelpTextHtmlRaw( $helptext ) {
        return $this->getHelpTextHtmlDiv( $helptext );
    }
 
    private function getHelpMessages(): array {
        if ( isset( $this->mParams['help-message'] ) ) {
            return [ $this->mParams['help-message'] ];
        } elseif ( isset( $this->mParams['help-messages'] ) ) {
            return $this->mParams['help-messages'];
        } elseif ( isset( $this->mParams['help-raw'] ) ) {
            return [ new HtmlArmor( $this->mParams['help-raw'] ) ];
        } elseif ( isset( $this->mParams['help'] ) ) {
            // @deprecated since 1.43, use 'help-raw' key instead
            return [ new HtmlArmor( $this->mParams['help'] ) ];
        }
 
        return [];
    }
 
    public function getHelpText() {
        $html = [];
 
        foreach ( $this->getHelpMessages() as $msg ) {
            if ( $msg instanceof HtmlArmor ) {
                $html[] = HtmlArmor::getHtml( $msg );
            } else {
                $msg = $this->getMessage( $msg );
                if ( $msg->exists() ) {
                    $html[] = $msg->parse();
                }
            }
        }
 
        return $html ? implode( $this->msg( 'word-separator' )->escaped(), $html ) : null;
    }
 
    private function getDescriptionMessages(): array {
        if ( isset( $this->mParams['description-message'] ) ) {
            return [ $this->mParams['description-message'] ];
        }
 
        if ( isset( $this->mParams['description-messages'] ) ) {
            return $this->mParams['description-messages'];
        }
 
        if ( isset( $this->mParams['description-raw'] ) ) {
            return [ new HtmlArmor( $this->mParams['description-raw'] ) ];
        }
 
        return [];
    }
 
    public function getDescriptionText(): ?string {
        $html = [];
 
        foreach ( $this->getDescriptionMessages() as $msg ) {
            if ( $msg instanceof HtmlArmor ) {
                $html[] = HtmlArmor::getHtml( $msg );
            } else {
                $msg = $this->getMessage( $msg );
                if ( $msg->exists() ) {
                    $html[] = $msg->parse();
                }
            }
        }
 
        return $html ? implode( $this->msg( 'word-separator' )->escaped(), $html ) : null;
    }
 
    public function isHelpInline() {
        return $this->mParams['help-inline'] ?? true;
    }
 
    public function getErrorsAndErrorClass( $value ) {
        $errors = $this->validate( $value, $this->mParent->mFieldData );
 
        if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
            return [ '', '' ];
        }
 
        return [ self::formatErrors( $errors ), 'mw-htmlform-invalid-input' ];
    }
 
    public function getErrorsRaw( $value ) {
        $errors = $this->validate( $value, $this->mParent->mFieldData );
 
        if ( is_bool( $errors ) || !$this->mParent->wasSubmitted() ) {
            return [];
        }
 
        if ( !is_array( $errors ) ) {
            $errors = [ $errors ];
        }
        foreach ( $errors as &$error ) {
            if ( $error instanceof Message ) {
                $error = $error->parse();
            }
        }
 
        return $errors;
    }
 
    public function getLabel() {
        return $this->mLabel ?? '';
    }
 
    public function getLabelHtml( $cellAttributes = [] ) {
        # Don't output a for= attribute for labels with no associated input.
        # Kind of hacky here, possibly we don't want these to be <label>s at all.
        $for = $this->needsLabel() ? [ 'for' => $this->mID ] : [];
 
        $labelValue = trim( $this->getLabel() );
        $hasLabel = $labelValue !== '' && $labelValue !== "\u{00A0}" && $labelValue !== '&#160;';
 
        $displayFormat = $this->mParent->getDisplayFormat();
        $horizontalLabel = $this->mParams['horizontal-label'] ?? false;
 
        if ( $displayFormat === 'table' ) {
            return Html::rawElement( 'td',
                    [ 'class' => 'mw-label' ] + $cellAttributes,
                    Html::rawElement( 'label', $for, $labelValue ) );
        } elseif ( $hasLabel || $this->mShowEmptyLabels ) {
            if ( $displayFormat === 'div' && !$horizontalLabel ) {
                return Html::rawElement( 'div',
                        [ 'class' => 'mw-label' ] + $cellAttributes,
                        Html::rawElement( 'label', $for, $labelValue ) );
            } else {
                return Html::rawElement( 'label', $for, $labelValue );
            }
        }
 
        return '';
    }
 
    public function getDefault() {
        return $this->mDefault ?? null;
    }
 
    public function getTooltipAndAccessKey() {
        if ( empty( $this->mParams['tooltip'] ) ) {
            return [];
        }
 
        return Linker::tooltipAndAccesskeyAttribs( $this->mParams['tooltip'] );
    }
 
    public function getTooltipAndAccessKeyOOUI() {
        if ( empty( $this->mParams['tooltip'] ) ) {
            return [];
        }
 
        return [
            'title' => Linker::titleAttrib( $this->mParams['tooltip'] ),
            'accessKey' => Linker::accesskey( $this->mParams['tooltip'] ),
        ];
    }
 
    public function getAttributes( array $list ) {
        static $boolAttribs = [ 'disabled', 'required', 'autofocus', 'multiple', 'readonly' ];
 
        $ret = [];
        foreach ( $list as $key ) {
            if ( $key === 'disabled' ) {
                if ( $this->isDisabledNoJs( $this->mParent->mFieldData ) ) {
                    $ret[$key] = '';
                }
            } elseif ( in_array( $key, $boolAttribs ) ) {
                if ( !empty( $this->mParams[$key] ) ) {
                    $ret[$key] = '';
                }
            } elseif ( isset( $this->mParams[$key] ) ) {
                $ret[$key] = $this->mParams[$key];
            }
        }
 
        return $ret;
    }
 
    private function lookupOptionsKeys( $options, $needsParse ) {
        $ret = [];
        $langCode = $this->mParent->getLanguageCode()->toBcp47Code();
        foreach ( $options as $key => $value ) {
            $msg = $this->msg( $key );
            $msgAsText = $needsParse ? $msg->parse() : $msg->plain();
            if ( array_key_exists( $msgAsText, $ret ) ) {
                LoggerFactory::getInstance( 'translation-problem' )->error(
                    'The option that uses the message key {msg_key_one} has the same translation as ' .
                    'another option in {lang}. This means that {msg_key_one} will not be used as an option.',
                    [
                        'msg_key_one' => $key,
                        'lang' => $langCode,
                    ]
                );
                continue;
            }
            $ret[$msgAsText] = is_array( $value )
                ? $this->lookupOptionsKeys( $value, $needsParse )
                : strval( $value );
        }
        return $ret;
    }
 
    public static function forceToStringRecursive( $array ) {
        if ( is_array( $array ) ) {
            return array_map( self::forceToStringRecursive( ... ), $array );
        } else {
            return strval( $array );
        }
    }
 
    public function getOptions() {
        if ( $this->mOptions === false ) {
            if ( array_key_exists( 'options-messages', $this->mParams ) ) {
                $needsParse = $this->mParams['options-messages-parse'] ?? false;
                if ( $needsParse ) {
                    $this->mOptionsLabelsNotFromMessage = true;
                }
                $this->mOptions = $this->lookupOptionsKeys( $this->mParams['options-messages'], $needsParse );
            } elseif ( array_key_exists( 'options', $this->mParams ) ) {
                $this->mOptionsLabelsNotFromMessage = true;
                $this->mOptions = self::forceToStringRecursive( $this->mParams['options'] );
            } elseif ( array_key_exists( 'options-message', $this->mParams ) ) {
                $message = $this->getMessage( $this->mParams['options-message'] )->inContentLanguage()->plain();
                $this->mOptions = Html::listDropdownOptions( $message );
            } else {
                $this->mOptions = null;
            }
        }
 
        return $this->mOptions;
    }
 
    public function getOptionsOOUI() {
        $oldoptions = $this->getOptions();
 
        if ( $oldoptions === null ) {
            return null;
        }
 
        return Html::listDropdownOptionsOoui( $oldoptions );
    }
 
    public static function flattenOptions( $options ) {
        $flatOpts = [];
 
        foreach ( $options as $value ) {
            if ( is_array( $value ) ) {
                $flatOpts = array_merge( $flatOpts, self::flattenOptions( $value ) );
            } else {
                $flatOpts[] = $value;
            }
        }
 
        return $flatOpts;
    }
 
    protected static function formatErrors( $errors ) {
        if ( is_array( $errors ) && count( $errors ) === 1 ) {
            $errors = array_shift( $errors );
        }
 
        if ( is_array( $errors ) ) {
            foreach ( $errors as &$error ) {
                $error = Html::rawElement( 'li', [],
                    $error instanceof Message ? $error->parse() : $error
                );
            }
            $errors = Html::rawElement( 'ul', [], implode( "\n", $errors ) );
        } elseif ( $errors instanceof Message ) {
            $errors = $errors->parse();
        }
 
        return Html::errorBox( $errors );
    }
 
    protected function getMessage( $value ) {
        $message = Message::newFromSpecifier( $value );
        $message->setContext( $this->mParent );
        return $message;
    }
 
    public function skipLoadData( $request ) {
        return !empty( $this->mParams['nodata'] );
    }
 
    public function needsJSForHtml5FormValidation() {
        // This is probably more restrictive than it needs to be, but better safe than sorry
        return (bool)$this->mCondState;
    }
 
    protected function escapeLabel( $label ) {
        return $this->mOptionsLabelsNotFromMessage
            ? $label : htmlspecialchars( $label, ENT_NOQUOTES );
    }
 
    protected function makeLabelSnippet( $label ) {
        return $this->mOptionsLabelsNotFromMessage
            ? new \OOUI\HtmlSnippet( $label ) : $label;
    }
}
 
class_alias( HTMLFormField::class, 'HTMLFormField' );