Class IcuFormatter
A formatter that will interpolate variables using the MessageFormatter class
Method Summary
-
_formatMessage() protected
Does the actual formatting using the MessageFormatter class
-
format() public
Returns a string with all passed variables interpolated into the original message. Variables are interpolated using the MessageFormatter class.
Method Detail
_formatMessage() ¶ protected
_formatMessage(string $locale, string|array $message, array $vars): stringDoes the actual formatting using the MessageFormatter class
Parameters
-
string$locale The locale in which the message is presented.
-
string|array$message The message to be translated
-
array$vars The list of values to interpolate in the message
Returns
stringThrows
Aura\Intl\Exception\CannotInstantiateFormatterif any error occurred while parsing the message
Aura\Intl\Exception\CannotFormatIf any error related to the passed variables is found
format() ¶ public
format(string $locale, string|array $message, array $vars): stringReturns a string with all passed variables interpolated into the original message. Variables are interpolated using the MessageFormatter class.
If an array is passed in $message, it will trigger the plural selection
routine. Plural forms are selected depending on the locale and the _count
key passed in $vars.
Parameters
-
string$locale The locale in which the message is presented.
-
string|array$message The message to be translated
-
array$vars The list of values to interpolate in the message
Returns
string