Class IcuFormatter

A formatter that will interpolate variables using the MessageFormatter class

Cake\I18n\Formatter\IcuFormatter implements Aura\Intl\FormatterInterface
Namespace: Cake\I18n\Formatter
Location: I18n/Formatter/IcuFormatter.php

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()source protected 

_formatMessage( string $locale , string|array $message , array $vars )

Does 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

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()source public 

format( string $locale , string|array $message , array $vars )

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|array $message
The message to be translated
array $vars
The list of values to interpolate in the message

Returns

string
The formatted message

© 2005–2017 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/3.4/class-Cake.I18n.Formatter.IcuFormatter.html