language handling More...

Inheritance diagram for ilLanguage:

Collaboration diagram for ilLanguage:

Public Member Functions
	__construct ($a_lang_key)
	Constructor read the single-language file and put this in an array text. More...

	getLangKey ()

	getDefaultLanguage ()

	txtlng ($a_module, $a_topic, $a_language)
	gets the text for a given topic in a given language if the topic is not in the list, the topic itself with "-" will be returned More...

	txt ($a_topic, $a_default_lang_fallback_mod="")
	gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be returned More...

	exists ($a_topic)
	Check if language entry exists. More...

	loadLanguageModule ($a_module)

	getInstalledLanguages ()

	getUsedTopics ()

	getUsedModules ()

	getUserLanguage ()

	toJS ($a_lang_key, ilGlobalTemplateInterface $a_tpl=null)

	toJSMap ($a_map, ilGlobalTemplateInterface $a_tpl=null)
	Transfer text to Javascript. More...

	__destruct ()
	destructor saves all language usages to db if log is enabled and ilDB exists More...

Static Public Member Functions
static	_getInstalledLanguages ()

static	_lookupEntry ($a_lang_key, $a_mod, $a_id)

static	lookupId ($a_lang_key)
	Lookup obj_id of language @global ilDB $ilDB. More...

static	getFallbackInstance ()
	Builds a global default language instance. More...

static	getGlobalInstance ()
	Builds the global language object. More...

Data Fields
	$ilias

	$text

	$lang_default

	$lang_user

	$lang_path

	$lang_key

	$lang_name

	$separator = "#:#"

	$comment_separator = "###"

	$loaded_modules

Static Protected Member Functions
static	logUsage ($a_module, $a_identifier)
	saves tupel of language module and identifier More...

static	isUsageLogEnabled ()
	checks if language usage log is enabled you need MySQL to use this function this function is automatically enabled if DEVMODE is on this function is also enabled if language_log is 1 More...

Protected Attributes
	$cached_modules = array()

	$map_modules_txt = array()

	$usage_log_enabled = false

Static Protected Attributes
static	$used_topics = array()

static	$used_modules = array()

static	$lng_log = array()

Detailed Description

language handling

this class offers the language handling for an application. it works initially on one file: languages.txt from this file the class can generate many single language files. the constructor is called with a small language abbreviation e.g. $lng = new Language("en"); the constructor reads the single-languagefile en.lang and puts this into an array. with e.g. $lng->txt("user_updated"); you can translate a lang-topic into the actual language

Author: Peter Gabriel pgabr.nosp@m.iel@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Todo:: Das Datefeld wird bei Aenderungen einer Sprache (update, install, deinstall) nicht richtig gesetzt!!! Die Formatfunktionen gehoeren nicht in class.Language. Die sind auch woanders einsetzbar!!! Daher->besser in class.Format

Definition at line 26 of file class.ilLanguage.php.

Constructor & Destructor Documentation

◆ __construct()

ilLanguage::__construct ( $a_lang_key )

Constructor read the single-language file and put this in an array text.

the text array is two-dimensional. First dimension is the language. Second dimension is the languagetopic. Content is the translation.

@access public

Parameters

string languagecode (two characters), e.g. "de", "en", "in"

Returns: boolean false if reading failed

Reimplemented in ilSetupLanguage.

Definition at line 154 of file class.ilLanguage.php.

    {
        global $DIC;
        $ilIliasIniFile = $DIC->iliasIni();
 
        $this->log = $DIC->logger()->lang();
 
        $this->lang_key = $a_lang_key;
        
        $this->text = array();
        $this->loaded_modules = array();
 
        $this->usage_log_enabled = self::isUsageLogEnabled();
 
        $this->lang_path = ILIAS_ABSOLUTE_PATH . "/lang";
        $this->cust_lang_path = ILIAS_ABSOLUTE_PATH . "/Customizing/global/lang";
 
        $this->lang_default = $ilIliasIniFile->readVariable("language", "default");
 
        if ($DIC->offsetExists('ilSetting')) {
            $ilSetting = $DIC->settings();
            if ($ilSetting->get("language") != "") {
                $this->lang_default = $ilSetting->get("language");
            }
        }
        if ($DIC->offsetExists('ilUser')) {
            $ilUser = $DIC->user();
            $this->lang_user = $ilUser->prefs["language"];
        }
 
        $langs = $this->getInstalledLanguages();
        
        if (!in_array($this->lang_key, $langs)) {
            $this->lang_key = $this->lang_default;
        }
 
        require_once('./Services/Language/classes/class.ilCachedLanguage.php');
        $this->global_cache = ilCachedLanguage::getInstance($this->lang_key);
        if ($this->global_cache->isActive()) {
            $this->cached_modules = $this->global_cache->getTranslations();
        }
 
        $this->loadLanguageModule("common");
 
        return true;
    }

References $DIC, $ilIliasIniFile, $ilSetting, $ilUser, $lang_default, getInstalledLanguages(), ilCachedLanguage\getInstance(), isUsageLogEnabled(), and loadLanguageModule().

Here is the call graph for this function:

◆ __destruct()

ilLanguage::__destruct ( )

destructor saves all language usages to db if log is enabled and ilDB exists

Definition at line 594 of file class.ilLanguage.php.

    {
        global $DIC;
 
        //case $ilDB not existing should not happen but if something went wrong it shouldn't leads to any failures
        if (!$this->usage_log_enabled || !$DIC->isDependencyAvailable("database")) {
            return;
        }
 
        $ilDB = $DIC->database();
 
        foreach ((array) self::$lng_log as $identifier => $module) {
            $wave[] = '(' . $ilDB->quote($module, 'text') . ', ' . $ilDB->quote($identifier, 'text') . ')';
            unset(self::$lng_log[$identifier]);
 
            if (count($wave) == 150 || (count(self::$lng_log) == 0 && count($wave) > 0)) {
                $query = 'REPLACE INTO lng_log (module, identifier) VALUES ' . implode(', ', $wave);
                $ilDB->manipulate($query);
 
                $wave = array();
            }
        }
    }

References $DIC, $ilDB, and $query.

Member Function Documentation

◆ _getInstalledLanguages()

static ilLanguage::_getInstalledLanguages ( )

static

Definition at line 350 of file class.ilLanguage.php.

    {
        include_once("./Services/Object/classes/class.ilObject.php");
        $langlist = ilObject::_getObjectsByType("lng");
 
        foreach ($langlist as $lang) {
            if (substr($lang["desc"], 0, 9) == "installed") {
                $languages[] = $lang["title"];
            }
        }
 
        return $languages ? $languages : array();
    }

References $lang, and ilObject\_getObjectsByType().

Referenced by ilLanguageDetection\detect(), getGlobalInstance(), and getInstalledLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupEntry()

static ilLanguage::_lookupEntry	(	$a_lang_key,
		$a_mod,
		$a_id
	)

static

Definition at line 364 of file class.ilLanguage.php.

    {
        global $DIC;
        $ilDB = $DIC->database();
        
        $set = $ilDB->query($q = sprintf(
            "SELECT * FROM lng_data WHERE module = %s " .
            "AND lang_key = %s AND identifier = %s",
            $ilDB->quote((string) $a_mod, "text"),
            $ilDB->quote((string) $a_lang_key, "text"),
            $ilDB->quote((string) $a_id, "text")
        ));
        $rec = $ilDB->fetchAssoc($set);
        
        if ($rec["value"] != "") {
            // remember the used topics
            self::$used_topics[$a_id] = $a_id;
            self::$used_modules[$a_mod] = $a_mod;
 
            if (self::isUsageLogEnabled()) {
                self::logUsage($a_mod, $a_id);
            }
 
            return $rec["value"];
        }
        
        return "-" . $a_id . "-";
    }

References $DIC, $ilDB, and logUsage().

Referenced by ilLinkChecker\__txt(), ilObjLTIAdministrationGUI\getConsumerForm(), ilPersonalSettingsGUI\initGeneralSettingsForm(), ilAccountMail\replacePlaceholders(), txt(), ilUserCronCheckAccounts\txt(), and txtlng().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

ilLanguage::exists ( $a_topic )

Check if language entry exists.

Parameters

object $a_topic

Returns

Definition at line 289 of file class.ilLanguage.php.

    {
        return isset($this->text[$a_topic]);
    }

◆ getDefaultLanguage()

ilLanguage::getDefaultLanguage ( )

Definition at line 206 of file class.ilLanguage.php.

    {
        return $this->lang_default ? $this->lang_default : 'en';
    }

◆ getFallbackInstance()

static ilLanguage::getFallbackInstance ( )

static

Builds a global default language instance.

Returns: \ilLanguage

Definition at line 437 of file class.ilLanguage.php.

    {
        return new self('en');
    }

◆ getGlobalInstance()

static ilLanguage::getGlobalInstance ( )

static

Builds the global language object.

Returns: self

Definition at line 446 of file class.ilLanguage.php.

    {
        global $DIC;
        $ilSetting = $DIC->settings();
        if ($DIC->offsetExists('ilUser')) {
            $ilUser = $DIC->user();
        }
 
        if (!ilSession::get('lang') && !$_GET['lang']) {
            if (
                $ilUser instanceof ilObjUser &&
                (!$ilUser->getId() || $ilUser->isAnonymous())
            ) {
                require_once 'Services/Language/classes/class.ilLanguageDetection.php';
                $language_detection = new ilLanguageDetection();
                $language = $language_detection->detect();
 
                $ilUser->setPref('language', $language);
                $_GET['lang'] = $language;
            }
        }
 
        if (isset($_POST['change_lang_to']) && $_POST['change_lang_to'] != "") {
            $_GET['lang'] = ilUtil::stripSlashes($_POST['change_lang_to']);
        }
 
        // prefer personal setting when coming from login screen
        // Added check for ilUser->getId > 0 because it is 0 when the language is changed and the terms of service should be displayed
        if (
            $ilUser instanceof ilObjUser &&
            ($ilUser->getId() && !$ilUser->isAnonymous())
        ) {
            ilSession::set('lang', $ilUser->getPref('language'));
        }
 
        ilSession::set('lang', (isset($_GET['lang']) && $_GET['lang']) ? $_GET['lang'] : ilSession::get('lang'));
 
        // check whether lang selection is valid
        $langs = self::_getInstalledLanguages();
        if (!in_array(ilSession::get('lang'), $langs)) {
            if ($ilSetting instanceof ilSetting && $ilSetting->get('language') != '') {
                ilSession::set('lang', $ilSetting->get('language'));
            } else {
                ilSession::set('lang', $langs[0]);
            }
        }
        $_GET['lang'] = ilSession::get('lang');
 
        return new self(ilSession::get('lang'));
    }

References $_GET, $_POST, $DIC, $ilSetting, $ilUser, _getInstalledLanguages(), ilSession\get(), ilSession\set(), and ilUtil\stripSlashes().

Here is the call graph for this function:

◆ getInstalledLanguages()

ilLanguage::getInstalledLanguages ( )

Reimplemented in ilSetupLanguage.

Definition at line 345 of file class.ilLanguage.php.

    {
        return self::_getInstalledLanguages();
    }

References _getInstalledLanguages().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLangKey()

ilLanguage::getLangKey ( )

Definition at line 201 of file class.ilLanguage.php.

    {
        return $this->lang_key;
    }

References $lang_key.

◆ getUsedModules()

ilLanguage::getUsedModules ( )

Definition at line 422 of file class.ilLanguage.php.

    {
        asort(self::$used_modules);
        return self::$used_modules;
    }

References $used_modules.

◆ getUsedTopics()

ilLanguage::getUsedTopics ( )

Definition at line 416 of file class.ilLanguage.php.

    {
        asort(self::$used_topics);
        return self::$used_topics;
    }

References $used_topics.

◆ getUserLanguage()

ilLanguage::getUserLanguage ( )

Definition at line 428 of file class.ilLanguage.php.

    {
        return $this->lang_user;
    }

References $lang_user.

◆ isUsageLogEnabled()

static ilLanguage::isUsageLogEnabled ( )

staticprotected

checks if language usage log is enabled you need MySQL to use this function this function is automatically enabled if DEVMODE is on this function is also enabled if language_log is 1

Returns: bool

Definition at line 571 of file class.ilLanguage.php.

    {
        global $DIC;
        $ilClientIniFile = $DIC->clientIni();
        $ilDB = $DIC->database();
 
        if (!(($ilDB instanceof ilDBMySQL) || ($ilDB instanceof ilDBPdoMySQLMyISAM)) || !$ilClientIniFile instanceof ilIniFile) {
            return false;
        }
 
        if (DEVMODE) {
            return true;
        }
 
        if (!$ilClientIniFile->variableExists('system', 'LANGUAGE_LOG')) {
            return $ilClientIniFile->readVariable('system', 'LANGUAGE_LOG') == 1;
        }
        return false;
    }

References $DIC, and $ilDB.

Referenced by __construct().

Here is the caller graph for this function:

◆ loadLanguageModule()

ilLanguage::loadLanguageModule ( $a_module )

Reimplemented in ilSetupLanguage, and ilLanguageMock.

Definition at line 294 of file class.ilLanguage.php.

    {
        global $DIC;
        $ilDB = $DIC->database();
 
        if (in_array($a_module, $this->loaded_modules)) {
            return;
        }
 
        $this->loaded_modules[] = $a_module;
 
        // remember the used modules globally
        self::$used_modules[$a_module] = $a_module;
 
        $lang_key = $this->lang_key;
 
        if (empty($this->lang_key)) {
            $lang_key = $this->lang_user;
        }
 
        if (is_array($this->cached_modules[$a_module])) {
            $this->text = array_merge($this->text, $this->cached_modules[$a_module]);
 
            if ($this->usage_log_enabled) {
                foreach (array_keys($this->cached_modules[$a_module]) as $key) {
                    $this->map_modules_txt[$key] = $a_module;
                }
            }
 
            return;
        }
 
        $q = "SELECT * FROM lng_modules " .
                "WHERE lang_key = " . $ilDB->quote($lang_key, "text") . " AND module = " .
                $ilDB->quote($a_module, "text");
        $r = $ilDB->query($q);
        $row = $r->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
        
        $new_text = unserialize($row["lang_array"]);
        if (is_array($new_text)) {
            $this->text = array_merge($this->text, $new_text);
 
            if ($this->usage_log_enabled) {
                foreach (array_keys($new_text) as $key) {
                    $this->map_modules_txt[$key] = $a_module;
                }
            }
        }
    }

References $DIC, $ilDB, $lang_key, $lang_user, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by __construct(), ilObjStudyProgrammeIndividualPlanGUI\__construct(), and ilObjStudyProgrammeMembersGUI\__construct().

Here is the caller graph for this function:

◆ logUsage()

static ilLanguage::logUsage	(	$a_module,
		$a_identifier
	)

staticprotected

saves tupel of language module and identifier

Parameters

string	$a_module
string	$a_identifier

Definition at line 556 of file class.ilLanguage.php.

    {
        if ($a_module != "" && $a_identifier != "") {
            self::$lng_log[$a_identifier] = $a_module;
        }
    }

Referenced by _lookupEntry(), and txt().

Here is the caller graph for this function:

◆ lookupId()

static ilLanguage::lookupId ( $a_lang_key )

static

Lookup obj_id of language @global ilDB $ilDB.

Parameters

string $a_lang_key

Returns: int

Definition at line 399 of file class.ilLanguage.php.

    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $query = 'SELECT obj_id FROM object_data ' . ' ' .
        'WHERE title = ' . $ilDB->quote($a_lang_key, 'text') . ' ' .
            'AND type = ' . $ilDB->quote('lng', 'text');
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->obj_id;
        }
        return 0;
    }

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilStartUpGUI\getLoginPageEditorHTML(), and ilAuthLoginPageEditorTableGUI\parse().

Here is the caller graph for this function:

◆ toJS()

ilLanguage::toJS	(		$a_lang_key,
		ilGlobalTemplateInterface	$a_tpl = `null`
	)

Reimplemented in ilLanguageMock.

Definition at line 503 of file class.ilLanguage.php.

    {
        global $DIC;
        $tpl = $DIC['tpl'];
 
        if (!is_object($a_tpl)) {
            $a_tpl = $tpl;
        }
 
        if (!is_array($a_lang_key)) {
            $a_lang_key = array($a_lang_key);
        }
 
        $map = array();
        foreach ($a_lang_key as $lk) {
            $map[$lk] = $this->txt($lk);
        }
        $this->toJSMap($map, $a_tpl);
    }

References $DIC, $tpl, toJSMap(), and txt().

Here is the call graph for this function:

◆ toJSMap()

ilLanguage::toJSMap	(		$a_map,
		ilGlobalTemplateInterface	$a_tpl = `null`
	)

Transfer text to Javascript.

Parameters

array	$a_map	array of key value pairs (key is text string, value is content)
ilTemplate	$a_tpl	template

Definition at line 529 of file class.ilLanguage.php.

    {
        global $DIC;
        $tpl = $DIC['tpl'];
 
        if (!is_object($a_tpl)) {
            $a_tpl = $tpl;
        }
 
        if (!is_array($a_map)) {
            return;
        }
 
        foreach ($a_map as $k => $v) {
            if ($v != "") {
                include_once("./Services/JSON/classes/class.ilJsonUtil.php");
                $a_tpl->addOnloadCode("il.Language.setLangVar('" . $k . "', " . ilJsonUtil::encode($v) . ");");
            }
        }
    }

References $DIC, $tpl, and ilJsonUtil\encode().

Referenced by toJS().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ txt()

ilLanguage::txt	(	$a_topic,
		$a_default_lang_fallback_mod = `""`
	)

gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be returned

@access public

Parameters

string topic

Returns: string text clear-text

Reimplemented in ilLanguageMock, and ilSetupLanguage.

Definition at line 237 of file class.ilLanguage.php.

    {
        if (empty($a_topic)) {
            return "";
        }
 
        // remember the used topics
        self::$used_topics[$a_topic] = $a_topic;
 
        $translation = "";
        if (isset($this->text[$a_topic])) {
            $translation = $this->text[$a_topic];
        }
 
        if ($translation == "" && $a_default_lang_fallback_mod != "") {
            // #13467 - try current language first (could be missing module)
            if ($this->lang_key != $this->lang_default) {
                $translation = ilLanguage::_lookupEntry(
                    $this->lang_key,
                    $a_default_lang_fallback_mod,
                    $a_topic
                );
            }
            // try default language last
            if ($translation == "" || $translation == "-" . $a_topic . "-") {
                $translation = ilLanguage::_lookupEntry(
                    $this->lang_default,
                    $a_default_lang_fallback_mod,
                    $a_topic
                );
            }
        }
 
 
        if ($translation == "") {
            if (ILIAS_LOG_ENABLED && is_object($this->log)) {
                $this->log->debug("Language (" . $this->lang_key . "): topic -" . $a_topic . "- not present");
            }
            return "-" . $a_topic . "-";
        } else {
            if ($this->usage_log_enabled) {
                self::logUsage($this->map_modules_txt[$a_topic], $a_topic);
            }
            return $translation;
        }
    }

References _lookupEntry(), and logUsage().

Referenced by ilLearningModuleNotification\getMailBody(), ilLearningModuleNotification\getMailSubject(), ilLearningModuleNotification\getPreviewText(), ilStudyProgrammeAutoMailSettings\toFormInput(), toJS(), and txtlng().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ txtlng()

ilLanguage::txtlng	(	$a_module,
		$a_topic,
		$a_language
	)

gets the text for a given topic in a given language if the topic is not in the list, the topic itself with "-" will be returned

@access public

Parameters

	string	topic
string	$a_language	The language of the output string

Returns: string text clear-text

Definition at line 220 of file class.ilLanguage.php.

    {
        if (strcmp($a_language, $this->lang_key) == 0) {
            return $this->txt($a_topic);
        } else {
            return ilLanguage::_lookupEntry($a_language, $a_module, $a_topic);
        }
    }

References _lookupEntry(), and txt().

Here is the call graph for this function:

Field Documentation

◆ $cached_modules

ilLanguage::$cached_modules = array()

protected

Definition at line 127 of file class.ilLanguage.php.

◆ $comment_separator

ilLanguage::$comment_separator = "###"

Definition at line 103 of file class.ilLanguage.php.

◆ $ilias

ilLanguage::$ilias

Definition at line 34 of file class.ilLanguage.php.

◆ $lang_default

ilLanguage::$lang_default

Definition at line 51 of file class.ilLanguage.php.

Referenced by __construct().

◆ $lang_key

ilLanguage::$lang_key

Definition at line 79 of file class.ilLanguage.php.

Referenced by getLangKey(), and loadLanguageModule().

◆ $lang_name

ilLanguage::$lang_name

Definition at line 87 of file class.ilLanguage.php.

◆ $lang_path

ilLanguage::$lang_path

Definition at line 71 of file class.ilLanguage.php.

◆ $lang_user

ilLanguage::$lang_user

Definition at line 61 of file class.ilLanguage.php.

Referenced by getUserLanguage(), and loadLanguageModule().

◆ $lng_log

ilLanguage::$lng_log = array()

staticprotected

Definition at line 142 of file class.ilLanguage.php.

◆ $loaded_modules

ilLanguage::$loaded_modules

Definition at line 111 of file class.ilLanguage.php.

◆ $map_modules_txt

ilLanguage::$map_modules_txt = array()

protected

Definition at line 132 of file class.ilLanguage.php.

◆ $separator

ilLanguage::$separator = "#:#"

Definition at line 95 of file class.ilLanguage.php.

◆ $text

ilLanguage::$text

Definition at line 42 of file class.ilLanguage.php.

◆ $usage_log_enabled

ilLanguage::$usage_log_enabled = false

protected

Definition at line 137 of file class.ilLanguage.php.

◆ $used_modules

ilLanguage::$used_modules = array()

staticprotected

Definition at line 123 of file class.ilLanguage.php.

Referenced by getUsedModules().

◆ $used_topics

ilLanguage::$used_topics = array()

staticprotected

Definition at line 117 of file class.ilLanguage.php.

Referenced by getUsedTopics().

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

Services/Language/classes/class.ilLanguage.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ _getInstalledLanguages()

◆ _lookupEntry()

◆ exists()

◆ getDefaultLanguage()

◆ getFallbackInstance()

◆ getGlobalInstance()

◆ getInstalledLanguages()

◆ getLangKey()

◆ getUsedModules()

◆ getUsedTopics()

◆ getUserLanguage()

◆ isUsageLogEnabled()

◆ loadLanguageModule()

◆ logUsage()

◆ lookupId()

◆ toJS()

◆ toJSMap()

◆ txt()

◆ txtlng()

Field Documentation

◆ $cached_modules

◆ $comment_separator

◆ $ilias

◆ $lang_default

◆ $lang_key

◆ $lang_name

◆ $lang_path

◆ $lang_user

◆ $lng_log

◆ $loaded_modules

◆ $map_modules_txt

◆ $separator

◆ $text

◆ $usage_log_enabled

◆ $used_modules

◆ $used_topics