Class I18n

clear()source public static

clear( )

Destroys all translator instances and creates a new empty translations collection.

config()source public static

config( string $name , callable $loader )

Registers a callable object that can be used for creating new translator instances for the same translations domain. Loaders will be invoked whenever a translator object is requested for a domain that has not been configured or loaded already.

Registering loaders is useful when you need to lazily use translations in multiple different locales for the same domain, and don't want to use the built-in translation service based of gettext files.

Loader objects will receive two arguments: The domain name that needs to be built, and the locale that is requested. These objects can assemble the messages from any source, but must return an Aura\Intl\Package object.

Example:

use Cake\I18n\MessagesFileLoader;
 I18n::config('my_domain', function ($name, $locale) {
     // Load src/Locale/$locale/filename.po
     $fileLoader = new MessagesFileLoader('filename', $locale, 'po');
     return $fileLoader();
 });

You can also assemble the package object yourself:

use Aura\Intl\Package;
 I18n::config('my_domain', function ($name, $locale) {
     $package = new Package('default');
     $messages = (...); // Fetch messages for locale from external service.
     $package->setMessages($message);
     $package->setFallback('default');
     return $package;
 });

Parameters

string $name

The name of the translator to create a loader for

callable $loader

A callable object that should return a Package instance to be used for assembling a new translator.

defaultFormatter()source public static

defaultFormatter( string|null $name null )

Sets the name of the default messages formatter to use for future translator instances.

By default the default and sprintf formatters are available.

If called with no arguments, it will return the currently configured value.

Deprecated

3.5 Use getDefaultFormatter() and setDefaultFormatter().

Parameters

string|null $name optional null

The name of the formatter to use.

Returns

string
The name of the formatter.

defaultLocale()source public static

defaultLocale( )

This returns the default locale before any modifications, i.e. the value as stored in the intl.default_locale PHP setting before any manipulation by this class.

Deprecated

3.5 Use getDefaultLocale()

Returns

string

getDefaultFormatter()source public static

getDefaultFormatter( )

Returns the currently configured default formatter.

Returns

string
The name of the formatter.

getDefaultLocale()source public static

getDefaultLocale( )

Returns the default locale.

This returns the default locale before any modifications, i.e. the value as stored in the intl.default_locale PHP setting before any manipulation by this class.

Returns

string

getLocale()source public static

getLocale( )

Will return the currently configure locale as stored in the intl.default_locale PHP setting.

Returns

string
The name of the default locale.

getTranslator()source public static

getTranslator( string $name 'default' , string|null $locale null )

Returns an instance of a translator that was configured for the name and locale.

If no locale is passed then it takes the value returned by the getLocale() method.

Parameters

string $name optional 'default'

The domain of the translation messages.

string|null $locale optional null

The locale for the translator.

Returns

Aura\Intl\TranslatorInterface
The configured translator.

locale()source public static

locale( string|null $locale null )

Sets the default locale to use for future translator instances. This also affects the intl.default_locale PHP setting.

When called with no arguments it will return the currently configure locale as stored in the intl.default_locale PHP setting.

Deprecated

3.5 Use setLocale() and getLocale().

Parameters

string|null $locale optional null

The name of the locale to set as default.

Returns

string|null
The name of the default locale.

setDefaultFormatter()source public static

setDefaultFormatter( string $name )

Sets the name of the default messages formatter to use for future translator instances. By default the default and sprintf formatters are available.

Parameters

string $name

The name of the formatter to use.

setLocale()source public static

setLocale( string $locale )

Sets the default locale to use for future translator instances. This also affects the intl.default_locale PHP setting.

Parameters

string $locale

The name of the locale to set as default.

setTranslator()source public static

setTranslator( string $name , callable $loader , string|null $locale null )

Sets a translator.

Configures future translators, this is achieved by passing a callable as the last argument of this function.

Example:

I18n::setTranslator('default', function () {
     $package = new \Aura\Intl\Package();
     $package->setMessages([
         'Cake' => 'Gâteau'
     ]);
     return $package;
 }, 'fr_FR');

 $translator = I18n::getTranslator('default', 'fr_FR');
 echo $translator->translate('Cake');

You can also use the Cake\I18n\MessagesFileLoader class to load a specific file from a folder. For example for loading a my_translations.po file from the src/Locale/custom folder, you would do:

I18n::setTranslator(
 'default',
 new MessagesFileLoader('my_translations', 'custom', 'po'),
 'fr_FR'
);

Parameters

string $name

The domain of the translation messages.

callable $loader

A callback function or callable class responsible for constructing a translations package instance.

string|null $locale optional null

The locale for the translator.

translator()source public static

translator( string $name 'default' , string|null $locale null , callable $loader null )

Returns an instance of a translator that was configured for the name and passed locale. If no locale is passed then it takes the value returned by the getLocale() method.

This method can be used to configure future translators, this is achieved by passing a callable as the last argument of this function.

Example:

I18n::setTranslator('default', function () {
     $package = new \Aura\Intl\Package();
     $package->setMessages([
         'Cake' => 'Gâteau'
     ]);
     return $package;
 }, 'fr_FR');

 $translator = I18n::translator('default', 'fr_FR');
 echo $translator->translate('Cake');

You can also use the Cake\I18n\MessagesFileLoader class to load a specific file from a folder. For example for loading a my_translations.po file from the src/Locale/custom folder, you would do:

I18n::translator(
 'default',
 'fr_FR',
 new MessagesFileLoader('my_translations', 'custom', 'po');
);

Deprecated

3.5 Use getTranslator() and setTranslator()

Parameters

string $name optional 'default'

The domain of the translation messages.

string|null $locale optional null

The locale for the translator.

callable $loader optional null

A callback function or callable class responsible for constructing a translations package instance.

Returns

Aura\Intl\TranslatorInterface|null
The configured translator.

translators()source public static

translators( )

Returns the translators collection instance. It can be used for getting specific translators based of their name and locale or to configure some aspect of future translations that are not yet constructed.

Returns

Cake\I18n\TranslatorRegistry
The translators collection.

useFallback()source public static

useFallback( boolean $enable true )

Set if the domain fallback is used.

Parameters

boolean $enable optional true

flag to enable or disable fallback