languages.php

Go to the documentation of this file.

<?php
function elgg_echo($message_key, $args = array(), $language = "") {
    return _elgg_services()->translator->translate($message_key, $args, $language);
}

function add_translation($country_code, $language_array) {
    return _elgg_services()->translator->addTranslation($country_code, $language_array);
}

function get_current_language() {
    return _elgg_services()->translator->getCurrentLanguage();
}

function get_language() {
    return _elgg_services()->translator->getLanguage();
}

function _elgg_load_translations_for_language($language) {
    global $CONFIG;

    // Try to load translations from system cache
    if (!empty($CONFIG->system_cache_enabled)) {
        $data = elgg_load_system_cache("$language.lang");
        if ($data) {
            $added = add_translation($language, unserialize($data));

            if ($added) {
                // Translations were successfully loaded from system cache
                return true;
            }
        }
    }

    // Read translations from the core languages directory
    _elgg_register_translations_for_language(dirname(dirname(dirname(__FILE__))) . "/languages/", $language);

    // Get active plugins
    $plugins = elgg_get_plugins('active');

    if (!$plugins) {
        // Active plugins were not found, so no need to register plugin translations
        return true;
    }

    foreach ($plugins as $plugin) {
        $languages_path = "{$plugin->getPath()}languages/";

        if (!is_dir($languages_path)) {
            // This plugin doesn't have anything to translate
            continue;
        }

        $language_file = "{$languages_path}{$language}.php";

        if (!file_exists($language_file)) {
            // This plugin doesn't have translations for the requested language

            $name = $plugin->getFriendlyName();
            elgg_log("Plugin $name is missing translations for $language language", 'NOTICE');

            continue;
        }

        // Register translations from the plugin languages directory
        if (!_elgg_register_translations_for_language($languages_path, $language)) {
            $msg = elgg_echo('ElggPlugin:Exception:CannotRegisterLanguages',
                            array($plugin->getID(), $plugin->guid, $languages_path));
            throw new PluginException($msg);
        }
    }

    return true;
}

function register_translations($path, $load_all = false) {
    return _elgg_services()->translator->registerTranslations($path, $load_all);
}

function _elgg_register_translations_for_language($path, $language) {
    global $CONFIG;

    $path = sanitise_filepath($path);

    // Make a note of this path just in case we need to register this language later
    if (!isset($CONFIG->language_paths)) {
        $CONFIG->language_paths = array();
    }
    $CONFIG->language_paths[$path] = true;

    $language_file = "{$path}{$language}.php";

    if (!file_exists($language_file)) {
        elgg_log("Could not find language file: $language_file", 'NOTICE');

        return false;
    }

    $result = include_once($language_file);

    elgg_log("Translations loaded from: $language_file", "INFO");

    // The old (< 1.9) translation files call add_translation() independently.
    // The new ones however just return the translations array. In this case
    // we need to add the translation here.
    if (is_array($result)) {
        return add_translation($language, $result);
    }

    return true;
}

function reload_all_translations() {
    return _elgg_services()->translator->reloadAllTranslations();
}

function get_installed_translations() {
    return _elgg_services()->translator->getInstalledTranslations();
}

function get_language_completeness($language) {
    return _elgg_services()->translator->getLanguageCompleteness($language);
}

function get_missing_language_keys($language) {
    return _elgg_services()->translator->getMissingLanguageKeys($language);
}

function elgg_language_key_exists($key, $language = 'en') {
    return _elgg_services()->translator->languageKeyExists($key, $language);
}

function _elgg_translations_init() {
    $translations = _elgg_services()->translator->getAllLanguageCodes();
    foreach ($translations as $language_code) {
        // make the js view available for each language
        elgg_extend_view("js/languages/$language_code.js", "js/languages");
    
        // register the js view for use in simplecache
        elgg_register_simplecache_view("js/languages/$language_code.js");
    }
}

return function(\Elgg\EventsService $events) {
    $events->registerHandler('init', 'system', '_elgg_translations_init');
};