Page MenuHomeWickedGov Phorge

ScalarParam.php
No OneTemporary

Size
2 KB
Referenced Files
None
Subscribers
None

ScalarParam.php

<?php
namespace Wikimedia\Message;
use InvalidArgumentException;
use Stringable;
use Wikimedia\JsonCodec\JsonCodecableTrait;
/**
* Value object representing a message parameter holding a single value.
*
* Message parameter classes are pure value objects and are safely newable.
*
* @newable
*/
class ScalarParam extends MessageParam {
use JsonCodecableTrait;
/**
* Construct a text parameter
*
* @stable to call.
*
* @param string $type One of the ParamType constants.
* @param string|int|float|MessageSpecifier|Stringable $value
*/
public function __construct( string $type, $value ) {
if ( !in_array( $type, ParamType::cases() ) ) {
throw new InvalidArgumentException( '$type must be one of the ParamType constants' );
}
if ( $type === ParamType::LIST ) {
throw new InvalidArgumentException(
'ParamType::LIST cannot be used with ScalarParam; use ListParam instead'
);
}
if ( $value instanceof MessageSpecifier ) {
// Ensure that $this->value is JSON-serializable, even if $value is not
$value = MessageValue::newFromSpecifier( $value );
} elseif ( is_object( $value ) && (
$value instanceof Stringable || is_callable( [ $value, '__toString' ] )
) ) {
// TODO: Remove separate '__toString' check above once we drop PHP 7.4
$value = (string)$value;
} elseif ( !is_string( $value ) && !is_numeric( $value ) ) {
$valType = get_debug_type( $value );
if ( $value === null || is_bool( $value ) ) {
trigger_error(
"Using $valType as a message parameter was deprecated in MediaWiki 1.43",
E_USER_DEPRECATED
);
$value = (string)$value;
} else {
throw new InvalidArgumentException(
"Scalar parameter must be a string, number, Stringable, or MessageSpecifier; got $valType"
);
}
}
$this->type = $type;
$this->value = $value;
}
public function dump(): string {
if ( $this->value instanceof MessageValue ) {
$contents = $this->value->dump();
} else {
$contents = htmlspecialchars( (string)$this->value );
}
return "<$this->type>" . $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,
];
}
public static function newFromJsonArray( array $json ): ScalarParam {
// 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 ) !== 1 ) {
throw new InvalidArgumentException( 'Invalid format' );
}
$type = key( $json );
$value = current( $json );
return new self( $type, $value );
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 21 2026, 04:35 (12 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
97/4a/fed7938f54d841ddaf14a2ff3583
Default Alt Text
ScalarParam.php (2 KB)

Event Timeline