1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Translation
  7. \
  8. TranslatorInterface

TranslatorInterface deprecated

interface TranslatorInterface implements LocaleAwareInterface

deprecated since Symfony 4.2, use Symfony\Contracts\Translation\TranslatorInterface instead

TranslatorInterface.

Methods

setLocale(string $locale)

Sets the current locale.

string
getLocale()

Returns the current locale.

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.

Details

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

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)

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