Translator
class Translator implements TranslatorInterface, TranslatorBagInterface
Properties
Methods
|
__construct(string|null $locale, MessageFormatterInterface $formatter = null, string $cacheDir = null, bool $debug = false) |
|
|
setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory) |
|
|
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. |
|
|
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 |
getLoaders() Gets the loaders. |
|
|
loadCatalogue(string $locale) |
|
|
initializeCatalogue(string $locale) |
|
|
computeFallbackLocales($locale) |
|
|
assertValidLocale(string $locale) Asserts that the locale is valid, throws an Exception if not. |
|
Details
__construct(string|null $locale, MessageFormatterInterface $formatter = null, string $cacheDir = null, bool $debug = false)
Parameters
Exceptions
Parameters
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
setLocale(string $locale)
Sets the current locale.
Parameters
| string |
$locale |
The locale |
Exceptions
string getLocale()
Returns the current locale.
Return Value
setFallbackLocales(array $locales)
Sets the fallback locales.
Parameters
| array |
$locales |
The fallback locales |
Exceptions
array getFallbackLocales()
Gets the fallback locales.
Return Value
| array |
$locales 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
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
Gets the catalogue by locale.
Parameters
| string|null |
$locale |
The locale or null to use the default |
Return Value
Exceptions
protected array getLoaders()
Gets the loaders.
Return Value
protected loadCatalogue(string $locale)
Parameters
protected initializeCatalogue(string $locale)
Parameters
protected computeFallbackLocales($locale)
Parameters
protected assertValidLocale(string $locale)
Asserts that the locale is valid, throws an Exception if not.
Parameters
| string |
$locale |
Locale to tests |
Exceptions