class Translator implements TranslatorInterface, TranslatorBagInterface

Methods

__construct(string $locale, MessageSelector $selector = null, string|null $cacheDir = null, bool $debug = false)

No description

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.

setFallbackLocale(string|array $locales) deprecated

Sets the fallback locale(s).

setFallbackLocales(array $locales)

Sets the fallback locales.

array
getFallbackLocales()

Gets the fallback locales.

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

Translates the given message.

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.

getCatalogue(string|null $locale = null)

Gets the catalogue by locale.

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

Collects all messages for the given locale.

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.

Details

at line line 78
__construct(string $locale, MessageSelector $selector = null, string|null $cacheDir = null, bool $debug = false)

Parameters

string $locale The locale
MessageSelector $selector The message selector for pluralization
string|null $cacheDir The directory to use for the cache
bool $debug Use cache in debug mode ?

Exceptions

InvalidArgumentException If a locale contains invalid characters

at line line 86
setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Parameters

ConfigCacheFactoryInterface $configCacheFactory

at line line 97
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 line 112
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

at line line 132
setLocale(string $locale)

Sets the current locale.

Parameters

string $locale The locale

Exceptions

InvalidArgumentException If the locale contains invalid characters

at line line 141
string getLocale()

Returns the current locale.

Return Value

string The locale

at line line 155
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

at line line 169
setFallbackLocales(array $locales)

Sets the fallback locales.

Parameters

array $locales The fallback locales

Exceptions

InvalidArgumentException If a locale contains invalid characters

at line line 186
array getFallbackLocales()

Gets the fallback locales.

Return Value

array $locales The fallback locales

at line line 194
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

at line line 206
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

at line line 230
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

at line line 264
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

at line line 338
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