DataMwError.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

DataMwError.php
View Options

	<?php
	declare( strict_types = 1 );

	namespace Wikimedia\Parsoid\NodeData;

	use Wikimedia\JsonCodec\JsonCodecable;
	use Wikimedia\JsonCodec\JsonCodecableTrait;

	/**
	* Localizable errors, stored in data-mw.
	*/
	class DataMwError implements JsonCodecable {
	use JsonCodecableTrait;

	/**
	* The error name, as a localizable key.
	*/
	public string $key;

	/**
	* An unlocalized version of the error name, as a fallback.
	*/
	public ?string $message;

	/**
	* Optional parameters for the error message.
	* These should all be codecable.
	*/
	public array $params;

	public function __construct( string $key, array $params = [], ?string $message = null ) {
	$this->key = $key;
	$this->params = $params;
	$this->message = $message;
	}

	/** @inheritDoc */
	public function toJsonArray(): array {
	$result = [ 'key' => $this->key ];
	if ( $this->message !== null ) {
	$result['message'] = $this->message;
	}
	if ( $this->params !== [] ) {
	$result['params'] = $this->params;
	}
	return $result;
	}

	/** @inheritDoc */
	public static function newFromJsonArray( array $json ): DataMwError {
	return new DataMwError( $json['key'], $json['params'] ?? [], $json['message'] ?? null );
	}
	}