HTMLSelectAndOtherField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use InvalidArgumentException;
use MediaWiki\Html\Html;
use MediaWiki\Request\WebRequest;
use MediaWiki\Widget\SelectWithInputWidget;
 
class HTMLSelectAndOtherField extends HTMLSelectField {
    private const FIELD_CLASS = 'mw-htmlform-select-and-other-field';
    private $mFlatOptions;
 
    public function __construct( $params ) {
        if ( array_key_exists( 'other', $params ) ) {
            // Do nothing
        } elseif ( array_key_exists( 'other-message', $params ) ) {
            $params['other'] = $this->getMessage( $params['other-message'] )->plain();
        } else {
            $params['other'] = $this->msg( 'htmlform-selectorother-other' )->plain();
        }
 
        parent::__construct( $params );
 
        if ( $this->getOptions() === null ) {
            throw new InvalidArgumentException( 'HTMLSelectAndOtherField called without any options' );
        }
        if ( !in_array( 'other', $this->mOptions, true ) ) {
            // Have 'other' always as first element
            $this->mOptions = [ $params['other'] => 'other' ] + $this->mOptions;
        }
        $this->mFlatOptions = self::flattenOptions( $this->getOptions() );
    }
 
    public function getInputHTML( $value ) {
        $select = parent::getInputHTML( $value[1] );
 
        $textAttribs = [
            'size' => $this->getSize(),
        ];
 
        if ( isset( $this->mParams['maxlength-unit'] ) ) {
            $textAttribs['data-mw-maxlength-unit'] = $this->mParams['maxlength-unit'];
        }
 
        $allowedParams = [
            'required',
            'autofocus',
            'multiple',
            'disabled',
            'tabindex',
            'maxlength', // gets dynamic with javascript, see mediawiki.htmlform.js
            'maxlength-unit', // 'bytes' or 'codepoints', see mediawiki.htmlform.js
        ];
 
        $textAttribs += $this->getAttributes( $allowedParams );
 
        $textbox = Html::input( $this->mName . '-other', $value[2], 'text', $textAttribs );
 
        $wrapperAttribs = [
            'id' => $this->mID,
            'class' => self::FIELD_CLASS
        ];
        if ( $this->mClass !== '' ) {
            $wrapperAttribs['class'] .= ' ' . $this->mClass;
        }
        return Html::rawElement(
            'div',
            $wrapperAttribs,
            "$select<br />\n$textbox"
        );
    }
 
    protected function getOOUIModules() {
        return [ 'mediawiki.widgets.SelectWithInputWidget', 'mediawiki.widgets.visibleLengthLimit' ];
    }
 
    public function getInputOOUI( $value ) {
        $this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.SelectWithInputWidget.styles' );
 
        # TextInput
        $textAttribs = [
            'name' => $this->mName . '-other',
            'value' => $value[2],
        ];
 
        $allowedParams = [
            'required',
            'autofocus',
            'multiple',
            'disabled',
            'tabindex',
            'maxlength',
        ];
 
        $textAttribs += \OOUI\Element::configFromHtmlAttributes(
            $this->getAttributes( $allowedParams )
        );
 
        # DropdownInput
        $dropdownInputAttribs = [
            'name' => $this->mName,
            'options' => $this->getOptionsOOUI(),
            'value' => $value[1],
        ];
 
        $allowedParams = [
            'tabindex',
            'disabled',
        ];
 
        $dropdownInputAttribs += \OOUI\Element::configFromHtmlAttributes(
            $this->getAttributes( $allowedParams )
        );
 
        $disabled = false;
        if ( isset( $this->mParams[ 'disabled' ] ) && $this->mParams[ 'disabled' ] ) {
            $disabled = true;
        }
 
        $inputClasses = [ self::FIELD_CLASS ];
        if ( $this->mClass !== '' ) {
            $inputClasses = array_merge( $inputClasses, explode( ' ', $this->mClass ) );
        }
        return $this->getInputWidget( [
            'id' => $this->mID,
            'disabled' => $disabled,
            'textinput' => $textAttribs,
            'dropdowninput' => $dropdownInputAttribs,
            'or' => false,
            'required' => $this->mParams[ 'required' ] ?? false,
            'classes' => $inputClasses,
            'data' => [
                'maxlengthUnit' => $this->mParams['maxlength-unit'] ?? 'bytes'
            ],
        ] );
    }
 
    public function getInputWidget( $params ) {
        return new SelectWithInputWidget( $params );
    }
 
    public function getInputCodex( $value, $hasErrors ) {
        $select = parent::getInputCodex( $value[1], $hasErrors );
 
        // Set up attributes for the text input.
        $textInputAttribs = [
            'size' => $this->getSize(),
            'name' => $this->mName . '-other'
        ];
 
        if ( isset( $this->mParams['maxlength-unit'] ) ) {
            $textInputAttribs['data-mw-maxlength-unit'] = $this->mParams['maxlength-unit'];
        }
 
        $allowedParams = [
            'required',
            'autofocus',
            'multiple',
            'disabled',
            'tabindex',
            'maxlength', // gets dynamic with javascript, see mediawiki.htmlform.js
            'maxlength-unit', // 'bytes' or 'codepoints', see mediawiki.htmlform.js
        ];
 
        $textInputAttribs += $this->getAttributes( $allowedParams );
 
        // Get text input HTML.
        $textInput = HTMLTextField::buildCodexComponent(
            $value[2],
            $hasErrors,
            'text',
            $this->mName . '-other',
            $textInputAttribs
        );
 
        // Set up the wrapper element and return the entire component.
        $wrapperAttribs = [
            'id' => $this->mID,
            'class' => [ self::FIELD_CLASS ]
        ];
        if ( $this->mClass !== '' ) {
            $wrapperAttribs['class'][] = $this->mClass;
        }
        return Html::rawElement(
            'div',
            $wrapperAttribs,
            "$select<br />\n$textInput"
        );
    }
 
    public function getDefault() {
        $default = parent::getDefault();
 
        // Default values of empty form
        $final = '';
        $list = 'other';
        $text = '';
 
        if ( $default !== null ) {
            $final = $default;
            // Assume the default is a text value, with the 'other' option selected.
            // Then check if that assumption is correct, and update $list and $text if not.
            $text = $final;
            foreach ( $this->mFlatOptions as $option ) {
                $match = $option . $this->msg( 'colon-separator' )->inContentLanguage()->text();
                if ( str_starts_with( $final, $match ) ) {
                    $list = $option;
                    $text = substr( $final, strlen( $match ) );
                    break;
                }
            }
        }
 
        return [ $final, $list, $text ];
    }
 
    public function loadDataFromRequest( $request ) {
        if ( $request->getCheck( $this->mName ) ) {
            $list = $request->getText( $this->mName );
            $text = $request->getText( $this->mName . '-other' );
 
            // Should be built the same as in mediawiki.htmlform.js
            if ( $list == 'other' ) {
                $final = $text;
            } elseif ( !in_array( $list, $this->mFlatOptions, true ) ) {
                # User has spoofed the select form to give an option which wasn't
                # in the original offer.  Sulk...
                $final = $text;
            } elseif ( $text == '' ) {
                $final = $list;
            } else {
                $final = $list . $this->msg( 'colon-separator' )->inContentLanguage()->text() . $text;
            }
            return [ $final, $list, $text ];
        }
        return $this->getDefault();
    }
 
    public function getSize() {
        return $this->mParams['size'] ?? 45;
    }
 
    public function validate( $value, $alldata ) {
        # HTMLSelectField forces $value to be one of the options in the select
        # field, which is not useful here.  But we do want the validation further up
        # the chain
        $p = parent::validate( $value[1], $alldata );
 
        if ( $p !== true ) {
            return $p;
        }
 
        if ( isset( $this->mParams['required'] )
            && $this->mParams['required'] !== false
            && $value[0] === ''
        ) {
            return $this->msg( 'htmlform-required' );
        }
 
        return true;
    }
}
 
class_alias( HTMLSelectAndOtherField::class, 'HTMLSelectAndOtherField' );