1. class
  2. Symfony
  3. Bundle
  4. FrameworkBundle
  5. Translation
  6. Translator

Translator

class Translator extends Translator implements WarmableInterface

Translator.

Methods

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

Constructor.

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Sets the ConfigCache factory to use.

from Translator
addLoader(string $format, LoaderInterface $loader)

Adds a Loader.

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

Adds a Resource.

from Translator
setLocale(string $locale)

Sets the current locale.

from Translator
string
getLocale()

Returns the current locale.

from Translator
setFallbackLocale(string|array $locales) deprecated

Sets the fallback locale(s).

from Translator
setFallbackLocales(array $locales)

Sets the fallback locales.

from Translator
array
getFallbackLocales()

Gets the fallback locales.

from Translator
string
trans(string $id, array $parameters = array(), string|null $domain = null, string|null $locale = null)

Translates the given message.

from Translator
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.

from Translator
MessageCatalogueInterface
getCatalogue(string|null $locale = null)

Gets the catalogue by locale.

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

Collects all messages for the given locale.

from Translator
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.

from Translator
warmUp(string $cacheDir)

Warms up the cache.

Details

at line line 56
__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

in Translator at line line 95
setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Sets the ConfigCache factory to use.

Parameters

ConfigCacheFactoryInterface $configCacheFactory

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

Adds a Loader.

Parameters

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

in Translator at line line 121
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 line 141
setLocale(string $locale)

Sets the current locale.

Parameters

string $locale The locale

Exceptions

InvalidArgumentException If the locale contains invalid characters

in Translator at line line 150
string getLocale()

Returns the current locale.

Return Value

string The locale

in Translator at line line 164
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

in Translator at line line 178
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 line 195
array getFallbackLocales()

Gets the fallback locales.

Return Value

array $locales The fallback locales

in Translator at line line 203
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

in Translator at line line 215
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

in Translator at line line 239
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 line 273
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

in Translator at line line 347
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

at line line 78
warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory