Translator

class Translator implements TranslatorInterface, TranslatorBagInterface

Translator.

Methods

	__construct(string $locale, MessageSelector $selector = null, string\|null $cacheDir = null, bool $debug = false) Constructor.
	setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory) Sets the ConfigCache factory to use.
	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.

Details

__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

setConfigCacheFactory(ConfigCacheFactoryInterface $configCacheFactory)

Sets the ConfigCache factory to use.

Parameters

ConfigCacheFactoryInterface

$configCacheFactory

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

InvalidArgumentException

If the locale contains invalid characters

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

setFallbackLocales(array $locales)

Sets the fallback locales.

Parameters

array

$locales

The fallback locales

Exceptions

InvalidArgumentException

If a locale contains invalid characters

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

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 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

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

Links:

http://api.symfony.com/master/Symfony/Component/Translation/Translator.html

doc_Symfony

2016-10-28 06:35:23

Comments