Class TranslatorRegistry

Constructs and stores instances of translators that can be retrieved by name and locale.

Aura\Intl\TranslatorLocator
Extended by Cake\I18n\TranslatorRegistry
Namespace: Cake\I18n
Located at I18n/TranslatorRegistry.php

Method Detail

_fallbackLoadersource protected

_fallbackLoader( string $name , string $locale )

Returns a new translator instance for the given name and locale based of conventions.

Parameters

string $name
The translation package name.
string $locale
The locale to create the translator for.

Returns

Aura\Intl\Translator
\Aura\Intl\Translator

_getFromLoadersource protected

_getFromLoader( string $name , string $locale )

Registers a new package by passing the register loaded function for the package name.

Parameters

string $name
The name of the translator package
string $locale
The locale that should be built the package for

Returns

Aura\Intl\TranslatorInterface
A translator object.

_getTranslatorsource protected

_getTranslator( string $name , string|null $locale )

Gets a translator from the registry by package for a locale.

Parameters

string $name
The translator package to retrieve.
string|null $locale
The locale to use; if empty, uses the default locale.

Returns

Aura\Intl\TranslatorInterface
A translator object.

_partialLoadersource protected

_partialLoader( )

Returns a function that can be used as a loader for the registerLoaderMethod

Returns

callable
callable

defaultFormattersource public

defaultFormatter( string|null $name null )

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

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

Parameters

string|null $name optional null
The name of the formatter to use.

Returns

string
The name of the formatter.

getsource public

get( string $name , string|null $locale null )

Gets a translator from the registry by package for a locale.

Parameters

string $name
The translator package to retrieve.
string|null $locale optional null
The locale to use; if empty, uses the default locale.

Returns

Aura\Intl\TranslatorInterface
A translator object.

Throws

Aura\Intl\Exception
If no translator with that name could be found for the given locale.

registerLoadersource public

registerLoader( string $name , callable $loader )

Registers a loader function for a package name that will be used as a fallback in case no package with that name can be found.

Loader callbacks will get as first argument the package name and the locale as the second argument.

Parameters

string $name
The name of the translator package to register a loader for
callable $loader
A callable object that should return a Package

setCachersource public

setCacher( Cake\Cache\CacheEngine $cacher )

Sets the CacheEngine instance used to remember translators across requests.

Parameters

Cake\Cache\CacheEngine $cacher
The cacher instance.

setLoaderFallbacksource public

setLoaderFallback( string $name , callable $loader )

Set domain fallback for loader.

Parameters

string $name
The name of the loader domain
callable $loader
invokable loader

Returns

callable
loader

useFallbacksource public

useFallback( boolean $enable true )

Set if the default domain fallback is used.

Parameters

boolean $enable optional true
flag to enable or disable fallback

Properties summary

$_cachersource

protected Cake\Cache\CacheEngine

A CacheEngine object that is used to remember translator across requests.

$_defaultFormattersource

protected string

The name of the default formatter to use for newly created translators from the fallback loader

'default'

$_loaderssource

protected array

A list of loader functions indexed by domain name. Loaders are callables that are invoked as a default for building translation packages where none can be found for the combination of translator name and locale.

$_useFallbacksource

protected boolean

Use fallback-domain for translation loaders.

true

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.I18n.TranslatorRegistry.html