MediaWiki  master
MessageValue.php
Go to the documentation of this file.
1 <?php
2 
3 namespace Wikimedia\Message;
4 
5 use Stringable;
6 
18 class MessageValue {
20  private $key;
21 
23  private $params;
24 
32  public function __construct( $key, $params = [] ) {
33  $this->key = $key;
34  $this->params = [];
35  $this->params( ...$params );
36  }
37 
44  public static function new( $key, $params = [] ) {
45  return new MessageValue( $key, $params );
46  }
47 
53  public function getKey() {
54  return $this->key;
55  }
56 
62  public function getParams() {
63  return $this->params;
64  }
65 
72  public function params( ...$values ) {
73  foreach ( $values as $value ) {
74  if ( $value instanceof MessageParam ) {
75  $this->params[] = $value;
76  } else {
77  $this->params[] = new ScalarParam( ParamType::TEXT, $value );
78  }
79  }
80  return $this;
81  }
82 
90  public function textParamsOfType( $type, ...$values ) {
91  foreach ( $values as $value ) {
92  $this->params[] = new ScalarParam( $type, $value );
93  }
94  return $this;
95  }
96 
103  public function objectParams( ...$values ) {
104  foreach ( $values as $value ) {
105  $this->params[] = new ScalarParam( ParamType::OBJECT, $value );
106  }
107  return $this;
108  }
109 
118  public function listParamsOfType( $listType, ...$values ) {
119  foreach ( $values as $value ) {
120  $this->params[] = new ListParam( $listType, $value );
121  }
122  return $this;
123  }
124 
131  public function textParams( ...$values ) {
132  return $this->textParamsOfType( ParamType::TEXT, ...$values );
133  }
134 
141  public function numParams( ...$values ) {
142  return $this->textParamsOfType( ParamType::NUM, ...$values );
143  }
144 
155  public function longDurationParams( ...$values ) {
156  return $this->textParamsOfType( ParamType::DURATION_LONG, ...$values );
157  }
158 
169  public function shortDurationParams( ...$values ) {
170  return $this->textParamsOfType( ParamType::DURATION_SHORT, ...$values );
171  }
172 
180  public function expiryParams( ...$values ) {
181  return $this->textParamsOfType( ParamType::EXPIRY, ...$values );
182  }
183 
191  public function dateTimeParams( ...$values ) {
192  return $this->textParamsOfType( ParamType::DATETIME, ...$values );
193  }
194 
202  public function dateParams( ...$values ) {
203  return $this->textParamsOfType( ParamType::DATE, ...$values );
204  }
205 
213  public function timeParams( ...$values ) {
214  return $this->textParamsOfType( ParamType::TIME, ...$values );
215  }
216 
224  public function userGroupParams( ...$values ) {
225  return $this->textParamsOfType( ParamType::GROUP, ...$values );
226  }
227 
234  public function sizeParams( ...$values ) {
235  return $this->textParamsOfType( ParamType::SIZE, ...$values );
236  }
237 
245  public function bitrateParams( ...$values ) {
246  return $this->textParamsOfType( ParamType::BITRATE, ...$values );
247  }
248 
259  public function rawParams( ...$values ) {
260  return $this->textParamsOfType( ParamType::RAW, ...$values );
261  }
262 
273  public function plaintextParams( ...$values ) {
274  return $this->textParamsOfType( ParamType::PLAINTEXT, ...$values );
275  }
276 
287  public function commaListParams( ...$values ) {
288  return $this->listParamsOfType( ListType::COMMA, ...$values );
289  }
290 
301  public function semicolonListParams( ...$values ) {
302  return $this->listParamsOfType( ListType::SEMICOLON, ...$values );
303  }
304 
315  public function pipeListParams( ...$values ) {
316  return $this->listParamsOfType( ListType::PIPE, ...$values );
317  }
318 
329  public function textListParams( ...$values ) {
330  return $this->listParamsOfType( ListType::AND, ...$values );
331  }
332 
338  public function dump() {
339  $contents = '';
340  foreach ( $this->params as $param ) {
341  $contents .= $param->dump();
342  }
343  return '<message key="' . htmlspecialchars( $this->key ) . '">' .
344  $contents . '</message>';
345  }
346 }
Wikimedia\Message\ParamType\PLAINTEXT
const PLAINTEXT
A text parameter which is substituted after formatter processing.
Definition: ParamType.php:97
Wikimedia\Message\ParamType\EXPIRY
const EXPIRY
An expiry time.
Definition: ParamType.php:39
Wikimedia\Message\MessageValue\sizeParams
sizeParams(... $values)
Chainable mutator which adds parameters which are a number of bytes (ParamType::SIZE).
Definition: MessageValue.php:234
Wikimedia\Message\MessageValue\pipeListParams
pipeListParams(... $values)
Chainable mutator which adds pipe lists (ListType::PIPE).
Definition: MessageValue.php:315
Wikimedia\Message\MessageValue\textParams
textParams(... $values)
Chainable mutator which adds parameters of type text (ParamType::TEXT).
Definition: MessageValue.php:131
Wikimedia\Message\MessageValue\textListParams
textListParams(... $values)
Chainable mutator which adds natural-language lists (ListType::AND).
Definition: MessageValue.php:329
Wikimedia\Message\MessageValue\getKey
getKey()
Get the message key.
Definition: MessageValue.php:53
Wikimedia\Message\ParamType\SIZE
const SIZE
A number of bytes.
Definition: ParamType.php:75
Wikimedia\Message\MessageValue\commaListParams
commaListParams(... $values)
Chainable mutator which adds comma lists (ListType::COMMA).
Definition: MessageValue.php:287
Wikimedia\Message\ScalarParam
Value object representing a message parameter holding a single value.
Definition: ScalarParam.php:14
Wikimedia\Message\MessageValue\numParams
numParams(... $values)
Chainable mutator which adds numeric parameters (ParamType::NUM).
Definition: MessageValue.php:141
Wikimedia\Message\ListType\COMMA
const COMMA
A comma-separated list.
Definition: ListType.php:11
Wikimedia\Message\MessageValue
Value object representing a message for i18n.
Definition: MessageValue.php:18
Wikimedia\Message
Definition: DataMessageValue.php:3
Wikimedia\Message\MessageValue\getParams
getParams()
Get the parameter array.
Definition: MessageValue.php:62
Wikimedia\Message\ParamType\OBJECT
const OBJECT
For arbitrary stringable objects.
Definition: ParamType.php:72
Wikimedia\Message\ParamType\BITRATE
const BITRATE
A number of bits per second.
Definition: ParamType.php:78
Wikimedia\Message\MessageValue\dateParams
dateParams(... $values)
Chainable mutator which adds parameters which are a date timestamp (ParamType::DATE).
Definition: MessageValue.php:202
Wikimedia\Message\MessageValue\dump
dump()
Dump the object for testing/debugging.
Definition: MessageValue.php:338
Wikimedia\Message\MessageValue\bitrateParams
bitrateParams(... $values)
Chainable mutator which adds parameters which are a number of bits per second (ParamType::BITRATE).
Definition: MessageValue.php:245
Wikimedia\Message\MessageValue\textParamsOfType
textParamsOfType( $type,... $values)
Chainable mutator which adds text parameters with a common type.
Definition: MessageValue.php:90
Wikimedia\Message\MessageValue\params
params(... $values)
Chainable mutator which adds text parameters and MessageParam parameters.
Definition: MessageValue.php:72
Wikimedia\Message\ParamType\TIME
const TIME
A time in one of the formats accepted by the Wikimedia\Timestamp library.
Definition: ParamType.php:60
Wikimedia\Message\MessageValue\userGroupParams
userGroupParams(... $values)
Chainable mutator which adds parameters which are a user group (ParamType::GROUP).
Definition: MessageValue.php:224
Wikimedia\Message\ParamType\DURATION_LONG
const DURATION_LONG
A number of seconds, to be formatted as natural language text.
Definition: ParamType.php:22
Wikimedia\Message\MessageValue\$params
MessageParam[] $params
Definition: MessageValue.php:23
Wikimedia\Message\ParamType\RAW
const RAW
A text parameter which is substituted after formatter processing.
Definition: ParamType.php:90
Wikimedia\Message\MessageValue\longDurationParams
longDurationParams(... $values)
Chainable mutator which adds parameters which are a duration specified in seconds (ParamType::DURATIO...
Definition: MessageValue.php:155
Wikimedia\Message\MessageValue\dateTimeParams
dateTimeParams(... $values)
Chainable mutator which adds parameters which are a date-time timestamp (ParamType::DATETIME).
Definition: MessageValue.php:191
Wikimedia\Message\MessageValue\plaintextParams
plaintextParams(... $values)
Chainable mutator which adds plaintext parameters (ParamType::PLAINTEXT).
Definition: MessageValue.php:273
Wikimedia\Message\MessageValue\shortDurationParams
shortDurationParams(... $values)
Chainable mutator which adds parameters which are a duration specified in seconds (ParamType::DURATIO...
Definition: MessageValue.php:169
Wikimedia\Message\ParamType\GROUP
const GROUP
User Group.
Definition: ParamType.php:66
Wikimedia\Message\ParamType\DATE
const DATE
A date in one of the formats accepted by the Wikimedia\Timestamp library.
Definition: ParamType.php:53
Wikimedia\Message\MessageValue\listParamsOfType
listParamsOfType( $listType,... $values)
Chainable mutator which adds list parameters with a common type.
Definition: MessageValue.php:118
Wikimedia\Message\ListParam
Value object representing a message parameter that consists of a list of values.
Definition: ListParam.php:12
Wikimedia\Message\MessageValue\objectParams
objectParams(... $values)
Chainable mutator which adds object parameters.
Definition: MessageValue.php:103
Wikimedia\Message\ListType\PIPE
const PIPE
A pipe-separated list.
Definition: ListType.php:17
Wikimedia\Message\MessageValue\__construct
__construct( $key, $params=[])
Definition: MessageValue.php:32
Wikimedia\Message\ParamType\NUM
const NUM
A number, to be formatted using local digits and separators.
Definition: ParamType.php:16
Wikimedia\Message\ParamType\TEXT
const TEXT
A simple text string or another MessageValue, not otherwise formatted.
Definition: ParamType.php:13
Wikimedia\Message\ParamType\DURATION_SHORT
const DURATION_SHORT
A number of seconds, to be formatted as natural language text in an abbreviated way.
Definition: ParamType.php:28
Wikimedia\Message\ParamType\DATETIME
const DATETIME
A date time in one of the formats accepted by the Wikimedia\Timestamp library.
Definition: ParamType.php:46
Wikimedia\Message\ListType\AND
const AND
A natural-language list separated by "and".
Definition: ListType.php:20
Wikimedia\Message\MessageValue\semicolonListParams
semicolonListParams(... $values)
Chainable mutator which adds semicolon lists (ListType::SEMICOLON).
Definition: MessageValue.php:301
Wikimedia\Message\MessageValue\expiryParams
expiryParams(... $values)
Chainable mutator which adds parameters which are an expiry timestamp (ParamType::EXPIRY).
Definition: MessageValue.php:180
Wikimedia\Message\ListType\SEMICOLON
const SEMICOLON
A semicolon-separated list.
Definition: ListType.php:14
Wikimedia\Message\MessageValue\rawParams
rawParams(... $values)
Chainable mutator which adds "raw" parameters (ParamType::RAW).
Definition: MessageValue.php:259
Wikimedia\Message\MessageValue\$key
string $key
Definition: MessageValue.php:20
Wikimedia\Message\MessageValue\timeParams
timeParams(... $values)
Chainable mutator which adds parameters which are a time timestamp (ParamType::TIME).
Definition: MessageValue.php:213
Wikimedia\Message\MessageParam
Value object representing a message parameter that consists of a list of values.
Definition: MessageParam.php:10
$type
$type
Definition: testCompression.php:52