W3cubDocs

/CakePHP 4.1

Class IcuFormatter

A formatter that will interpolate variables using the MessageFormatter class

Namespace: Cake\I18n\Formatter

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 $message, array $vars)

Does the actual formatting using the MessageFormatter class

Parameters

string $locale

The locale in which the message is presented.

string $message

The message to be translated

array $vars

The list of values to interpolate in the message

Returns

string

The formatted message

Throws

Aura\Intl\Exception\CannotInstantiateFormatter
if any error occurred while parsing the message
Aura\Intl\Exception\CannotFormat
If any error related to the passed variables is found

format() public 

format(mixed $locale, mixed $string, array $tokenValues)

Returns a string with all passed variables interpolated into the original message. Variables are interpolated using the MessageFormatter class.

Parameters

string $locale

The locale in which the message is presented.

string $string

The message to be translated

array $tokenValues

The list of values to interpolate in the message

Returns

string

The formatted message

Throws

Aura\Intl\Exception\CannotFormat

Aura\Intl\Exception\CannotInstantiateFormatter

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.I18n.Formatter.IcuFormatter.html