Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Elgg\I18n\TranslatorInterface Interface Reference

WARNING: API IN FLUX. More...

Inheritance diagram for Elgg\I18n\TranslatorInterface:
Elgg\I18n\MessageTranslator

Public Member Functions

 translate ($key, array $args=[], Locale $locale=null)
 Given a message key, returns a best-effort translated string. More...
 

Detailed Description

WARNING: API IN FLUX.

DO NOT USE DIRECTLY.

Can "translate" language keys into various human-readable, localized strings.

TODO(ewinslow): Remove the "Interface" suffix

Since
1.11

private

Definition at line 15 of file TranslatorInterface.php.

Member Function Documentation

Elgg\I18n\TranslatorInterface::translate (   $key,
array  $args = [],
Locale  $locale = null 
)

Given a message key, returns a best-effort translated string.

If the translator doesn't know how to translate into the specified locale, it can try translating into a related or similar locale (e.g. en-US => en).

If no locale is specified, or if no translation can be found for the specified locale, the translator may choose to fall back to some other language(s).

It should never throw exceptions, since lack of translation should never be cause to bring down an app or cancel a request. However, implementations may log warnings to alert admins that requested language strings are missing.

Parameters
string$keyA key identifying the message to translate.
array$argsAn array of arguments with which to format the message.
Locale$localeOptionally, the standard language code (defaults to site/user default, then English)
Returns
string The final, best-effort translation.

Implemented in Elgg\I18n\MessageTranslator.


The documentation for this interface was generated from the following file: