92 lines
2.6 KiB
PHP
92 lines
2.6 KiB
PHP
<?php
|
|
|
|
namespace Wikimedia\Message;
|
|
|
|
use InvalidArgumentException;
|
|
use Wikimedia\JsonCodec\Hint;
|
|
|
|
/**
|
|
* Value object representing a message parameter that consists of a list of values.
|
|
*
|
|
* Message parameter classes are pure value objects and are newable and (de)serializable.
|
|
*
|
|
* @newable
|
|
*/
|
|
class ListParam extends MessageParam {
|
|
|
|
/** @var string */
|
|
private $listType;
|
|
|
|
/**
|
|
* @stable to call.
|
|
*
|
|
* @param string $listType One of the ListType constants.
|
|
* @param (MessageParam|MessageSpecifier|string|int|float)[] $elements Values in the list.
|
|
* Values that are not instances of MessageParam are wrapped using ParamType::TEXT.
|
|
*/
|
|
public function __construct( $listType, array $elements ) {
|
|
if ( !in_array( $listType, ListType::cases() ) ) {
|
|
throw new InvalidArgumentException( '$listType must be one of the ListType constants' );
|
|
}
|
|
$this->type = ParamType::LIST;
|
|
$this->listType = $listType;
|
|
$this->value = [];
|
|
foreach ( $elements as $element ) {
|
|
if ( $element instanceof MessageParam ) {
|
|
$this->value[] = $element;
|
|
} else {
|
|
$this->value[] = new ScalarParam( ParamType::TEXT, $element );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the type of the list
|
|
*
|
|
* @return string One of the ListType constants
|
|
*/
|
|
public function getListType() {
|
|
return $this->listType;
|
|
}
|
|
|
|
public function dump() {
|
|
$contents = '';
|
|
foreach ( $this->value as $element ) {
|
|
$contents .= $element->dump();
|
|
}
|
|
return "<{$this->type} listType=\"{$this->listType}\">$contents</{$this->type}>";
|
|
}
|
|
|
|
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 [
|
|
$this->type => $this->value,
|
|
'type' => $this->listType,
|
|
];
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public static function jsonClassHintFor( string $keyName ) {
|
|
// Reduce serialization overhead by eliminating the type information
|
|
// when the list consists of MessageParam instances
|
|
if ( $keyName === ParamType::LIST ) {
|
|
return Hint::build(
|
|
MessageParam::class, Hint::INHERITED,
|
|
Hint::LIST, Hint::USE_SQUARE,
|
|
Hint::ONLY_FOR_DECODE
|
|
);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
public static function newFromJsonArray( array $json ): ListParam {
|
|
// WARNING: When changing how this class is serialized, follow the instructions
|
|
// at <https://www.mediawiki.org/wiki/Manual:Parser_cache/Serialization_compatibility>!
|
|
if ( count( $json ) !== 2 || !isset( $json[ParamType::LIST] ) || !isset( $json['type'] ) ) {
|
|
throw new InvalidArgumentException( 'Invalid format' );
|
|
}
|
|
return new self( $json['type'], $json[ParamType::LIST] );
|
|
}
|
|
}
|