HTMLTitlesMultiselectField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use MediaWiki\Widget\TitlesMultiselectWidget;
 
class HTMLTitlesMultiselectField extends HTMLTitleTextField {
    public function __construct( $params ) {
        $params += [
            // This overrides the default from HTMLTitleTextField
            'required' => false,
        ];
 
        parent::__construct( $params );
    }
 
    public function loadDataFromRequest( $request ) {
        $value = $request->getText( $this->mName, $this->getDefault() ?? '' );
 
        $titlesArray = explode( "\n", $value );
        // Remove empty lines
        $titlesArray = array_values( array_filter( $titlesArray, static function ( $title ) {
            return trim( $title ) !== '';
        } ) );
        // This function is expected to return a string
        return implode( "\n", $titlesArray );
    }
 
    public function validate( $value, $alldata ) {
        if ( !$this->mParams['exists'] ) {
            return true;
        }
 
        if ( $value === null ) {
            return false;
        }
 
        // $value is a string, because HTMLForm fields store their values as strings
        $titlesArray = explode( "\n", $value );
 
        if ( isset( $this->mParams['max'] ) && ( count( $titlesArray ) > $this->mParams['max'] ) ) {
            return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
        }
 
        foreach ( $titlesArray as $title ) {
            $result = parent::validate( $title, $alldata );
            if ( $result !== true ) {
                return $result;
            }
        }
 
        return true;
    }
 
    public function getInputHTML( $value ) {
        $this->mParent->getOutput()->enableOOUI();
        return $this->getInputOOUI( $value );
    }
 
    public function getInputOOUI( $value ) {
        $this->mParent->getOutput()->addModuleStyles( 'mediawiki.widgets.TagMultiselectWidget.styles' );
 
        $params = [
            'id' => $this->mID,
            'name' => $this->mName,
            'dir' => $this->mDir,
        ];
 
        if ( isset( $this->mParams['disabled'] ) ) {
            $params['disabled'] = $this->mParams['disabled'];
        }
 
        if ( isset( $this->mParams['default'] ) ) {
            $params['default'] = $this->mParams['default'];
        }
 
        $params['placeholder'] = $this->mParams['placeholder'] ??
            $this->msg( 'mw-widgets-titlesmultiselect-placeholder' )->plain();
 
        if ( isset( $this->mParams['max'] ) ) {
            $params['tagLimit'] = $this->mParams['max'];
        }
 
        if ( isset( $this->mParams['showMissing'] ) ) {
            $params['showMissing'] = $this->mParams['showMissing'];
        }
        if ( $this->mParams['namespace'] !== false ) {
            $params['namespace'] = $this->mParams['namespace'];
        }
        $params['relative'] = $this->mParams['relative'];
        if ( isset( $this->mParams['allowEditTags'] ) ) {
            $params['allowEditTags'] = $this->mParams['allowEditTags'];
        }
 
        if ( isset( $this->mParams['input'] ) ) {
            $params['input'] = $this->mParams['input'];
        }
 
        if ( isset( $this->mParams['creatable'] ) ) {
            $params['creatable'] = $this->mParams['creatable'];
        }
 
        if ( $value !== null ) {
            // $value is a string, but the widget expects an array
            $params['default'] = $value === '' ? [] : explode( "\n", $value );
        }
 
        // Make the field auto-infusable when it's used inside a legacy HTMLForm rather than OOUIHTMLForm
        $params['infusable'] = true;
        $params['classes'] = [ 'mw-htmlform-autoinfuse' ];
 
        return $this->getInputWidget( $params );
    }
 
    protected function getInputWidget( $params ) {
        $widget = new TitlesMultiselectWidget( $params );
        $widget->setAttributes( [ 'data-mw-modules' => implode( ',', $this->getOOUIModules() ) ] );
        return $widget;
    }
 
    protected function shouldInfuseOOUI() {
        return true;
    }
 
    protected function getOOUIModules() {
        return [ 'mediawiki.widgets.TitlesMultiselectWidget' ];
    }
 
    public function getInputCodex( $value, $hasErrors ) {
        // HTMLTextAreaField defaults to 'rows' => 25, which is too big for this field
        // Use 10 instead (but allow $this->mParams to override that value)
        $textAreaField = new HTMLTextAreaField( $this->mParams + [ 'rows' => 10 ] );
        return $textAreaField->getInputCodex( $value, $hasErrors );
    }
 
}
 
class_alias( HTMLTitlesMultiselectField::class, 'HTMLTitlesMultiselectField' );