Public Member Functions | |
| __construct () | |
| Initializes new translator. More... | |
| translate ($message_key, $args=array(), $language="") | |
| Given a message key, returns an appropriately translated full-text string. More... | |
| addTranslation ($country_code, $language_array) | |
| Add a translation. More... | |
| getCurrentLanguage () | |
| Detect the current language being used by the current site or logged in user. More... | |
| getLanguage () | |
| Gets the current language in use by the system or user. More... | |
| loadTranslations () | |
| @access private More... | |
| registerTranslations ($path, $load_all=false) | |
| When given a full path, finds translation files and loads them. More... | |
| reloadAllTranslations () | |
| Reload all translations from all registered paths. More... | |
| getInstalledTranslations () | |
| Return an array of installed translations as an associative array "two letter code" => "native language name". More... | |
| getLanguageCompleteness ($language) | |
| Return the level of completeness for a given language code (compared to english) More... | |
| getMissingLanguageKeys ($language) | |
| Return the translation keys missing from a given language, or those that are identical to the english version. More... | |
Detailed Description
Definition at line 13 of file Translator.php.
Constructor & Destructor Documentation
◆ __construct()
| Elgg\I18n\Translator::__construct | ( | ) |
Initializes new translator.
Definition at line 25 of file Translator.php.
Member Function Documentation
◆ addTranslation()
| Elgg\I18n\Translator::addTranslation | ( | $country_code, | |
| $language_array | |||
| ) |
Add a translation.
Translations are arrays in the Zend Translation array format, eg:
$english = array('message1' => 'message1', 'message2' => 'message2'); $german = array('message1' => 'Nachricht1','message2' => 'Nachricht2');
- Parameters
-
string $country_code Standard country code (eg 'en', 'nl', 'es') array $language_array Formatted array of strings
- Returns
- bool Depending on success
Definition at line 110 of file Translator.php.
◆ getCurrentLanguage()
| Elgg\I18n\Translator::getCurrentLanguage | ( | ) |
Detect the current language being used by the current site or logged in user.
- Returns
- string The language code for the site/user or "en" if not set
Definition at line 136 of file Translator.php.
◆ getInstalledTranslations()
| Elgg\I18n\Translator::getInstalledTranslations | ( | ) |
Return an array of installed translations as an associative array "two letter code" => "native language name".
- Returns
- array
Definition at line 307 of file Translator.php.
◆ getLanguage()
| Elgg\I18n\Translator::getLanguage | ( | ) |
Gets the current language in use by the system or user.
- Returns
- string The language code (eg "en") or false if not set
Definition at line 151 of file Translator.php.
◆ getLanguageCompleteness()
| Elgg\I18n\Translator::getLanguageCompleteness | ( | $language | ) |
Return the level of completeness for a given language code (compared to english)
- Parameters
-
string $language Language
- Returns
- int
Definition at line 335 of file Translator.php.
◆ getMissingLanguageKeys()
| Elgg\I18n\Translator::getMissingLanguageKeys | ( | $language | ) |
Return the translation keys missing from a given language, or those that are identical to the english version.
- Parameters
-
string $language The language
- Returns
- mixed
Definition at line 366 of file Translator.php.
◆ loadTranslations()
| Elgg\I18n\Translator::loadTranslations | ( | ) |
@access private
Definition at line 173 of file Translator.php.
◆ registerTranslations()
| Elgg\I18n\Translator::registerTranslations | ( | $path, | |
$load_all = false |
|||
| ) |
When given a full path, finds translation files and loads them.
- Parameters
-
string $path Full path bool $load_all If true all languages are loaded, if false only the current language + en are loaded
- Returns
- bool success
Definition at line 211 of file Translator.php.
◆ reloadAllTranslations()
| Elgg\I18n\Translator::reloadAllTranslations | ( | ) |
Reload all translations from all registered paths.
This is only called by functions which need to know all possible translations.
- Returns
- void
Definition at line 268 of file Translator.php.
◆ translate()
| Elgg\I18n\Translator::translate | ( | $message_key, | |
$args = array(), |
|||
$language = "" |
|||
| ) |
Given a message key, returns an appropriately translated full-text string.
- Parameters
-
string $message_key The short message code array $args An array of arguments to pass through vsprintf(). string $language Optionally, the standard language code (defaults to site/user default, then English)
- Returns
- string Either the translated string, the English string, or the original language string.
Reimplemented in Elgg\I18n\NullTranslator.
Definition at line 42 of file Translator.php.
The documentation for this class was generated from the following file:
- engine/classes/Elgg/I18n/Translator.php
