wiki.techinc.nl/includes/libs/Message/ScalarParam.php
Brad Jorsch d07a2e2c8d libs/Message: Improve parameter validation
Validate that all parameters are of expected types, not just list
parameter values.

Change-Id: Id47c6f9ad1cf3a3dfc1f6d0c3766ba607c4ef633
2019-10-17 15:57:54 -04:00

42 lines
1.2 KiB
PHP

<?php
namespace Wikimedia\Message;
/**
* Value object representing a message parameter holding a single value.
*
* Message parameter classes are pure value objects and are safely newable.
*/
class ScalarParam extends MessageParam {
/**
* Construct a text parameter
*
* @param string $type One of the ParamType constants.
* @param string|int|float|MessageValue $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 ) {
$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( $this->value );
}
return "<{$this->type}>" . $contents . "</{$this->type}>";
}
}