e662614f95
Implicitly marking parameter $... as nullable is deprecated in php8.4, the explicit nullable type must be used instead Created with autofix from Ide15839e98a6229c22584d1c1c88c690982e1d7a Break one long line in SpecialPage.php Bug: T376276 Change-Id: I807257b2ba1ab2744ab74d9572c9c3d3ac2a968e
111 lines
3.3 KiB
PHP
111 lines
3.3 KiB
PHP
<?php
|
|
|
|
namespace Wikimedia\Message;
|
|
|
|
use MediaWiki\Json\JsonDeserializer;
|
|
|
|
/**
|
|
* Value object representing a message for i18n with alternative
|
|
* machine-readable data.
|
|
*
|
|
* This augments a MessageValue with an additional machine-readable code and
|
|
* structured data. The intended use is to facilitate error reporting in APIs.
|
|
*
|
|
* For example, a MessageValue reporting an "integer out of range" error might
|
|
* use one of three message keys, depending on whether there is a minimum, a
|
|
* maximum, or both. But an API would likely want to use one code for all three
|
|
* cases, and would likely want the endpoints represented along the lines of
|
|
* `[ 'min' => 1, 'max' => 10 ]` rather than
|
|
* `[ 0 => new ScalarParam( ParamType::TEXT, 1 ), 1 => new ScalarParam( ParamType::TEXT, 10 ) ]`.
|
|
*
|
|
* DataMessageValues are pure value objects and are newable and (de)serializable.
|
|
*
|
|
* @newable
|
|
*/
|
|
class DataMessageValue extends MessageValue {
|
|
/** @var string */
|
|
private $code;
|
|
|
|
/** @var array|null */
|
|
private $data;
|
|
|
|
/**
|
|
* @stable to call
|
|
*
|
|
* @param string $key
|
|
* @param (MessageParam|MessageValue|string|int|float)[] $params
|
|
* @param string|null $code String representing the concept behind
|
|
* this message.
|
|
* @param array|null $data Structured data representing the concept
|
|
* behind this message.
|
|
*/
|
|
public function __construct( $key, $params = [], $code = null, ?array $data = null ) {
|
|
parent::__construct( $key, $params );
|
|
|
|
$this->code = $code ?? $key;
|
|
$this->data = $data;
|
|
}
|
|
|
|
/**
|
|
* Static constructor for easier chaining of `->params()` methods
|
|
* @param string $key
|
|
* @param (MessageParam|MessageValue|string|int|float)[] $params
|
|
* @param string|null $code
|
|
* @param array|null $data
|
|
* @return DataMessageValue
|
|
*/
|
|
public static function new( $key, $params = [], $code = null, ?array $data = null ) {
|
|
return new DataMessageValue( $key, $params, $code, $data );
|
|
}
|
|
|
|
/**
|
|
* Get the message code
|
|
* @return string
|
|
*/
|
|
public function getCode() {
|
|
return $this->code;
|
|
}
|
|
|
|
/**
|
|
* Get the message's structured data
|
|
* @return array|null
|
|
*/
|
|
public function getData() {
|
|
return $this->data;
|
|
}
|
|
|
|
public function dump() {
|
|
$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>';
|
|
}
|
|
|
|
protected 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( JsonDeserializer $deserializer, array $json ) {
|
|
// 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'] );
|
|
}
|
|
}
|