Class Translator
Provides missing message behavior for CakePHP internal message formats.
Property Summary
-
$fallback protected
Aura\Intl\TranslatorInterfaceA fallback translator.
-
$formatter protected
Aura\Intl\FormatterInterfaceThe formatter to use when translating messages.
-
$locale protected
stringThe locale being used for translations.
-
$package protected
Aura\Intl\PackageThe Package containing keys and translations.
Method Summary
-
__construct() public
Constructor
-
getMessage() protected
Gets the message translation by its key.
-
getPackage() public
An object of type Package
-
resolveContext() protected
Resolve a message's context structure.
-
translate() public
Translates the message formatting any placeholders
Method Detail
__construct() ¶ public
__construct(string $locale, Aura\Intl\Package $package, Aura\Intl\FormatterInterface $formatter, Aura\Intl\TranslatorInterface|null $fallback = null)Constructor
Parameters
-
string$locale The locale being used.
-
Aura\Intl\Package$package The Package containing keys and translations.
-
Aura\Intl\FormatterInterface$formatter A message formatter.
-
Aura\Intl\TranslatorInterface|null$fallback optional A fallback translator.
getMessage() ¶ protected
getMessage(string $key): string|boolGets the message translation by its key.
Parameters
-
string$key The message key.
Returns
string|boolThe message translation string, or false if not found.
getPackage() ¶ public
getPackage(): Aura\Intl\PackageAn object of type Package
Returns
Aura\Intl\PackageresolveContext() ¶ protected
resolveContext(string $key, string|array $message, array $vars): stringResolve a message's context structure.
Parameters
-
string$key The message key being handled.
-
string|array$message The message content.
-
array$vars The variables containing the
_contextkey.
Returns
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
stringThe translated message with tokens replaced.
Property Detail
$formatter ¶ protected
The formatter to use when translating messages.
Type
Aura\Intl\FormatterInterface