Value object representing a message for i18n with alternative machine-readable data. More...

Inheritance diagram for Wikimedia\Message\DataMessageValue:

Collaboration diagram for Wikimedia\Message\DataMessageValue:

[legend]

Public Member Functions
	__construct ( $key, $params=[], $code=null, array $data=null)
	Stable to call.

	dump ()
	Dump the object for testing/debugging.

	getCode ()
	Get the message code.

	getData ()
	Get the message's structured data.

Public Member Functions inherited from Wikimedia\Message\MessageValue
	__construct ( $key, $params=[])
	Stable to call.

	bitrateParams (... $values)
	Chainable mutator which adds parameters which are a number of bits per second (ParamType::BITRATE).

	commaListParams (... $values)
	Chainable mutator which adds comma lists (ListType::COMMA).

	expiryParams (... $values)
	Chainable mutator which adds parameters which are an expiry timestamp (ParamType::EXPIRY).

	getKey ()
	Get the message key.

	getParams ()
	Get the parameter array.

	listParamsOfType ( $listType,... $values)
	Chainable mutator which adds list parameters with a common type.

	longDurationParams (... $values)
	Chainable mutator which adds parameters which are a duration specified in seconds (ParamType::DURATION_LONG).

	numParams (... $values)
	Chainable mutator which adds numeric parameters (ParamType::NUM).

	params (... $values)
	Chainable mutator which adds text parameters and MessageParam parameters.

	pipeListParams (... $values)
	Chainable mutator which adds pipe lists (ListType::PIPE).

	plaintextParams (... $values)
	Chainable mutator which adds plaintext parameters (ParamType::PLAINTEXT).

	rawParams (... $values)
	Chainable mutator which adds "raw" parameters (ParamType::RAW).

	semicolonListParams (... $values)
	Chainable mutator which adds semicolon lists (ListType::SEMICOLON).

	shortDurationParams (... $values)
	Chainable mutator which adds parameters which are a duration specified in seconds (ParamType::DURATION_SHORT).

	sizeParams (... $values)
	Chainable mutator which adds parameters which are a number of bytes (ParamType::SIZE).

	textListParams (... $values)
	Chainable mutator which adds natural-language lists (ListType::AND).

	textParams (... $values)
	Chainable mutator which adds parameters of type text (ParamType::TEXT).

	textParamsOfType ( $type,... $values)
	Chainable mutator which adds text parameters with a common type.

Static Public Member Functions
static	new ( $key, $params=[], $code=null, array $data=null)
	Static constructor for easier chaining of `->params()` methods.

Static Public Member Functions inherited from Wikimedia\Message\MessageValue
static	new ( $key, $params=[])
	Static constructor for easier chaining of `->params()` methods.

Private Attributes
string	$code

array null	$data

Detailed Description

Value object representing a message for i18n with alternative machine-readable data.

This augments a MessageValue with an additional machine-readable code and structured data. The intended use is to facilitate error reporting in APIs.

For example, a MessageValue reporting an "integer out of range" error might use one of three message keys, depending on whether there is a minimum, a maximum, or both. But an API would likely want to use one code for all three cases, and would likely want the endpoints represented along the lines of ‘[ 'min’ => 1, 'max' => 10 ]rather than [ 0 => new ScalarParam( ParamType::TEXT, 1 ), 1 => new ScalarParam( ParamType::TEXT, 10 ) ]`.

DataMessageValues are pure value objects and are safely newable.

@newable

Definition at line 23 of file DataMessageValue.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Message\DataMessageValue::__construct	(		$key,
			$params = `[]`,
			$code = `null`,
		array	$data = `null`
	)

Stable to call.

Parameters

string	$key
	(MessageParam\|MessageValue\|string\|int\|float)[]	$params
string \| null	$code	String representing the concept behind this message.
array \| null	$data	Structured data representing the concept behind this message.