class Translator extends Translator implements WarmableInterface

Translator.

Properties

protected MessageCatalogueInterface[] $catalogues from Translator
protected $container
protected $loaderIds
protected $options

Methods

__construct(ContainerInterface $container, MessageFormatterInterface $formatter, string $defaultLocale, array $loaderIds = [], array $options = [])

Constructor.

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

No description

addLoader(string $format, LoaderInterface $loader)

Adds a Loader.

addResource(string $format, mixed $resource, string $locale, string $domain = null)

Adds a Resource.

setLocale(string $locale)

Sets the current locale.

string
getLocale()

Returns the current locale.

setFallbackLocales(array $locales)

Sets the fallback locales.

array
getFallbackLocales()

Gets the fallback locales.

string
trans(string $id, array $parameters = [], string|null $domain = null, string|null $locale = null)

Translates the given message.

string
transChoice(string $id, int $number, array $parameters = [], string|null $domain = null, string|null $locale = null)

Translates the given choice message by choosing a translation according to a number.

getCatalogue(string|null $locale = null)

Gets the catalogue by locale.

array
getLoaders()

Gets the loaders.

loadCatalogue(string $locale)

No description

initializeCatalogue(string $locale)

No description

computeFallbackLocales($locale)

No description

assertValidLocale(string $locale)

Asserts that the locale is valid, throws an Exception if not.

warmUp(string $cacheDir)

Warms up the cache.

initialize()

No description

Details

at line 68
__construct(ContainerInterface $container, MessageFormatterInterface $formatter, string $defaultLocale, array $loaderIds = [], array $options = [])

Constructor.

Available options:

  • cache_dir: The cache directory (or null to disable caching)
  • debug: Whether to enable debugging or not (false by default)
  • resource_files: List of translation resources available grouped by locale.

Parameters

ContainerInterface $container A ContainerInterface instance
MessageFormatterInterface $formatter
string $defaultLocale
array $loaderIds An array of loader Ids
array $options An array of options

Exceptions

InvalidArgumentException

in Translator at line 92
setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Parameters

ConfigCacheFactoryInterface $configCacheFactory

in Translator at line 103
addLoader(string $format, LoaderInterface $loader)

Adds a Loader.

Parameters

string $format The name of the loader (see addResource())
LoaderInterface $loader A LoaderInterface instance

at line 106
addResource(string $format, mixed $resource, string $locale, string $domain = null)

Adds a Resource.

Parameters

string $format The name of the loader (see addLoader())
mixed $resource The resource name
string $locale The locale
string $domain The domain

Exceptions

InvalidArgumentException If the locale contains invalid characters

in Translator at line 138
setLocale(string $locale)

Sets the current locale.

Parameters

string $locale The locale

Exceptions

InvalidArgumentException If the locale contains invalid characters

in Translator at line 147
string getLocale()

Returns the current locale.

Return Value

string The locale

in Translator at line 159
setFallbackLocales(array $locales)

Sets the fallback locales.

Parameters

array $locales The fallback locales

Exceptions

InvalidArgumentException If a locale contains invalid characters

in Translator at line 176
array getFallbackLocales()

Gets the fallback locales.

Return Value

array The fallback locales

in Translator at line 184
string trans(string $id, array $parameters = [], string|null $domain = null, string|null $locale = null)

Translates the given message.

Parameters

string $id The message id (may also be an object that can be cast to string)
array $parameters An array of parameters for the message
string|null $domain The domain for the message or null to use the default
string|null $locale The locale or null to use the default

Return Value

string The translated string

Exceptions

InvalidArgumentException If the locale contains invalid characters

in Translator at line 196
string transChoice(string $id, int $number, array $parameters = [], string|null $domain = null, string|null $locale = null)

Translates the given choice message by choosing a translation according to a number.

Parameters

string $id The message id (may also be an object that can be cast to string)
int $number The number to use to find the index of the message
array $parameters An array of parameters for the message
string|null $domain The domain for the message or null to use the default
string|null $locale The locale or null to use the default

Return Value

string The translated string

Exceptions

InvalidArgumentException If the locale contains invalid characters

in Translator at line 224
MessageCatalogueInterface getCatalogue(string|null $locale = null)

Gets the catalogue by locale.

Parameters

string|null $locale The locale or null to use the default

Return Value

MessageCatalogueInterface

Exceptions

InvalidArgumentException If the locale contains invalid characters

in Translator at line 244
protected array getLoaders()

Gets the loaders.

Return Value

array LoaderInterface[]

in Translator at line 252
protected loadCatalogue(string $locale)

Parameters

string $locale

at line 117
protected initializeCatalogue(string $locale)

Parameters

string $locale

in Translator at line 393
protected computeFallbackLocales($locale)

Parameters

$locale

in Translator at line 418
protected assertValidLocale(string $locale)

Asserts that the locale is valid, throws an Exception if not.

Parameters

string $locale Locale to tests

Exceptions

InvalidArgumentException If the locale contains invalid characters

at line 88
warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory

at line 123
protected initialize()