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 {
use JsonCodecableTrait;
/** @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 = '';
foreach ( $this->getParams() as $param ) {
$contents .= $param->dump();
}
$contents .= '';
}
if ( $this->data !== null ) {
$contents .= '' . htmlspecialchars( json_encode( $this->data ), ENT_NOQUOTES ) . '';
}
return ''
. $contents
. '';
}
public function toJsonArray(): array {
// WARNING: When changing how this class is serialized, follow the instructions
// at !
return parent::toJsonArray() + [
'code' => $this->code,
'data' => $this->data,
];
}
/** @inheritDoc */
public static function jsonClassHintFor( string $keyName ) {
// JsonStaticClassCodec invokes $className::jsonClassHintFor() so
// we need to have an explicit definition in DataMessageValue, we
// can't simply inherit the static method from MessageValue.
return parent::jsonClassHintFor( $keyName );
}
public static function newFromJsonArray( array $json ): DataMessageValue {
// WARNING: When changing how this class is serialized, follow the instructions
// at !
return new self( $json['key'], $json['params'], $json['code'], $json['data'] );
}
}