MediaWiki master
|
Value object representing a message for i18n. More...
Inherits MediaWiki\Json\JsonDeserializable.
Inherited by Wikimedia\Message\DataMessageValue.
Public Member Functions | |
__construct ( $key, $params=[]) | |
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). | |
dateParams (... $values) | |
Chainable mutator which adds parameters which are a date timestamp (ParamType::DATE). | |
dateTimeParams (... $values) | |
Chainable mutator which adds parameters which are a date-time timestamp (ParamType::DATETIME). | |
dump () | |
Dump the object for testing/debugging. | |
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). | |
objectParams (... $values) | |
Chainable mutator which adds object parameters. | |
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. | |
timeParams (... $values) | |
Chainable mutator which adds parameters which are a time timestamp (ParamType::TIME). | |
toJsonArray () | |
userGroupParams (... $values) | |
Chainable mutator which adds parameters which are a user group (ParamType::GROUP). | |
Static Public Member Functions | |
static | new ( $key, $params=[]) |
Static constructor for easier chaining of ->params() methods. | |
static | newFromJsonArray (JsonDeserializer $deserializer, array $json) |
Creates a new instance of the class and initialized it from the $json array. | |
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 newable and (de)serializable.
Definition at line 21 of file MessageValue.php.
Wikimedia\Message\MessageValue::__construct | ( | $key, | |
$params = [] ) |
string | $key | |
(MessageParam|MessageValue|string|int|float)[] | $params Values that are not instances of MessageParam are wrapped using ParamType::TEXT. |
Definition at line 37 of file MessageValue.php.
References Wikimedia\Message\MessageValue\params().
Wikimedia\Message\MessageValue::bitrateParams | ( | $values | ) |
Chainable mutator which adds parameters which are a number of bits per second (ParamType::BITRATE).
int|float | ...$values |
Definition at line 252 of file MessageValue.php.
References Wikimedia\Message\ParamType\BITRATE, and Wikimedia\Message\MessageValue\textParamsOfType().
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.
(MessageParam|MessageValue|string|int|float)[] | ...$values Each value is an array of items suitable to pass as $params to ListParam::__construct() |
Definition at line 294 of file MessageValue.php.
References Wikimedia\Message\ListType\COMMA, and Wikimedia\Message\MessageValue\listParamsOfType().
Wikimedia\Message\MessageValue::dateParams | ( | $values | ) |
Chainable mutator which adds parameters which are a date timestamp (ParamType::DATE).
string | ...$values Timestamp as accepted by the Wikimedia\Timestamp library. |
Definition at line 209 of file MessageValue.php.
References Wikimedia\Message\ParamType\DATE, and Wikimedia\Message\MessageValue\textParamsOfType().
Wikimedia\Message\MessageValue::dateTimeParams | ( | $values | ) |
Chainable mutator which adds parameters which are a date-time timestamp (ParamType::DATETIME).
string | ...$values Timestamp as accepted by the Wikimedia\Timestamp library. |
Definition at line 198 of file MessageValue.php.
References Wikimedia\Message\ParamType\DATETIME, and Wikimedia\Message\MessageValue\textParamsOfType().
Wikimedia\Message\MessageValue::dump | ( | ) |
Dump the object for testing/debugging.
Reimplemented in Wikimedia\Message\DataMessageValue.
Definition at line 345 of file MessageValue.php.
References Wikimedia\Message\MessageValue\params().
Wikimedia\Message\MessageValue::expiryParams | ( | $values | ) |
Chainable mutator which adds parameters which are an expiry timestamp (ParamType::EXPIRY).
string | ...$values Timestamp as accepted by the Wikimedia\Timestamp library, or "infinity" |
Definition at line 187 of file MessageValue.php.
References Wikimedia\Message\ParamType\EXPIRY, and Wikimedia\Message\MessageValue\textParamsOfType().
Wikimedia\Message\MessageValue::getKey | ( | ) |
Get the message key.
Definition at line 58 of file MessageValue.php.
Referenced by MediaWiki\Rest\LocalizedHttpException\__construct(), MediaWiki\Message\Converter\convertMessageValue(), Wikimedia\Message\DataMessageValue\dump(), and MediaWiki\Api\Validator\ApiParamValidatorCallbacks\recordCondition().
Wikimedia\Message\MessageValue::getParams | ( | ) |
Get the parameter array.
Definition at line 67 of file MessageValue.php.
Referenced by MediaWiki\Message\Converter\convertMessageValue(), Wikimedia\Message\DataMessageValue\dump(), and MediaWiki\Api\Validator\ApiParamValidatorCallbacks\recordCondition().
Wikimedia\Message\MessageValue::listParamsOfType | ( | $listType, | |
$values ) |
Chainable mutator which adds list parameters with a common type.
string | $listType | One 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() |
Definition at line 125 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().
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.
int|float | ...$values |
Definition at line 162 of file MessageValue.php.
References Wikimedia\Message\ParamType\DURATION_LONG, and Wikimedia\Message\MessageValue\textParamsOfType().
|
static |
Static constructor for easier chaining of ->params()
methods.
string | $key | |
(MessageParam|MessageValue|string|int|float)[] | $params |
Definition at line 49 of file MessageValue.php.
References $params.
|
static |
Creates a new instance of the class and initialized it from the $json array.
JsonDeserializer | $deserializer | an instance of JsonDeserializer to use for nested properties if they need special care. |
array | $json |
Implements MediaWiki\Json\JsonDeserializable.
Reimplemented in Wikimedia\Message\DataMessageValue.
Definition at line 363 of file MessageValue.php.
Wikimedia\Message\MessageValue::numParams | ( | $values | ) |
Chainable mutator which adds numeric parameters (ParamType::NUM).
int|float | ...$values |
Definition at line 148 of file MessageValue.php.
References Wikimedia\Message\ParamType\NUM, and Wikimedia\Message\MessageValue\textParamsOfType().
Wikimedia\Message\MessageValue::objectParams | ( | $values | ) |
Chainable mutator which adds object parameters.
Stringable | ...$values stringable object values |
Definition at line 109 of file MessageValue.php.
References Wikimedia\Message\ParamType\OBJECT, Wikimedia\Message\MessageValue\params(), and wfDeprecated().
Wikimedia\Message\MessageValue::params | ( | $values | ) |
Chainable mutator which adds text parameters and MessageParam parameters.
MessageParam|MessageValue|string|int|float | ...$values |
Definition at line 77 of file MessageValue.php.
References Wikimedia\Message\MessageValue\params(), and Wikimedia\Message\ParamType\TEXT.
Referenced by Wikimedia\Message\MessageValue\__construct(), Wikimedia\Message\MessageValue\dump(), Wikimedia\Message\MessageValue\listParamsOfType(), Wikimedia\Message\MessageValue\objectParams(), Wikimedia\Message\MessageValue\params(), and Wikimedia\Message\MessageValue\textParamsOfType().
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.
(MessageParam|MessageValue|string|int|float)[] | ...$values Each value is an array of items suitable to pass as $params to ListParam::__construct() |
Definition at line 322 of file MessageValue.php.
References Wikimedia\Message\MessageValue\listParamsOfType(), and Wikimedia\Message\ListType\PIPE.
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.
string | ...$values |
Definition at line 280 of file MessageValue.php.
References Wikimedia\Message\ParamType\PLAINTEXT, and Wikimedia\Message\MessageValue\textParamsOfType().
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.
string | ...$values |
Definition at line 266 of file MessageValue.php.
References Wikimedia\Message\ParamType\RAW, and Wikimedia\Message\MessageValue\textParamsOfType().
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.
(MessageParam|MessageValue|string|int|float)[] | ...$values Each value is an array of items suitable to pass as $params to ListParam::__construct() |
Definition at line 308 of file MessageValue.php.
References Wikimedia\Message\MessageValue\listParamsOfType(), and Wikimedia\Message\ListType\SEMICOLON.
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.
int|float | ...$values |
Definition at line 176 of file MessageValue.php.
References Wikimedia\Message\ParamType\DURATION_SHORT, and Wikimedia\Message\MessageValue\textParamsOfType().
Wikimedia\Message\MessageValue::sizeParams | ( | $values | ) |
Chainable mutator which adds parameters which are a number of bytes (ParamType::SIZE).
int | ...$values |
Definition at line 241 of file MessageValue.php.
References Wikimedia\Message\ParamType\SIZE, and Wikimedia\Message\MessageValue\textParamsOfType().
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".
(MessageParam|string)[] | ...$values |
Definition at line 336 of file MessageValue.php.
References Wikimedia\Message\ListType\AND, and Wikimedia\Message\MessageValue\listParamsOfType().
Wikimedia\Message\MessageValue::textParams | ( | $values | ) |
Chainable mutator which adds parameters of type text (ParamType::TEXT).
MessageValue|string|int|float | ...$values |
Definition at line 138 of file MessageValue.php.
References Wikimedia\Message\ParamType\TEXT, and Wikimedia\Message\MessageValue\textParamsOfType().
Wikimedia\Message\MessageValue::textParamsOfType | ( | $type, | |
$values ) |
Chainable mutator which adds text parameters with a common type.
string | $type | One of the ParamType constants |
MessageValue|string|int|float | ...$values Scalar values |
Definition at line 95 of file MessageValue.php.
References Wikimedia\Message\MessageValue\params().
Referenced by Wikimedia\Message\MessageValue\bitrateParams(), Wikimedia\Message\MessageValue\dateParams(), Wikimedia\Message\MessageValue\dateTimeParams(), Wikimedia\Message\MessageValue\expiryParams(), Wikimedia\Message\MessageValue\longDurationParams(), Wikimedia\Message\MessageValue\numParams(), Wikimedia\Message\MessageValue\plaintextParams(), Wikimedia\Message\MessageValue\rawParams(), Wikimedia\Message\MessageValue\shortDurationParams(), Wikimedia\Message\MessageValue\sizeParams(), Wikimedia\Message\MessageValue\textParams(), Wikimedia\Message\MessageValue\timeParams(), and Wikimedia\Message\MessageValue\userGroupParams().
Wikimedia\Message\MessageValue::timeParams | ( | $values | ) |
Chainable mutator which adds parameters which are a time timestamp (ParamType::TIME).
string | ...$values Timestamp as accepted by the Wikimedia\Timestamp library. |
Definition at line 220 of file MessageValue.php.
References Wikimedia\Message\MessageValue\textParamsOfType(), and Wikimedia\Message\ParamType\TIME.
Wikimedia\Message\MessageValue::toJsonArray | ( | ) |
Reimplemented in Wikimedia\Message\DataMessageValue.
Definition at line 354 of file MessageValue.php.
Wikimedia\Message\MessageValue::userGroupParams | ( | $values | ) |
Chainable mutator which adds parameters which are a user group (ParamType::GROUP).
string | ...$values User Groups |
Definition at line 231 of file MessageValue.php.
References Wikimedia\Message\ParamType\GROUP, and Wikimedia\Message\MessageValue\textParamsOfType().