Docs4dev
Docs
symfony / 2.7 / symfony / component / translation / datacollectortranslator.html

DataCollectorTranslator

class DataCollectorTranslator implements TranslatorInterface, TranslatorBagInterface

Constants

MESSAGE_DEFINED
MESSAGE_MISSING
MESSAGE_EQUALS_FALLBACK

Methods

__construct(TranslatorInterface $translator)
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.
setLocale(string $locale)

Sets the current locale.
string getLocale()

Returns the current locale.
MessageCatalogueInterface getCatalogue(string|null $locale = null)

Gets the catalogue by locale.
array getFallbackLocales()

Gets the fallback locales.
__call($method, $args)

Passes through all unknown calls onto the translator object.
array getCollectedMessages()

Details

__construct(TranslatorInterface $translator)

Parameters

TranslatorInterface $translator The translator must implement TranslatorBagInterface

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

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

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

array getFallbackLocales()

Gets the fallback locales.

Return Value

array $locales The fallback locales

__call($method, $args)

Passes through all unknown calls onto the translator object.

Parameters

$method
$args

array getCollectedMessages()

Return Value

array

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.7/Symfony/Component/Translation/DataCollectorTranslator.html