Class TranslatorRegistry
Constructs and stores instances of translators that can be retrieved by name and locale.
- Aura\Intl\TranslatorLocator
-
Cake\I18n\TranslatorRegistry
Properties summary
-
$_cacherprotectedA CacheEngine object that is used to remember translator across requests.
-
$_defaultFormatterprotectedstringThe name of the default formatter to use for newly created translators from the fallback loader
-
$_fallbackLoaderprotectedstringFallback loader name -
$_loadersprotectedcallable[]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.
-
$_useFallbackprotectedbooleanUse fallback-domain for translation loaders.
Method Summary
-
__construct() public
Constructor. -
_fallbackLoader() protected
Returns a new translator instance for the given name and locale based of conventions.
-
_getFromLoader() protected
Registers a new package by passing the register loaded function for the package name.
-
_getTranslator() protected
Gets a translator from the registry by package for a locale. -
_partialLoader() protected
Returns a function that can be used as a loader for the registerLoaderMethod -
defaultFormatter() public
Sets the name of the default messages formatter to use for future translator instances.
-
get() public
Gets a translator from the registry by package for a locale. -
registerLoader() public
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.
-
setCacher() public
Sets the CacheEngine instance used to remember translators across requests.
-
setLoaderFallback() public
Set domain fallback for loader. -
useFallback() public
Set if the default domain fallback is used.
Method Detail
__construct() public ¶
__construct( Aura\Intl\PackageLocator $packages , Aura\Intl\FormatterLocator $formatters , Cake\I18n\TranslatorFactory $factory , string $locale )
Constructor.
Parameters
- Aura\Intl\PackageLocator $packages
- The package locator.
- Aura\Intl\FormatterLocator $formatters
- The formatter locator.
- Cake\I18n\TranslatorFactory $factory
A translator factory to create translator objects for the locale and package.
- string $locale
- The default locale code to use.
_fallbackLoader() 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
_getFromLoader() 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
A translator object.
_getTranslator() 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
A translator object.
_partialLoader() protected ¶
_partialLoader( )
Returns a function that can be used as a loader for the registerLoaderMethod
Returns
defaultFormatter() 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
The name of the formatter.
get() 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
A translator object.
Throws
If no translator with that name could be found for the given locale.
registerLoader() 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
setCacher() public ¶
setCacher( Cake\Cache\CacheEngine $cacher )
Sets the CacheEngine instance used to remember translators across requests.
Parameters
-
Cake\Cache\CacheEngine$cacher - The cacher instance.
setLoaderFallback() 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
loader
useFallback() 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 detail
$_cacher ¶
Cake\Cache\CacheEngine
A CacheEngine object that is used to remember translator across requests.
$_defaultFormatter ¶
The name of the default formatter to use for newly created translators from the fallback loader
'default'