MediaWiki master
Wikimedia\Message Namespace Reference

Classes

class  DataMessageValue
 Value object representing a message for i18n with alternative machine-readable data. More...
 
interface  IMessageFormatterFactory
 A simple factory providing a message formatter for a given language code. More...
 
interface  ITextFormatter
 
class  ListParam
 Value object representing a message parameter that consists of a list of values. More...
 
class  MessageParam
 Value object representing a message parameter with one of the types from {. More...
 
interface  MessageSpecifier
 
class  MessageValue
 Value object representing a message for i18n. More...
 
class  ScalarParam
 Value object representing a message parameter holding a single value. More...
 

Enumerations

enum  ListType : string { values }
 The constants used to specify list types. More...
 
enum  ParamType : string { values }
 The constants used to specify parameter types. More...
 

Enumeration Type Documentation

◆ ListType

The constants used to specify list types.

The values of the constants are an unstable implementation detail.

Enumerator
values 

A comma-separated list.

A simple text string or another MessageValue, not otherwise formatted.

A semicolon-separated list A pipe-separated list A natural-language list separated by "and" Return the ListTypes, as an array of string flag values.

Returns
list<string>

A number, to be formatted using local digits and separators A number of seconds, to be formatted as natural language text. The value will be output exactly. A number of seconds, to be formatted as natural language text in an abbreviated way. The output will be rounded to an appropriate magnitude. An expiry time.

The input is either a timestamp in one of the formats accepted by the Wikimedia\Timestamp library, or "infinity" if the thing doesn't expire.

The output is a date and time in local format, or a string representing an "infinite" expiry. A date time in one of the formats accepted by the Wikimedia\Timestamp library.

The output is a date and time in local format. A date in one of the formats accepted by the Wikimedia\Timestamp library.

The output is a date in local format. A time in one of the formats accepted by the Wikimedia\Timestamp library.

The output is a time in local format. User Group

Since
1.38 A number of bytes. The output will be rounded to an appropriate magnitude. A number of bits per second. The output will be rounded to an appropriate magnitude. A list of values. Must be used with ListParam. A text parameter which is substituted after formatter processing.

The creator of the parameter and message is responsible for ensuring that the value will be safe for the intended output format, and documenting what that intended output format is. A text parameter which is substituted after formatter processing. The output will be escaped as appropriate for the output format so as to represent plain text rather than any sort of markup. Return the ParamTypes, as an array of string flag values.

Returns
list<string>

Definition at line 9 of file ListType.php.

◆ ParamType

The constants used to specify parameter types.

The values of the constants are an unstable implementation detail.

Unless otherwise noted, these should be used with an instance of ScalarParam.

Enumerator
values 

A comma-separated list.

A simple text string or another MessageValue, not otherwise formatted.

A semicolon-separated list A pipe-separated list A natural-language list separated by "and" Return the ListTypes, as an array of string flag values.

Returns
list<string>

A number, to be formatted using local digits and separators A number of seconds, to be formatted as natural language text. The value will be output exactly. A number of seconds, to be formatted as natural language text in an abbreviated way. The output will be rounded to an appropriate magnitude. An expiry time.

The input is either a timestamp in one of the formats accepted by the Wikimedia\Timestamp library, or "infinity" if the thing doesn't expire.

The output is a date and time in local format, or a string representing an "infinite" expiry. A date time in one of the formats accepted by the Wikimedia\Timestamp library.

The output is a date and time in local format. A date in one of the formats accepted by the Wikimedia\Timestamp library.

The output is a date in local format. A time in one of the formats accepted by the Wikimedia\Timestamp library.

The output is a time in local format. User Group

Since
1.38 A number of bytes. The output will be rounded to an appropriate magnitude. A number of bits per second. The output will be rounded to an appropriate magnitude. A list of values. Must be used with ListParam. A text parameter which is substituted after formatter processing.

The creator of the parameter and message is responsible for ensuring that the value will be safe for the intended output format, and documenting what that intended output format is. A text parameter which is substituted after formatter processing. The output will be escaped as appropriate for the output format so as to represent plain text rather than any sort of markup. Return the ParamTypes, as an array of string flag values.

Returns
list<string>

Definition at line 11 of file ParamType.php.