MessageFormatter
class MessageFormatter (View source)
MessageFormatter is a concrete class that enables users to produce concatenated, language-neutral messages. The methods supplied in this class are used to build all the messages that are seen by end users.
The MessageFormatter class assembles messages from various fragments (such as text fragments, numbers, and dates) supplied by the program. Because of the MessageFormatter class, the program does not need to know the order of the fragments. The class uses the formatting specifications for the fragments to assemble them into a message that is contained in a single string within a resource bundle. For example, MessageFormatter enables you to print the phrase "Finished printing x out of y files..." in a manner that still allows for flexibility in translation. Previously, an end user message was created as a sentence and handled as a string. This procedure created problems for localizers because the sentence structure, word order, number format and so on are very different from language to language. The language-neutral way to create messages keeps each part of the message separate and provides keys to the data. Using these keys, the MessageFormatter class can concatenate the parts of the message, localize them, and display a well-formed string to the end user. MessageFormatter takes a set of objects, formats them, and then inserts the formatted strings into the pattern at the appropriate places. Choice formats can be used in conjunction with MessageFormatter to handle plurals, match numbers, and select from an array of items. Typically, the message format will come from resources and the arguments will be dynamically set at runtime.
Methods
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Constructs a new Message Formatter
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Constructs a new Message Formatter
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Format the message
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Quick format message
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Parse input string according to pattern
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Quick parse input string
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Set the pattern used by the formatter
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the pattern used by the formatter
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the locale for which the formatter was created.
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the error code from last operation
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the error text from the last operation
Details
__construct(string $locale, string $pattern)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Constructs a new Message Formatter
static MessageFormatter|null
create(string $locale, string $pattern)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Constructs a new Message Formatter
string|false
format(array $values)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Format the message
static string|false
formatMessage(string $locale, string $pattern, array $values)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Quick format message
array|false
parse(string $string)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Parse input string according to pattern
static array|false
parseMessage(string $locale, string $pattern, string $message)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Quick parse input string
bool
setPattern(string $pattern)
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Set the pattern used by the formatter
string|false
getPattern()
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the pattern used by the formatter
string
getLocale()
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the locale for which the formatter was created.
int
getErrorCode()
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the error code from last operation
string
getErrorMessage()
(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)
Get the error text from the last operation