wiki.techinc.nl/includes/libs/Message/ScalarParam.php
TChin 349819dc5a Add Message/MessageValue user group member parameter type
* Added ParamType::OBJECT, which allows Stringable objects to be passed into MessageValue

Bug: T278482
Change-Id: Ib4990f87d4ad70b7525d7aa05c8b97e90c121674
2021-11-16 11:24:35 -05:00

49 lines
1.3 KiB
PHP

<?php
namespace Wikimedia\Message;
use Stringable;
/**
* 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 {
/**
* Construct a text parameter
*
* @stable to call.
*
* @param string $type One of the ParamType constants.
* @param string|int|float|MessageValue|Stringable $value
*/
public function __construct( $type, $value ) {
if ( $type === ParamType::LIST ) {
throw new \InvalidArgumentException(
'ParamType::LIST cannot be used with ScalarParam; use ListParam instead'
);
}
if ( !is_string( $value ) && !is_numeric( $value ) &&
!$value instanceof MessageValue && !$value instanceof Stringable ) {
$type = is_object( $value ) ? get_class( $value ) : gettype( $value );
throw new \InvalidArgumentException(
"Scalar parameter must be a string, number, or MessageValue; got $type"
);
}
$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}>";
}
}