HTMLMultiSelectField.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\HTMLForm\Field;
 
use MediaWiki\Html\Html;
use MediaWiki\HTMLForm\HTMLFormField;
use MediaWiki\HTMLForm\HTMLNestedFilterable;
use MediaWiki\HTMLForm\OOUIHTMLForm;
use MediaWiki\Request\WebRequest;
use MediaWiki\Xml\Xml;
use RuntimeException;
 
class HTMLMultiSelectField extends HTMLFormField implements HTMLNestedFilterable {
    private $mPlaceholder;
 
    public function __construct( $params ) {
        parent::__construct( $params );
 
        // If the disabled-options parameter is not provided, use an empty array
        if ( !isset( $this->mParams['disabled-options'] ) ) {
            $this->mParams['disabled-options'] = [];
        }
 
        if ( isset( $params['dropdown'] ) ) {
            $this->mClass .= ' mw-htmlform-dropdown';
            if ( isset( $params['placeholder'] ) ) {
                $this->mPlaceholder = $params['placeholder'];
            } elseif ( isset( $params['placeholder-message'] ) ) {
                $this->mPlaceholder = $this->msg( $params['placeholder-message'] )->text();
            }
        }
 
        if ( isset( $params['flatlist'] ) ) {
            $this->mClass .= ' mw-htmlform-flatlist';
        }
    }
 
    public function validate( $value, $alldata ) {
        $p = parent::validate( $value, $alldata );
 
        if ( $p !== true ) {
            return $p;
        }
 
        if ( !is_array( $value ) ) {
            return false;
        }
 
        // Reject nested arrays (T274955)
        $value = array_filter( $value, 'is_scalar' );
 
        if ( isset( $this->mParams['max'] ) && ( count( $value ) > $this->mParams['max'] ) ) {
            return $this->msg( 'htmlform-multiselect-toomany', $this->mParams['max'] );
        }
 
        # If all options are valid, array_intersect of the valid options
        # and the provided options will return the provided options.
        $validOptions = HTMLFormField::flattenOptions( $this->getOptions() );
 
        $validValues = array_intersect( $value, $validOptions );
        if ( count( $validValues ) == count( $value ) ) {
            return true;
        } else {
            return $this->msg( 'htmlform-select-badoption' );
        }
    }
 
    public function getInputHTML( $value ) {
        $value = HTMLFormField::forceToStringRecursive( $value );
        $html = $this->formatOptions( $this->getOptions(), $value );
 
        return $html;
    }
 
    public function formatOptions( $options, $value ) {
        $html = '';
 
        $attribs = $this->getAttributes( [ 'disabled', 'tabindex' ] );
 
        foreach ( $options as $label => $info ) {
            if ( is_array( $info ) ) {
                $html .= Html::rawElement( 'h1', [], $label ) . "\n";
                $html .= $this->formatOptions( $info, $value );
            } else {
                $thisAttribs = [
                    'id' => "{$this->mID}-$info",
                    'value' => $info,
                ];
                if ( in_array( $info, $this->mParams['disabled-options'], true ) ) {
                    $thisAttribs['disabled'] = 'disabled';
                }
                $checked = in_array( $info, $value, true );
 
                $checkbox = $this->getOneCheckbox( $checked, $attribs + $thisAttribs, $label );
 
                $html .= ' ' . Html::rawElement(
                    'div',
                    [ 'class' => 'mw-htmlform-flatlist-item' ],
                    $checkbox
                );
            }
        }
 
        return $html;
    }
 
    protected function getOneCheckbox( $checked, $attribs, $label ) {
        if ( $this->mParent instanceof OOUIHTMLForm ) {
            throw new RuntimeException( __METHOD__ . ' is not supported' );
        } else {
            $elementFunc = [ Html::class, $this->mOptionsLabelsNotFromMessage ? 'rawElement' : 'element' ];
            $checkbox =
                Xml::check( "{$this->mName}[]", $checked, $attribs ) .
                "\u{00A0}" .
                call_user_func( $elementFunc,
                    'label',
                    [ 'for' => $attribs['id'] ],
                    $label
                );
            return $checkbox;
        }
    }
 
    public function getOptionsOOUI() {
        // @phan-suppress-previous-line PhanPluginNeverReturnMethod
        // Sections make this difficult. See getInputOOUI().
        throw new RuntimeException( __METHOD__ . ' is not supported' );
    }
 
    public function getInputOOUI( $value ) {
        $this->mParent->getOutput()->addModules( 'oojs-ui-widgets' );
 
        // Reject nested arrays (T274955)
        $value = array_filter( $value, 'is_scalar' );
 
        $hasSections = false;
        $optionsOouiSections = [];
        $options = $this->getOptions();
        // If the options are supposed to be split into sections, each section becomes a separate
        // CheckboxMultiselectInputWidget.
        foreach ( $options as $label => $section ) {
            if ( is_array( $section ) ) {
                $optionsOouiSections[ $label ] = Html::listDropdownOptionsOoui( $section );
                unset( $options[$label] );
                $hasSections = true;
            }
        }
        // If anything remains in the array, they are sectionless options. Put them in a separate widget
        // at the beginning.
        if ( $options ) {
            $optionsOouiSections = array_merge(
                [ '' => Html::listDropdownOptionsOoui( $options ) ],
                $optionsOouiSections
            );
        }
        '@phan-var array[][] $optionsOouiSections';
 
        $out = [];
        foreach ( $optionsOouiSections as $sectionLabel => $optionsOoui ) {
            $attr = [];
            $attr['name'] = "{$this->mName}[]";
 
            $attr['value'] = $value;
 
            $options = $optionsOoui;
            foreach ( $options as &$option ) {
                $option['disabled'] = in_array( $option['data'], $this->mParams['disabled-options'], true );
            }
            if ( $this->mOptionsLabelsNotFromMessage ) {
                foreach ( $options as &$option ) {
                    $option['label'] = new \OOUI\HtmlSnippet( $option['label'] );
                }
            }
            unset( $option );
            $attr['options'] = $options;
 
            $attr += \OOUI\Element::configFromHtmlAttributes(
                $this->getAttributes( [ 'disabled', 'tabindex' ] )
            );
 
            if ( $this->mClass !== '' ) {
                $attr['classes'] = [ $this->mClass ];
            }
 
            $widget = new \OOUI\CheckboxMultiselectInputWidget( $attr );
            if ( $sectionLabel ) {
                $out[] = new \OOUI\FieldsetLayout( [
                    'items' => [ $widget ],
                    // @phan-suppress-next-line SecurityCheck-XSS Key is html, taint cannot track that
                    'label' => new \OOUI\HtmlSnippet( $sectionLabel ),
                ] );
            } else {
                $out[] = $widget;
            }
        }
 
        if ( !$hasSections && $out ) {
            $firstFieldData = $out[0]->getData() ?: [];
            if ( $this->mPlaceholder ) {
                $firstFieldData['placeholder'] = $this->mPlaceholder;
            }
            if ( isset( $this->mParams['max'] ) ) {
                $firstFieldData['tagLimit'] = $this->mParams['max'];
            }
            $out[0]->setData( $firstFieldData );
            // Directly return the only OOUI\CheckboxMultiselectInputWidget.
            // This allows it to be made infusable and later tweaked by JS code.
            return $out[0];
        }
 
        return implode( '', $out );
    }
 
    public function loadDataFromRequest( $request ) {
        $fromRequest = $request->getArray( $this->mName, [] );
        // Fetch the value in either one of the two following case:
        // - we have a valid submit attempt (form was just submitted)
        // - we have a value (an URL manually built by the user, or GET form with no wpFormIdentifier)
        if ( $this->isSubmitAttempt( $request ) || $fromRequest ) {
            // Checkboxes are just not added to the request arrays if they're not checked,
            // so it's perfectly possible for there not to be an entry at all
            // @phan-suppress-next-line PhanTypeMismatchReturnNullable getArray does not return null
            return $fromRequest;
        } else {
            // That's ok, the user has not yet submitted the form, so show the defaults
            return $this->getDefault();
        }
    }
 
    public function getDefault() {
        return $this->mDefault ?? [];
    }
 
    public function filterDataForSubmit( $data ) {
        $data = HTMLFormField::forceToStringRecursive( $data );
        $options = HTMLFormField::flattenOptions( $this->getOptions() );
        $forcedOn = array_intersect( $this->mParams['disabled-options'], $this->getDefault() );
 
        $res = [];
        foreach ( $options as $opt ) {
            $res["$opt"] = in_array( $opt, $forcedOn, true ) || in_array( $opt, $data, true );
        }
 
        return $res;
    }
 
    protected function needsLabel() {
        return false;
    }
}
 
class_alias( HTMLMultiSelectField::class, 'HTMLMultiSelectField' );