XmlSelect.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Xml;
 
use MediaWiki\Html\Html;
 
class XmlSelect {
    private array $options = [];
    private $default;
    private string $tagName = 'select';
    private array $attributes = [];
 
    public function __construct( $name = false, $id = false, $default = false ) {
        if ( $name ) {
            $this->setAttribute( 'name', $name );
        }
 
        if ( $id ) {
            $this->setAttribute( 'id', $id );
        }
 
        $this->default = $default;
    }
 
    public function setDefault( $default ): void {
        $this->default = $default;
    }
 
    public function setTagName( string $tagName ): void {
        wfDeprecated( __METHOD__, '1.45' );
        $this->tagName = $tagName;
    }
 
    public function setAttribute( string $name, $value ): void {
        $this->attributes[$name] = $value;
    }
 
    public function getAttribute( string $name ) {
        return $this->attributes[$name] ?? null;
    }
 
    public function addOption( string $label, $value = false ): void {
        $value = $value !== false ? $value : $label;
        $this->options[] = [ $label => $value ];
    }
 
    public function addOptions( array $options ): void {
        $this->options[] = $options;
    }
 
    public static function formatOptions( array $options, $default = false ): string {
        $data = '';
 
        foreach ( $options as $label => $value ) {
            if ( is_array( $value ) ) {
                $contents = self::formatOptions( $value, $default );
                $data .= Html::rawElement( 'optgroup', [ 'label' => $label ], $contents ) . "\n";
            } else {
                // If $default is an array, then the <select> probably has the multiple attribute,
                // so we should check if each $value is in $default, rather than checking if
                // $value is equal to $default.
                $selected = is_array( $default ) ? in_array( $value, $default ) : $value === $default;
                $data .= Html::element(
                    'option',
                    [ 'value' => $value, 'selected' => $selected ],
                    $label
                );
            }
        }
 
        return $data;
    }
 
    public function getHTML(): string {
        $contents = '';
 
        foreach ( $this->options as $options ) {
            $contents .= self::formatOptions( $options, $this->default );
        }
 
        return Html::rawElement( $this->tagName, $this->attributes, rtrim( $contents ) );
    }
 
    public static function parseOptionsMessage( string $msg ): array {
        $options = [];
        foreach ( explode( ',', $msg ) as $option ) {
            $parts = explode( ':', $option, 2 );
            // Normalize options that only have one part.
            $options[ trim( $parts[0] ) ] = trim( $parts[1] ?? $parts[0] );
        }
        return $options;
    }
}
class_alias( XmlSelect::class, 'XmlSelect' );