class Translator implements TranslatorInterface

Translator.

Methods

__construct(string $locale, MessageSelector $selector = null)

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) 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 $domain = null, string $locale = null)

Translates the given message.

string
transChoice(string $id, integer $number, array $parameters = array(), string $domain = null, string $locale = null)

Translates the given choice message by choosing a translation according to a number.

Details

at line line 64
__construct(string $locale, MessageSelector $selector = null)

Constructor.

Parameters

string $locale The locale
MessageSelector $selector The message selector for pluralization

at line line 78
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 93
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

at line line 113
setLocale(string $locale)

Sets the current locale.

Parameters

string $locale The locale

at line line 123
string getLocale()

Returns the current locale.

Return Value

string The locale

at line line 137
setFallbackLocale(string|array $locales) deprecated

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

Sets the fallback locale(s).

Parameters

string|array $locales The fallback locale(s)

at line line 149
setFallbackLocales(array $locales)

Sets the fallback locales.

Parameters

array $locales The fallback locales

at line line 164
array getFallbackLocales()

Gets the fallback locales.

Return Value

array $locales The fallback locales

at line line 174
string trans(string $id, array $parameters = array(), string $domain = null, string $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 $domain The domain for the message
string $locale The locale

Return Value

string The translated string

at line line 196
string transChoice(string $id, integer $number, array $parameters = array(), string $domain = null, string $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)
integer $number The number to use to find the indice of the message
array $parameters An array of parameters for the message
string $domain The domain for the message
string $locale The locale

Return Value

string The translated string