Page MenuHomeWickedGov Phorge
Files F1425751

ListParam.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

ListParam.php
View Options

<?php
namespace Wikimedia\Message;
use InvalidArgumentException;
use MediaWiki\Json\JsonDeserializer;
/**
* 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}>";
}
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 [
$this->type => $this->value,
'type' => $this->listType,
];
}
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>!
if ( count( $json ) !== 2 || !isset( $json[ParamType::LIST] ) || !isset( $json['type'] ) ) {
throw new InvalidArgumentException( 'Invalid format' );
}
return new self( $json['type'], $json[ParamType::LIST] );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 11:56 (19 h, 48 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
88/b1/fe85fc8cc8322c1a69c2f5b513cf
Default Alt Text
ListParam.php (2 KB)

Event Timeline