XmlSelect.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Xml;
 
use MediaWiki\Html\Html;
 
class XmlSelect {
    protected $options = [];
    protected $default = false;
    protected $tagName = 'select';
    protected $attributes = [];
 
    public function __construct( $name = false, $id = false, $default = false ) {
        if ( $name ) {
            $this->setAttribute( 'name', $name );
        }
 
        if ( $id ) {
            $this->setAttribute( 'id', $id );
        }
 
        if ( $default !== false ) {
            $this->default = $default;
        }
    }
 
    public function setDefault( $default ) {
        $this->default = $default;
    }
 
    public function setTagName( $tagName ) {
        $this->tagName = $tagName;
    }
 
    public function setAttribute( $name, $value ) {
        $this->attributes[$name] = $value;
    }
 
    public function getAttribute( $name ) {
        return $this->attributes[$name] ?? null;
    }
 
    public function addOption( $label, $value = false ) {
        $value = $value !== false ? $value : $label;
        $this->options[] = [ $label => $value ];
    }
 
    public function addOptions( $options ) {
        $this->options[] = $options;
    }
 
    public static function formatOptions( $options, $default = false ) {
        $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 .= Xml::option( $label, $value, $selected ) . "\n";
            }
        }
 
        return $data;
    }
 
    public function getHTML() {
        $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 ) {
            // Normalize options that only have one part.
            if ( strpos( $option, ':' ) === false ) {
                $option = "$option:$option";
            }
            // Extract the two parts.
            [ $label, $value ] = explode( ':', $option );
            $options[ trim( $label ) ] = trim( $value );
        }
        return $options;
    }
}
class_alias( XmlSelect::class, 'XmlSelect' );