MediaWiki  master
Wikimedia\Message\MessageValue Class Reference

Value object representing a message for i18n. More...

Inheritance diagram for Wikimedia\Message\MessageValue:
Collaboration diagram for Wikimedia\Message\MessageValue:

Public Member Functions

 __construct ( $key, $params=[])
 
 bitrateParams (... $values)
 Chainable mutator which adds parameters which are a number of bits per second (ParamType::BITRATE). More...
 
 commaListParams (... $values)
 Chainable mutator which adds comma lists (ListType::COMMA). More...
 
 dateParams (... $values)
 Chainable mutator which adds parameters which are a date timestamp (ParamType::DATE). More...
 
 dateTimeParams (... $values)
 Chainable mutator which adds parameters which are a date-time timestamp (ParamType::DATETIME). More...
 
 dump ()
 Dump the object for testing/debugging. More...
 
 expiryParams (... $values)
 Chainable mutator which adds parameters which are an expiry timestamp (ParamType::EXPIRY). More...
 
 getKey ()
 Get the message key. More...
 
 getParams ()
 Get the parameter array. More...
 
 listParamsOfType ( $listType,... $values)
 Chainable mutator which adds list parameters with a common type. More...
 
 longDurationParams (... $values)
 Chainable mutator which adds parameters which are a duration specified in seconds (ParamType::DURATION_LONG). More...
 
 numParams (... $values)
 Chainable mutator which adds numeric parameters (ParamType::NUM). More...
 
 objectParams (... $values)
 Chainable mutator which adds object parameters. More...
 
 params (... $values)
 Chainable mutator which adds text parameters and MessageParam parameters. More...
 
 pipeListParams (... $values)
 Chainable mutator which adds pipe lists (ListType::PIPE). More...
 
 plaintextParams (... $values)
 Chainable mutator which adds plaintext parameters (ParamType::PLAINTEXT). More...
 
 rawParams (... $values)
 Chainable mutator which adds "raw" parameters (ParamType::RAW). More...
 
 semicolonListParams (... $values)
 Chainable mutator which adds semicolon lists (ListType::SEMICOLON). More...
 
 shortDurationParams (... $values)
 Chainable mutator which adds parameters which are a duration specified in seconds (ParamType::DURATION_SHORT). More...
 
 sizeParams (... $values)
 Chainable mutator which adds parameters which are a number of bytes (ParamType::SIZE). More...
 
 textListParams (... $values)
 Chainable mutator which adds natural-language lists (ListType::AND). More...
 
 textParams (... $values)
 Chainable mutator which adds parameters of type text (ParamType::TEXT). More...
 
 textParamsOfType ( $type,... $values)
 Chainable mutator which adds text parameters with a common type. More...
 
 timeParams (... $values)
 Chainable mutator which adds parameters which are a time timestamp (ParamType::TIME). More...
 
 userGroupParams (... $values)
 Chainable mutator which adds parameters which are a user group (ParamType::GROUP). More...
 

Static Public Member Functions

static new ( $key, $params=[])
 Static constructor for easier chaining of ->params() methods. More...
 

Private Attributes

string $key
 
MessageParam[] $params
 

Detailed Description

Value object representing a message for i18n.

A MessageValue holds a key and an array of parameters. It can be converted to a string in a particular language using formatters obtained from an IMessageFormatterFactory.

MessageValues are pure value objects and are safely newable.

Stability: newable

Definition at line 18 of file MessageValue.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Message\MessageValue::__construct (   $key,
  $params = [] 
)
Stability: stable
to call
Parameters
string$key
(MessageParam|MessageValue|string|int|float)[]$params Values that are not instances of MessageParam are wrapped using ParamType::TEXT.

Definition at line 32 of file MessageValue.php.

References Wikimedia\Message\MessageValue\$key, and Wikimedia\Message\MessageValue\params().

Member Function Documentation

◆ bitrateParams()

Wikimedia\Message\MessageValue::bitrateParams (   $values)

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

Parameters
int|float...$values
Returns
$this

Definition at line 245 of file MessageValue.php.

References Wikimedia\Message\ParamType\BITRATE, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ commaListParams()

Wikimedia\Message\MessageValue::commaListParams (   $values)

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

The list parameters thus created are formatted as a comma-separated list, or some local equivalent.

Parameters
(MessageParam|MessageValue|string|int|float)[]...$values Each value is an array of items suitable to pass as $params to ListParam::__construct()
Returns
$this

Definition at line 287 of file MessageValue.php.

References Wikimedia\Message\ListType\COMMA, and Wikimedia\Message\MessageValue\listParamsOfType().

◆ dateParams()

Wikimedia\Message\MessageValue::dateParams (   $values)

Chainable mutator which adds parameters which are a date timestamp (ParamType::DATE).

Since
1.36
Parameters
string...$values Timestamp as accepted by the Wikimedia\Timestamp library.
Returns
$this

Definition at line 202 of file MessageValue.php.

References Wikimedia\Message\ParamType\DATE, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ dateTimeParams()

Wikimedia\Message\MessageValue::dateTimeParams (   $values)

Chainable mutator which adds parameters which are a date-time timestamp (ParamType::DATETIME).

Since
1.36
Parameters
string...$values Timestamp as accepted by the Wikimedia\Timestamp library.
Returns
$this

Definition at line 191 of file MessageValue.php.

References Wikimedia\Message\ParamType\DATETIME, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ dump()

Wikimedia\Message\MessageValue::dump ( )

Dump the object for testing/debugging.

Returns
string

Reimplemented in Wikimedia\Message\DataMessageValue.

Definition at line 338 of file MessageValue.php.

References Wikimedia\Message\MessageValue\params().

◆ expiryParams()

Wikimedia\Message\MessageValue::expiryParams (   $values)

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

Parameters
string...$values Timestamp as accepted by the Wikimedia\Timestamp library, or "infinity"
Returns
$this

Definition at line 180 of file MessageValue.php.

References Wikimedia\Message\ParamType\EXPIRY, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ getKey()

Wikimedia\Message\MessageValue::getKey ( )

◆ getParams()

Wikimedia\Message\MessageValue::getParams ( )

◆ listParamsOfType()

Wikimedia\Message\MessageValue::listParamsOfType (   $listType,
  $values 
)

Chainable mutator which adds list parameters with a common type.

Parameters
string$listTypeOne of the ListType constants
(MessageParam|MessageValue|string|int|float)[]...$values Each value is an array of items suitable to pass as $params to ListParam::__construct()
Returns
$this

Definition at line 118 of file MessageValue.php.

References Wikimedia\Message\MessageValue\params().

Referenced by Wikimedia\Message\MessageValue\commaListParams(), Wikimedia\Message\MessageValue\pipeListParams(), Wikimedia\Message\MessageValue\semicolonListParams(), and Wikimedia\Message\MessageValue\textListParams().

◆ longDurationParams()

Wikimedia\Message\MessageValue::longDurationParams (   $values)

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

This is similar to shorDurationParams() except that the result will be more verbose.

Parameters
int|float...$values
Returns
$this

Definition at line 155 of file MessageValue.php.

References Wikimedia\Message\ParamType\DURATION_LONG, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ new()

◆ numParams()

Wikimedia\Message\MessageValue::numParams (   $values)

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

Parameters
int|float...$values
Returns
$this

Definition at line 141 of file MessageValue.php.

References Wikimedia\Message\ParamType\NUM, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ objectParams()

Wikimedia\Message\MessageValue::objectParams (   $values)

Chainable mutator which adds object parameters.

Parameters
Stringable...$values stringable object values
Returns
$this

Definition at line 103 of file MessageValue.php.

References Wikimedia\Message\ParamType\OBJECT, and Wikimedia\Message\MessageValue\params().

◆ params()

Wikimedia\Message\MessageValue::params (   $values)

Chainable mutator which adds text parameters and MessageParam parameters.

Parameters
MessageParam|MessageValue|string|int|float...$values
Returns
$this

Definition at line 72 of file MessageValue.php.

References Wikimedia\Message\ParamType\TEXT.

Referenced by Wikimedia\Message\MessageValue\__construct(), Wikimedia\Message\MessageValue\dump(), Wikimedia\Message\MessageValue\listParamsOfType(), Wikimedia\Message\MessageValue\objectParams(), and Wikimedia\Message\MessageValue\textParamsOfType().

◆ pipeListParams()

Wikimedia\Message\MessageValue::pipeListParams (   $values)

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

The list parameters thus created are formatted as a pipe ("|") -separated list, or some local equivalent.

Parameters
(MessageParam|MessageValue|string|int|float)[]...$values Each value is an array of items suitable to pass as $params to ListParam::__construct()
Returns
$this

Definition at line 315 of file MessageValue.php.

References Wikimedia\Message\MessageValue\listParamsOfType(), and Wikimedia\Message\ListType\PIPE.

◆ plaintextParams()

Wikimedia\Message\MessageValue::plaintextParams (   $values)

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

Plaintext parameters are substituted after formatter processing. The value will be escaped by the formatter as appropriate for the target output format so as to be represented as plain text rather than as any sort of markup.

Parameters
string...$values
Returns
$this

Definition at line 273 of file MessageValue.php.

References Wikimedia\Message\ParamType\PLAINTEXT, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ rawParams()

Wikimedia\Message\MessageValue::rawParams (   $values)

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

Raw parameters are substituted after formatter processing. The caller is responsible for ensuring that the value will be safe for the intended output format, and documenting what that intended output format is.

Parameters
string...$values
Returns
$this

Definition at line 259 of file MessageValue.php.

References Wikimedia\Message\ParamType\RAW, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ semicolonListParams()

Wikimedia\Message\MessageValue::semicolonListParams (   $values)

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

The list parameters thus created are formatted as a semicolon-separated list, or some local equivalent.

Parameters
(MessageParam|MessageValue|string|int|float)[]...$values Each value is an array of items suitable to pass as $params to ListParam::__construct()
Returns
$this

Definition at line 301 of file MessageValue.php.

References Wikimedia\Message\MessageValue\listParamsOfType(), and Wikimedia\Message\ListType\SEMICOLON.

◆ shortDurationParams()

Wikimedia\Message\MessageValue::shortDurationParams (   $values)

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

This is similar to longDurationParams() except that the result will be more compact.

Parameters
int|float...$values
Returns
$this

Definition at line 169 of file MessageValue.php.

References Wikimedia\Message\ParamType\DURATION_SHORT, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ sizeParams()

Wikimedia\Message\MessageValue::sizeParams (   $values)

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

Parameters
int...$values
Returns
$this

Definition at line 234 of file MessageValue.php.

References Wikimedia\Message\ParamType\SIZE, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ textListParams()

Wikimedia\Message\MessageValue::textListParams (   $values)

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

The list parameters thus created, when formatted, are joined as in natural language. In English, this means a comma-separated list, with the last two elements joined with "and".

Parameters
(MessageParam|string)[]...$values
Returns
$this

Definition at line 329 of file MessageValue.php.

References Wikimedia\Message\ListType\AND, and Wikimedia\Message\MessageValue\listParamsOfType().

◆ textParams()

Wikimedia\Message\MessageValue::textParams (   $values)

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

Parameters
MessageValue|string|int|float...$values
Returns
$this

Definition at line 131 of file MessageValue.php.

References Wikimedia\Message\ParamType\TEXT, and Wikimedia\Message\MessageValue\textParamsOfType().

◆ textParamsOfType()

◆ timeParams()

Wikimedia\Message\MessageValue::timeParams (   $values)

Chainable mutator which adds parameters which are a time timestamp (ParamType::TIME).

Since
1.36
Parameters
string...$values Timestamp as accepted by the Wikimedia\Timestamp library.
Returns
$this

Definition at line 213 of file MessageValue.php.

References Wikimedia\Message\MessageValue\textParamsOfType(), and Wikimedia\Message\ParamType\TIME.

◆ userGroupParams()

Wikimedia\Message\MessageValue::userGroupParams (   $values)

Chainable mutator which adds parameters which are a user group (ParamType::GROUP).

Since
1.38
Parameters
string...$values User Groups
Returns
$this

Definition at line 224 of file MessageValue.php.

References Wikimedia\Message\ParamType\GROUP, and Wikimedia\Message\MessageValue\textParamsOfType().

Member Data Documentation

◆ $key

◆ $params


The documentation for this class was generated from the following file: