1. class
  2. Symfony
  3. \
  4. Bundle
  5. \
  6. FrameworkBundle
  7. \
  8. Translation
  9. \
  10. Translator

Translator

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(), array $options = array())

Constructor.

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

No description

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.

setLocale(string $locale)

Sets the current locale.

from Translator
string
getLocale()

Returns the current locale.

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) deprecated

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
getLoaders()

Gets the loaders.

from Translator
loadCatalogue(string $locale)

No description

from Translator
initializeCatalogue(string $locale)

No description

computeFallbackLocales($locale)

No description

from Translator
assertValidLocale(string $locale)

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

from Translator
warmUp(string $cacheDir)

Warms up the cache.

initialize()

No description

Details

__construct(ContainerInterface $container, MessageFormatterInterface $formatter, string $defaultLocale, 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
MessageFormatterInterface $formatter
string $defaultLocale
array $loaderIds An array of loader Ids
array $options An array of options

Exceptions

InvalidArgumentException

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

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

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 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) deprecated

deprecated since Symfony 4.2, use the trans() method instead with a %count% parameter

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

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

protected array getLoaders()

Gets the loaders.

Return Value

array LoaderInterface[]

protected loadCatalogue(string $locale)

Parameters

string $locale

protected initializeCatalogue(string $locale)

Parameters

string $locale

protected computeFallbackLocales($locale)

Parameters

$locale

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

warmUp(string $cacheDir)

Warms up the cache.

Parameters

string $cacheDir The cache directory

protected initialize()