Translator

__construct(ContainerInterface $container, MessageSelector $selector, array $loaderIds = array(), array $options = array())

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
MessageSelector	$selector	The message selector for pluralization
array	$loaderIds	An array of loader Ids
array	$options	An array of options

Exceptions

InvalidArgumentException

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Sets the ConfigCache factory to use.

Parameters

ConfigCacheFactoryInterface

$configCacheFactory

addLoader(string $format, LoaderInterface $loader)

Adds a Loader.

Parameters

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

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

setLocale(string $locale)

Sets the current locale.

Parameters

string

$locale

The locale

Exceptions

InvalidArgumentException

If the locale contains invalid characters

string getLocale()

Returns the current locale.

Return Value

string

The locale

setFallbackLocale(string|array $locales) ^deprecated

^deprecated

since version 2.3, to be removed in 3.0. Use setFallbackLocales() instead.

Sets the fallback locale(s).

Parameters

string|array

$locales

The fallback locale(s)

Exceptions

InvalidArgumentException

If a locale contains invalid characters

setFallbackLocales(array $locales)

Sets the fallback locales.

Parameters

array

$locales

The fallback locales

Exceptions

InvalidArgumentException

If a locale contains invalid characters

array getFallbackLocales()

Gets the fallback locales.

Return Value

array

$locales The fallback locales

string trans(string $id, array $parameters = array(), 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

string transChoice(string $id, int $number, array $parameters = array(), 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 indice 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

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

array[array] getMessages(string|null $locale = null) ^deprecated

^deprecated

since version 2.8, to be removed in 3.0. Use TranslatorBagInterface::getCatalogue() method instead.

Collects all messages for the given locale.

Parameters

string|null

$locale

Locale of translations, by default is current locale

Return Value

array[array]

indexed by catalog

dumpCatalogue($locale, ConfigCacheInterface $cache)

This method is public because it needs to be callable from a closure in PHP 5.3. It should be made protected (or even private, if possible) in 3.0.

Parameters

	$locale
ConfigCacheInterface	$cache

warmUp(string $cacheDir)

Warms up the cache.

Parameters

string

$cacheDir

The cache directory