DataMessageValue.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\Message;
 
use Wikimedia\JsonCodec\JsonCodecableTrait;
 
class DataMessageValue extends MessageValue {
    use JsonCodecableTrait;
 
    private string $code;
    private ?array $data;
 
    public function __construct( string $key, array $params = [], ?string $code = null, ?array $data = null ) {
        parent::__construct( $key, $params );
 
        $this->code = $code ?? $key;
        $this->data = $data;
    }
 
    public static function new(
        string $key,
        array $params = [],
        ?string $code = null,
        ?array $data = null
    ): DataMessageValue {
        return new DataMessageValue( $key, $params, $code, $data );
    }
 
    public function getCode(): string {
        return $this->code;
    }
 
    public function getData(): ?array {
        return $this->data;
    }
 
    public function dump(): string {
        $contents = '';
        if ( $this->getParams() ) {
            $contents = '<params>';
            foreach ( $this->getParams() as $param ) {
                $contents .= $param->dump();
            }
            $contents .= '</params>';
        }
 
        if ( $this->data !== null ) {
            $contents .= '<data>' . htmlspecialchars( json_encode( $this->data ), ENT_NOQUOTES ) . '</data>';
        }
 
        return '<datamessage key="' . htmlspecialchars( $this->getKey() ) . '"'
            . ' code="' . htmlspecialchars( $this->code ) . '">'
            . $contents
            . '</datamessage>';
    }
 
    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 parent::toJsonArray() + [
                'code' => $this->code,
                'data' => $this->data,
            ];
    }
 
    public static function newFromJsonArray( array $json ): DataMessageValue {
        // 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'], $json['code'], $json['data'] );
    }
}