MessageValue.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\Message;
 
use Wikimedia\JsonCodec\JsonCodecable;
use Wikimedia\JsonCodec\JsonCodecableTrait;
 
class MessageValue implements MessageSpecifier, JsonCodecable {
    use JsonCodecableTrait;
 
    private string $key;
 
    private array $params;
 
    public function __construct( string $key, array $params = [] ) {
        $this->key = $key;
        $this->params = [];
        $this->params( ...$params );
    }
 
    public static function new( string $key, array $params = [] ): MessageValue {
        return new MessageValue( $key, $params );
    }
 
    public static function newFromSpecifier( MessageSpecifier $spec ): MessageValue {
        if ( $spec instanceof MessageValue ) {
            return $spec;
        }
        return new MessageValue( $spec->getKey(), $spec->getParams() );
    }
 
    public function getKey(): string {
        return $this->key;
    }
 
    public function getParams(): array {
        return $this->params;
    }
 
    public function params( ...$values ): MessageValue {
        foreach ( $values as $value ) {
            if ( $value instanceof MessageParam ) {
                $this->params[] = $value;
            } else {
                $this->params[] = new ScalarParam( ParamType::TEXT, $value );
            }
        }
        return $this;
    }
 
    public function textParamsOfType( string $type, ...$values ): MessageValue {
        foreach ( $values as $value ) {
            $this->params[] = new ScalarParam( $type, $value );
        }
        return $this;
    }
 
    public function listParamsOfType( string $listType, ...$values ): MessageValue {
        foreach ( $values as $value ) {
            $this->params[] = new ListParam( $listType, $value );
        }
        return $this;
    }
 
    public function textParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::TEXT, ...$values );
    }
 
    public function numParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::NUM, ...$values );
    }
 
    public function longDurationParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::DURATION_LONG, ...$values );
    }
 
    public function shortDurationParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::DURATION_SHORT, ...$values );
    }
 
    public function expiryParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::EXPIRY, ...$values );
    }
 
    public function dateTimeParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::DATETIME, ...$values );
    }
 
    public function dateParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::DATE, ...$values );
    }
 
    public function timeParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::TIME, ...$values );
    }
 
    public function userGroupParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::GROUP, ...$values );
    }
 
    public function sizeParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::SIZE, ...$values );
    }
 
    public function bitrateParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::BITRATE, ...$values );
    }
 
    public function rawParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::RAW, ...$values );
    }
 
    public function plaintextParams( ...$values ): MessageValue {
        return $this->textParamsOfType( ParamType::PLAINTEXT, ...$values );
    }
 
    public function commaListParams( ...$values ): MessageValue {
        return $this->listParamsOfType( ListType::COMMA, ...$values );
    }
 
    public function semicolonListParams( ...$values ): MessageValue {
        return $this->listParamsOfType( ListType::SEMICOLON, ...$values );
    }
 
    public function pipeListParams( ...$values ): MessageValue {
        return $this->listParamsOfType( ListType::PIPE, ...$values );
    }
 
    public function textListParams( ...$values ): MessageValue {
        return $this->listParamsOfType( ListType::AND, ...$values );
    }
 
    public function dump(): string {
        $contents = '';
        foreach ( $this->params as $param ) {
            $contents .= $param->dump();
        }
        return '<message key="' . htmlspecialchars( $this->key ) . '">' .
            $contents . '</message>';
    }
 
    public function toJsonArray(): array {
        // WARNING: When changing how this class is serialized, follow the instructions
        // at <https://www.mediawiki.org/wiki/Manual:Parser_cache/Serialization_compatibility>!
        return [
            'key' => $this->key,
            'params' => $this->params,
        ];
    }
 
    public static function newFromJsonArray( array $json ): MessageValue {
        // WARNING: When changing how this class is serialized, follow the instructions
        // at <https://www.mediawiki.org/wiki/Manual:Parser_cache/Serialization_compatibility>!
        return new self( $json['key'], $json['params'] );
    }
}