Page MenuHomeWickedGov Phorge
Files F4114821

ScalarParam.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ScalarParam.php
View Options

<?php
namespace Wikimedia\Message;
use InvalidArgumentException;
use MediaWiki\Json\JsonDeserializer;
use Stringable;
/**
* Value object representing a message parameter holding a single value.
*
* Message parameter classes are pure value objects and are safely newable.
*
* When using the deprecated ParamType::OBJECT, the parameter value
* should be (de)serializable, otherwise (de)serialization of the
* ScalarParam object will fail.
*
* @newable
*/
class ScalarParam extends MessageParam {
/**
* Construct a text parameter
*
* @stable to call.
*
* @param string $type One of the ParamType constants.
* Using ParamType::OBJECT is deprecated since 1.43.
* @param string|int|float|MessageSpecifier|Stringable $value
*/
public function __construct( $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 ( $type === ParamType::OBJECT ) {
wfDeprecatedMsg( 'Using ParamType::OBJECT was deprecated in MediaWiki 1.43', '1.43' );
} elseif ( $value instanceof MessageSpecifier ) {
// Ensure that $this->value is JSON-serializable, even if $value is not
// (but don't do it when using ParamType::OBJECT, since those objects may not expect it)
$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 ) ) {
wfDeprecatedMsg( "Using $valType as message parameter was deprecated in MediaWiki 1.43", '1.43' );
$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() {
if ( $this->value instanceof MessageValue ) {
$contents = $this->value->dump();
} else {
$contents = htmlspecialchars( (string)$this->value );
}
return "<{$this->type}>" . $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,
];
}
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 ) !== 1 ) {
throw new InvalidArgumentException( 'Invalid format' );
}
// Use a dummy loop to get the first (and only) key/value pair in the array.
foreach ( $json as $type => $value ) {
return new self( $type, $value );
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 00:29 (5 d, 1 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
a5/12/20d4c39473a178d6fa729822e5bc
Default Alt Text
ScalarParam.php (3 KB)

Event Timeline