Symfony2 API
Class

Symfony\Component\Translation\Translator

class Translator implements TranslatorInterface, TranslatorBagInterface

Translator.

Methods

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

Constructor.

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)

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.

MessageCatalogueInterface getCatalogue(string|null $locale = null)

Gets the catalogue by locale.

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

Collects all messages for the given locale.

Details

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

Constructor.

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 95
public 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 112
public 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 134
public setLocale(string $locale)

Sets the current locale.

Parameters

string $locale The locale

Exceptions

InvalidArgumentException If the locale contains invalid characters

at line 145
public string getLocale()

Returns the current locale.

Return Value

string The locale

at line 161
public setFallbackLocale(string|array $locales)

Sets the fallback locale(s).

Parameters

string|array $locales The fallback locale(s)

Exceptions

InvalidArgumentException If a locale contains invalid characters

at line 175
public setFallbackLocales(array $locales)

Sets the fallback locales.

Parameters

array $locales The fallback locales

Exceptions

InvalidArgumentException If a locale contains invalid characters

at line 194
public array getFallbackLocales()

Gets the fallback locales.

Return Value

array $locales The fallback locales

at line 204
public 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 228
public 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 262
public 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

at line 292
public array[array] getMessages(string|null $locale = null)

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