Class Translator
Translator to translate the message.
Constants
-
stringPLURAL_PREFIX ¶'p:'
Property Summary
-
$fallback protected
Cake\I18n\Translator|nullA fallback translator.
-
$formatter protected
Cake\I18n\FormatterInterfaceThe formatter to use when translating messages.
-
$locale protected
stringThe locale being used for translations.
-
$package protected
Cake\I18n\PackageThe Package containing keys and translations.
Method Summary
-
__construct() public
Constructor
-
getMessage() protected
Gets the message translation by its key.
-
getPackage() public
Returns the translator package
-
resolveContext() protected
Resolve a message's context structure.
-
translate() public
Translates the message formatting any placeholders
Method Detail
__construct() ¶ public
__construct(string $locale, Cake\I18n\Package $package, Cake\I18n\FormatterInterface $formatter, Cake\I18n\Translator|null $fallback = null)Constructor
Parameters
-
string$locale The locale being used.
-
Cake\I18n\Package$package The Package containing keys and translations.
-
Cake\I18n\FormatterInterface$formatter A message formatter.
-
Cake\I18n\Translator|null$fallback optional A fallback translator.
getMessage() ¶ protected
getMessage(string $key): mixedGets the message translation by its key.
Parameters
-
string$key The message key.
Returns
mixedgetPackage() ¶ public
getPackage(): Cake\I18n\PackageReturns the translator package
Returns
Cake\I18n\PackageresolveContext() ¶ protected
resolveContext(string $key, array $message, array $vars): array|stringResolve a message's context structure.
Parameters
-
string$key The message key being handled.
-
array$message The message content.
-
array$vars The variables containing the
_contextkey.
Returns
array|stringtranslate() ¶ public
translate(string $key, array $tokensValues = []): stringTranslates the message formatting any placeholders
Parameters
-
string$key The message key.
-
array$tokensValues optional Token values to interpolate into the message.
Returns
stringProperty Detail
$formatter ¶ protected
The formatter to use when translating messages.
Type
Cake\I18n\FormatterInterface