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, ilTemplate $a_tpl=null)

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

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

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

	txt ($a_topic)
	gets the text for a given topic More...

	getLanguages ()
	get all setup languages in the system More...

	installLanguages ($a_lang_keys, $a_local_keys)
	install languages More...

	getInstalledLanguages ()
	get already installed languages (in db) More...

	getInstalledLocalLanguages ()
	get already installed local languages (in db) More...

	getAvailableLanguages ()
	get already registered languages (in db) More...

	checkLanguage ($a_lang_key, $scope='')
	validate the logical structure of a lang-file More...

	cut_header ($content)
	Remove *.lang header information from '$content'. More...

	flushLanguage ($a_lang_key, $a_mode='all')
	remove language data from database More...

	getLocalChanges ($a_lang_key, $a_min_date="", $a_max_date="")
	get locally changed language entries More...

	insertLanguage ($lang_key, $scope='')
	insert language data from file in database More...

	getLocalLanguages ()
	Searches for the existence of *.lang.local files. More...

	getInstallableLanguages ()

	setDbHandler ($a_db_handler)
	set db handler object object db handler More...

	loadLanguageModule ()

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 ilDB $ilDB. More...

static	_deleteLangData ($a_lang_key, $a_keep_local_change)
	Delete languge data. More...

static	replaceLangModule ($a_key, $a_module, $a_array)
	Replace language module array. More...

static	replaceLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null)
	Replace lang entry. More...

static	updateLangEntry ($a_module, $a_identifier, $a_lang_key, $a_value, $a_local_change=null)
	Update lang entry. More...

Data Fields
	$ilias

	$text = array()

	$lang_default = "en"

	$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...

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

language handling for setup

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

this class offers the language handling for an application. 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:: The DATE field is not set correctly on changes of a language (update, install, your stable). The format functions do not belong in class.Language. Those are also applicable elsewhere. Therefore, they would be better placed in class.Format

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

Constructor & Destructor Documentation

◆ __construct() [1/2]

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.

public

Parameters

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

Returns: boolean false if reading failed

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

References $ilias, $ilIliasIniFile, $ilSetting, $ilUser, $lang_default, $log, array, getInstalledLanguages(), ilCachedLanguage\getInstance(), and loadLanguageModule().

         {
                 global $ilias,$log,$ilIliasIniFile,$ilUser,$ilSetting;
 
                 $this->ilias = $ilias;
 
                 if (!isset($log))
                 {
                         if (is_object($ilias))
                         {
                                 require_once "./Services/Logging/classes/class.ilLog.php";
                                 $this->log = new ilLog(ILIAS_LOG_DIR,ILIAS_LOG_FILE,$ilias->getClientId(),ILIAS_LOG_ENABLED);
                         }
                 }
                 else
                 {
                         $this->log =& $log;
                 }
 
                 $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.substr($this->ilias->ini->readVariable("language","path"),1);
 
                 // if no directory was found fall back to default lang dir
                 //if (!is_dir($this->lang_path))
                 //{
                         $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 (is_object($ilSetting) && $ilSetting->get("language") != "")
                 {
                         $this->lang_default = $ilSetting->get("language");
                 }
                 $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;
         }

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 641 of file class.ilLanguage.php.

References $ilDB, $query, and array.

         {
                 global $ilDB;
 
                 //case $ilDB not existing should not happen but if something went wrong it shouldn't leads to any failures
                 if(!$this->usage_log_enabled || !(($ilDB instanceof ilDBMySQL) || ($ilDB instanceof ilDBPdoMySQLMyISAM)))
                 {
                         return;
                 }
 
                 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();
                         }
                 }
         }

◆ __construct() [2/2]

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. public

Parameters

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

Returns: boolean false if reading failed

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

References $row, $txt, and file.

         {
                 $this->lang_key = ($a_lang_key) ? $a_lang_key : $this->lang_default;
                 $this->lang_path = ILIAS_ABSOLUTE_PATH."/lang";
                 $this->cust_lang_path = ILIAS_ABSOLUTE_PATH."/Customizing/global/lang";
 
                 // set lang file...
                 $txt = file($this->lang_path."/setup_lang_sel_multi.lang");
 
                 // ...and load langdata
                 if (is_array($txt))
                 {
                         foreach ($txt as $row)
                         {
                                 if ($row[0] != "#")
                                 {
                                         $a = explode($this->separator,trim($row));
                                         $this->text[trim($a[0])] = trim($a[1]);
                                 }
                         }
                 }
 
                 // set lang file...
                 $txt = file($this->lang_path."/setup_".$this->lang_key.".lang");
 
                 // ...and load langdata
                 if (is_array($txt))
                 {
                         foreach ($txt as $row)
                         {
                                 if ($row[0] != "#")
                                 {
                                         $a = explode($this->separator,trim($row));
                                         $this->text[trim($a[0])] = trim($a[1]);
                                 }
                         }
 
                         return true;
                 }
 
                 return false;
         }

Member Function Documentation

◆ _deleteLangData()

static ilLanguage::_deleteLangData	(	$a_lang_key,
		$a_keep_local_change
	)

static

Delete languge data.

Parameters

string lang key

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

References $ilDB.

Referenced by flushLanguage().

         {
                 global $ilDB;
                 
                 if (!$a_keep_local_change)
                 {
                         $ilDB->manipulate("DELETE FROM lng_data WHERE lang_key = ".
                                 $ilDB->quote($a_lang_key, "text"));
                 }
                 else
                 {
                         $ilDB->manipulate("DELETE FROM lng_data WHERE lang_key = ".
                                 $ilDB->quote($a_lang_key, "text").
                                 " AND local_change IS NULL");
                 }
         }

Here is the caller graph for this function:

◆ _getInstalledLanguages()

static ilLanguage::_getInstalledLanguages ( )

static

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

References $lang, $languages, ilObject\_getObjectsByType(), and array.

Referenced by ilLanguageDetection\__construct().

         {
                 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();
         }

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 405 of file class.ilLanguage.php.

References $ilDB.

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

         {
                 global $ilDB;
                 
                 $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."-";
         }

Here is the caller graph for this function:

◆ checkLanguage()

ilLanguage::checkLanguage	(	$a_lang_key,
		$scope = `''`
	)

validate the logical structure of a lang-file

This function checks if a lang-file of a given lang_key exists, the file has a header, and each lang-entry consists of exactly three elements (module, identifier, value).

Parameters

string	$a_lang_key	international language key (2 digits)
string	$scope	empty (global) or "local"

Returns: string $info_text message about results of check OR "1" if all checks successfully passed

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

References $lang_path, $path, cut_header(), and file.

Referenced by installLanguages().

         {
                 if (!empty($scope))
                 {
                         if ($scope == 'global')
                         {
                                 $scope = ''; 
                         }
                         else
                         {
                                 $scopeExtension = '.' . $scope;
                         }
                 }
                 
                 $path = $this->lang_path;
                 if ($scope == "local")
                 {
                         $path = $this->cust_lang_path;
                 }
 
                 $tmpPath = getcwd();
                 chdir($path);
 
                 // compute lang-file name format
                 $lang_file = "ilias_" . $a_lang_key . ".lang" . $scopeExtension;
 
                 // file check
                 if (!is_file($lang_file))
                 {
                         chdir($tmpPath);
                         return false;
                 }
 
                 // header check
                 if (!$content = $this->cut_header(file($lang_file)))
                 {
                         chdir($tmpPath);
                         return false;
                 }
 
                 // check (counting) elements of each lang-entry
                 foreach ($content as $key => $val)
                 {
                         $separated = explode($this->separator, trim($val));
                         $num = count($separated);
 
                         if ($num != 3)
                         {
                                 chdir($tmpPath);
                                 return false;
                         }
                 }
 
                 chdir($tmpPath);
 
                 // no error occured
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cut_header()

ilLanguage::cut_header ( $content )

Remove *.lang header information from '$content'.

This function seeks for a special keyword where the language information starts. If found it returns the plain language information; otherwise returns false.

Parameters

string $content expect an ILIAS lang-file

Returns: string $content content without header info OR false if no valid header was found private

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

Referenced by checkLanguage(), and insertLanguage().

         {
                 foreach ($content as $key => $val)
                 {
                         if (trim($val) == "<!-- language file start -->")
                         {
                                 return array_slice($content,$key +1);
                         }
                 }
 
                 return false;
         }

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 309 of file class.ilLanguage.php.

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

◆ flushLanguage()

ilLanguage::flushLanguage	(	$a_lang_key,
		$a_mode = `'all'`
	)

remove language data from database

Parameters

string	language key
string	"all" or "keep_local"

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

References $ilDB, and _deleteLangData().

Referenced by installLanguages().

         {
                 $ilDB = $this->db;
                 
                 ilLanguage::_deleteLangData($a_lang_key, ($a_mode == 'keep_local'));
 
                 if ($a_mode == 'all')
                 {
                         $ilDB->manipulate("DELETE FROM lng_modules WHERE lang_key = ".
                                 $ilDB->quote($a_lang_key, "text"));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAvailableLanguages()

ilLanguage::getAvailableLanguages ( )

get already registered languages (in db)

Returns: array array with information about languages that has been registered in db

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

References $ilDB, $query, $r, $row, and array.

Referenced by installLanguages().

         {
                 global $ilDB;
                 
                 $arr = array();
 
                 $query = "SELECT * FROM object_data ".
                                 "WHERE type = ".$ilDB->quote("lng", "text");
                 $r = $ilDB->query($query);
 
                 while ($row = $ilDB->fetchObject($r))
                 {
                         $arr[$row->title]["obj_id"] = $row->obj_id;
                         $arr[$row->title]["status"] = $row->description;
                 }
 
                 return $arr;
         }

Here is the caller graph for this function:

◆ getDefaultLanguage()

ilLanguage::getDefaultLanguage ( )

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

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

◆ getInstallableLanguages()

ilLanguage::getInstallableLanguages ( )

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

References $d, $lang_key, and getLanguages().

         {
                 $setup_langs = $this->getLanguages();
 
                 $d = dir($this->lang_path);
                 $tmpPath = getcwd();
                 chdir ($this->lang_path);
 
                 // get available lang-files
                 while ($entry = $d->read())
                 {
                         if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang$)~", $entry)))
                         {
                                 $lang_key = substr($entry,6,2);
                                 $languages1[] = $lang_key;
                         }
                 }
                 
                 //$languages = array_intersect($languages1,$setup_langs);    
 
                 chdir($tmpPath);
 
                 return $languages1;
         }

Here is the call graph for this function:

◆ getInstalledLanguages() [1/2]

ilLanguage::getInstalledLanguages ( )

get already installed languages (in db)

Returns: array array with inforamtion about each installed language

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

References $ilDB, $query, $r, $row, and array.

         {
                 global $ilDB;
                 
                 $arr = array();
 
                 $query = "SELECT * FROM object_data ".
                                 "WHERE type = ".$ilDB->quote("lng", "text")." ".
                                 "AND ".$ilDB->like("description", "text", 'installed%');
                 $r = $ilDB->query($query);
 
                 while ($row = $ilDB->fetchObject($r))
                 {
                         $arr[] = $row->title;
                 }
 
                 return $arr;
         }

◆ getInstalledLanguages() [2/2]

ilLanguage::getInstalledLanguages ( )

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

Referenced by __construct().

         {
                 return self::_getInstalledLanguages();
         }

Here is the caller graph for this function:

◆ getInstalledLocalLanguages()

ilLanguage::getInstalledLocalLanguages ( )

get already installed local languages (in db)

Returns: array array with inforamtion about each installed language

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

References $ilDB, $query, $r, $row, and array.

         {
                 global $ilDB;
                 
                 $arr = array();
 
                 $query = "SELECT * FROM object_data ".
                                 "WHERE type = ".$ilDB->quote("lng", "text")." ".
                                 "AND description = ".$ilDB->quote('installed_local', "text");
                 $r = $ilDB->query($query);
 
                 while ($row = $ilDB->fetchObject($r))
                 {
                         $arr[] = $row->title;
                 }
 
                 return $arr;
         }

◆ getLangKey()

ilLanguage::getLangKey ( )

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

References $lang_key.

Referenced by ilForumCronNotificationDataProvider\getAuthorInformation().

         {
                 return $this->lang_key;
         }

Here is the caller graph for this function:

◆ getLanguages()

ilLanguage::getLanguages ( )

get all setup languages in the system

the functions looks for setup*.lang-files in the languagedirectory public

Returns: array langs

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

References $d, $lang_key, and $languages.

Referenced by getInstallableLanguages().

         {
                 $d = dir($this->lang_path);
                 $tmpPath = getcwd();
                 chdir ($this->lang_path);
 
                 // get available setup-files
                 while ($entry = $d->read())
                 {
                         if (is_file($entry) && (preg_match ('/(^setup_.{2}\.lang$)/', $entry)))
                         {
                                 $lang_key = substr($entry,6,2);
                                 $languages[] = $lang_key;
                         }
                 }
 
                 chdir($tmpPath);
 
                 return $languages;
         }

Here is the caller graph for this function:

◆ getLocalChanges()

ilLanguage::getLocalChanges	(	$a_lang_key,
		$a_min_date = `""`,
		$a_max_date = `""`
	)

get locally changed language entries

Parameters

string	language key
string	minimum change date "yyyy-mm-dd hh:mm:ss"
string	maximum change date "yyyy-mm-dd hh:mm:ss"

Returns: array [module][identifier] => value

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

References $ilDB, $result, $row, array, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by insertLanguage().

         {
                 $ilDB = $this->db;
                 
                 if ($a_min_date == "")
                 {
                         $a_min_date = "1980-01-01 00:00:00";
                 }
                 if ($a_max_date == "")
                 {
                         $a_max_date = "2200-01-01 00:00:00";
                 }
                 
                 $q = sprintf("SELECT * FROM lng_data WHERE lang_key = %s ".
                         "AND local_change >= %s AND local_change <= %s",
                         $ilDB->quote($a_lang_key, "text"), $ilDB->quote($a_min_date, "timestamp"),
                         $ilDB->quote($a_max_date, "timestamp"));
                 $result = $ilDB->query($q);
                 
                 $changes = array();
                 while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC))
                 {
                         $changes[$row["module"]][$row["identifier"]] = $row["value"];
                 }
                 return $changes;
         }

Here is the caller graph for this function:

◆ getLocalLanguages()

ilLanguage::getLocalLanguages ( )

Searches for the existence of *.lang.local files.

return $local_langs array of language keys

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

References $d, $lang_key, and array.

         {
                 $local_langs = array();
                 if (is_dir($this->cust_lang_path))
                 {
                         $d = dir($this->cust_lang_path);
                         $tmpPath = getcwd();
                         chdir ($this->cust_lang_path);
         
                         // get available .lang.local files
                         while ($entry = $d->read())
                         {
                                 if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang.local$)~", $entry)))
                                 {
                                         $lang_key = substr($entry,6,2);
                                         $local_langs[] = $lang_key;
                                 }
                         }
         
                         chdir($tmpPath);
                 }
 
                 return $local_langs;
         }

◆ getUsedModules()

ilLanguage::getUsedModules ( )

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

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

◆ getUsedTopics()

ilLanguage::getUsedTopics ( )

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

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

◆ getUserLanguage()

ilLanguage::getUserLanguage ( )

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

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

         {
                 return $this->lang_user;
         }

Here is the call graph for this function:

◆ insertLanguage()

ilLanguage::insertLanguage	(	$lang_key,
		$scope = `''`
	)

insert language data from file in database

Parameters

string	$lang_key	international language key (2 digits)
string	$scope	empty (global) or "local"

Returns: void

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

References $ilDB, $lang_path, $path, $row, array, cut_header(), date, file, getLocalChanges(), replaceLangEntry(), replaceLangModule(), time, and updateLangEntry().

Referenced by installLanguages().

         {
                 $ilDB =& $this->db;
                 
                 $lang_array = array();
                 
                 if (!empty($scope))
                 {
                         if ($scope == 'global')
                         {
                                 $scope = ''; 
                         }
                         else
                         {
                                 $scopeExtension = '.' . $scope;
                         }
                 }
 
                 $path = $this->lang_path;
                 if ($scope == "local")
                 {
                         $path = $this->cust_lang_path;
                 }
                 
                 $tmpPath = getcwd();
                 chdir($path);
 
                 $lang_file = "ilias_" . $lang_key . ".lang" . $scopeExtension;
 
                 if ($lang_file)
                 {
                         // initialize the array for updating lng_modules below
                         $lang_array = array();
                         $lang_array["common"] = array();
 
                         // remove header first
                         if ($content = $this->cut_header(file($lang_file)))
                         {
                                 // get the local changes from the database
                                 if (empty($scope))
                                 {
                                         $local_changes = $this->getLocalChanges($lang_key);
                                 }
                                 else if ($scope == 'local')
                                 {
                                         $change_date = date("Y-m-d H:i:s",time());
                                         $min_date = date("Y-m-d H:i:s", filemtime($lang_file));
                                         $local_changes = $this->getLocalChanges($lang_key, $min_date);
                                 }
 
                                 foreach ($content as $key => $val)
                                 {
                                         $separated = explode($this->separator,trim($val));
 
                                         //get position of the comment_separator
                                         $pos = strpos($separated[2], $this->comment_separator);
 
                                         if ($pos !== false)
                                         {
                                                 //cut comment of
                                                 $separated[2] = substr($separated[2] , 0 , $pos);
                                         }
 
                                         // check if the value has a local change
                                         $local_value = $local_changes[$separated[0]][$separated[1]];
 
                                         if (empty($scope))
                                         {
                                                 if ($local_value != "" and $local_value != $separated[2])
                                                 {
                                                         // keep the locally changed value
                                                         $lang_array[$separated[0]][$separated[1]] = $local_value;
                                                 }
                                                 else
                                                 {
                                                         // insert a new value if no local value exists
                                                         // reset local_change if the values are equal
                                                         ilLanguage::replaceLangEntry($separated[0], $separated[1],
                                                                 $lang_key, $separated[2]);
 
                                                         $lang_array[$separated[0]][$separated[1]] = $separated[2];
                                                 }
                                         }
                                         else if ($scope == 'local')
                                         {
                                                 if ($local_value != "")
                                                 {
                                                         // keep a locally changed value that is newer than the local file
                                                         $lang_array[$separated[0]][$separated[1]] = $local_value;
                                                 }
                                                 else
                                                 {
                                                         // UPDATE because the global values have already been INSERTed
                                                         ilLanguage::updateLangEntry($separated[0], $separated[1],
                                                                 $lang_key, $separated[2], $change_date);
                                                         $lang_array[$separated[0]][$separated[1]] = $separated[2];
                                                 }
                                         }
                                 }
                         }
 
                         foreach($lang_array as $module => $lang_arr)
                         {
                                 if ($scope == "local")
                                 {
                                         $q = "SELECT * FROM lng_modules WHERE ".
                                                 " lang_key = ".$ilDB->quote($this->key, "text").
                                                 " AND module = ".$ilDB->quote($module, "text");
                                         $set = $ilDB->query($q);
                                         $row = $ilDB->fetchAssoc($set);
                                         $arr2 = unserialize($row["lang_array"]);
                                         if (is_array($arr2))
                                         {
                                                 $lang_arr = array_merge($arr2, $lang_arr);
                                         }
                                 }
                                 ilLanguage::replaceLangModule($lang_key, $module, $lang_arr);
                         }
                 }
 
                 chdir($tmpPath);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ installLanguages()

ilLanguage::installLanguages	(	$a_lang_keys,
		$a_local_keys
	)

install languages

Parameters

array array with lang_keys of languages to install

Returns: boolean true on success

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

References $ilDB, $lang_key, $ld, $query, array, checkLanguage(), flushLanguage(), getAvailableLanguages(), and insertLanguage().

         {
                 global $ilDB;
                 
                 if (empty($a_lang_keys))
                 {
                         $a_lang_keys = array();
                 }
                 
                 if (empty($a_local_keys))
                 {
                         $a_local_keys = array();
                 }
 
                 $err_lang = array();
 
                 $db_langs = $this->getAvailableLanguages();
 
                 foreach ($a_lang_keys as $lang_key)
                 {
                         if ($this->checkLanguage($lang_key))
                         {
                                 $this->flushLanguage($lang_key, 'keep_local');
                                 $this->insertLanguage($lang_key);
                                 
                                 if (in_array($lang_key, $a_local_keys))
                                 {
                                         if ($this->checkLanguage($lang_key, "local"))
                                         {
                                                 $this->insertLanguage($lang_key, "local");
                                         }
                                         else
                                         {
                                                 $err_lang[] = $lang_key;
                                         }
                                 }
                                 
                                 // register language first time install
                                 if (!array_key_exists($lang_key,$db_langs))
                                 {
                                         if (in_array($lang_key, $a_local_keys))
                                         {
                                                 $itype = 'installed_local';
                                         }
                                         else
                                         {
                                                 $itype = 'installed';
                                         }
                                         $lid = $ilDB->nextId("object_data");
                                         $query = "INSERT INTO object_data ".
                                                         "(obj_id,type,title,description,owner,create_date,last_update) ".
                                                         "VALUES ".
                                                         "(".
                                                         $ilDB->quote($lid, "integer").",".
                                                         $ilDB->quote("lng", "text").",".
                                                         $ilDB->quote($lang_key, "text").",".
                                                         $ilDB->quote($itype, "text").",".
                                                         $ilDB->quote('-1',"integer").",".
                                                         $ilDB->now().",".
                                                         $ilDB->now().
                                                         ")";
                                         $this->db->manipulate($query);
                                 }
                         }
                         else
                         {
                                 $err_lang[] = $lang_key;
                         }
                 }
                 
                 foreach ($db_langs as $key => $val)
                 {
                         if (!in_array($key,$err_lang))
                         {
                                 if (in_array($key,$a_lang_keys))
                                 {
                                         if (in_array($key, $a_local_keys))
                                         {
                                                 $ld = 'installed_local';
                                         }
                                         else
                                         {
                                                 $ld = 'installed';
                                         }
                                         $query = "UPDATE object_data SET " .
                                                         "description = ".$ilDB->quote($ld, "text").", " .
                                                         "last_update = ".$ilDB->now()." " .
                                                         "WHERE obj_id = ".$ilDB->quote($val["obj_id"], "integer")." " .
                                                         "AND type = ".$ilDB->quote("lng", "text");
                                         $ilDB->manipulate($query);
                                 }
                                 else
                                 {
                                         $this->flushLanguage($key, "all");
                                         
                                         if (substr($val["status"], 0, 9) == "installed")
                                         {
                                                 $query = "UPDATE object_data SET " .
                                                                 "description = ".$ilDB->quote("not_installed", "text").", " .
                                                                 "last_update = ".$ilDB->now()." " .
                                                                 "WHERE obj_id = ".$ilDB->quote($val["obj_id"], "integer")." " .
                                                                 "AND type = ".$ilDB->quote("lng", "text");
                                                 $ilDB->manipulate($query);
                                         }
                                 }
                         }
                 }
 
                 return ($err_lang) ? $err_lang : true;
         }

Here is the call graph for this function:

◆ loadLanguageModule() [1/2]

ilLanguage::loadLanguageModule ( $a_module )

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

References $ilDB, $lang_key, $lang_user, $r, $row, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjUserGUI\__sendProfileMail().

         {
                 global $ilDB;
 
                 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;
                 }
 
 /*
                 $query = "SELECT identifier,value FROM lng_data " .
                                 "WHERE lang_key = '" . $lang_key."' " .
                                 "AND module = '$a_module'";
                 $r = $this->ilias->db->query($query);
 
                 while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                 {
                         $this->text[$row->identifier] = $row->value;
                 }
 */
 
                 $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;
                                 }
                         }
                 }
         }

Here is the caller graph for this function:

◆ loadLanguageModule() [2/2]

ilLanguage::loadLanguageModule ( )

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

Referenced by __construct().

832 {

833 }

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 599 of file class.ilLanguage.php.

References $ilDB.

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

◆ lookupId()

static ilLanguage::lookupId ( $a_lang_key )

static

Lookup obj_id of language ilDB $ilDB.

Parameters

string $a_lang_key

Returns: int

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

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

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

         {
                 global $ilDB;
 
                 $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;
         }

Here is the caller graph for this function:

◆ replaceLangEntry()

static ilLanguage::replaceLangEntry	(	$a_module,
		$a_identifier,
		$a_lang_key,
		$a_value,
		$a_local_change = `null`
	)

staticfinal

Replace lang entry.

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

References $ilDB.

Referenced by insertLanguage().

         {
                 global $ilDB;
 
                 $ilDB->manipulate(sprintf("DELETE FROM lng_data WHERE module = %s AND ".
                         "identifier = %s AND lang_key = %s",
                         $ilDB->quote($a_module, "text"), $ilDB->quote($a_identifier, "text"),
                         $ilDB->quote($a_lang_key, "text")));
 
                 // insert a new value if no local value exists
                 // reset local_change if the values are equal
                 $ilDB->manipulate(sprintf("INSERT INTO lng_data " .
                         "(module, identifier, lang_key, value, local_change) " .
                         "VALUES (%s,%s,%s,%s,%s)",
                         $ilDB->quote($a_module, "text"), $ilDB->quote($a_identifier, "text"),
                         $ilDB->quote($a_lang_key, "text"), $ilDB->quote($a_value, "text"),
                         $ilDB->quote($a_local_change, "timestamp")));
         }

Here is the caller graph for this function:

◆ replaceLangModule()

static ilLanguage::replaceLangModule	(	$a_key,
		$a_module,
		$a_array
	)

staticfinal

Replace language module array.

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

References $ilDB, and array.

Referenced by insertLanguage().

         {
                 global $ilDB;
                 
                 $ilDB->manipulate(sprintf("DELETE FROM lng_modules WHERE lang_key = %s AND module = %s",
                         $ilDB->quote($a_key, "text"), $ilDB->quote($a_module, "text")));
                 /*$ilDB->manipulate(sprintf("INSERT INTO lng_modules (lang_key, module, lang_array) VALUES ".
                         "(%s,%s,%s)", $ilDB->quote($a_key, "text"),
                         $ilDB->quote($a_module, "text"),
                         $ilDB->quote(serialize($a_array), "clob")));*/
                 $ilDB->insert("lng_modules", array(
                         "lang_key" => array("text", $a_key),
                         "module" => array("text", $a_module),
                         "lang_array" => array("clob", serialize($a_array))
                         ));
         }

Here is the caller graph for this function:

◆ setDbHandler()

ilLanguage::setDbHandler ( $a_db_handler )

set db handler object object db handler

Returns: boolean true on success

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

         {
                 if (empty($a_db_handler) or !is_object($a_db_handler))
                 {
                         return false;
                 }
                 
                 $this->db =& $a_db_handler;
                 
                 return true;
         }

◆ toJS()

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

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

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

         {
                 global $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);
         }

Here is the call graph for this function:

◆ toJSMap()

ilLanguage::toJSMap	(		$a_map,
		ilTemplate	$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 569 of file class.ilLanguage.php.

References $tpl, and ilJsonUtil\encode().

Referenced by toJS().

         {
                 global $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).");");
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ txt() [1/2]

ilLanguage::txt ( $a_topic )

gets the text for a given topic

if the topic is not in the list, the topic itself with "-" will be returned public

Parameters

string topic

Returns: string text clear-text

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

References $log.

         {
                 global $log;
                 
                 if (empty($a_topic))
                 {
                         return "";
                 }
 
                 $translation = $this->text[$a_topic];
                 
                 //get position of the comment_separator
                 $pos = strpos($translation, $this->comment_separator);
 
                 if ($pos !== false)
                 {
                         // remove comment
                         $translation = substr($translation,0,$pos);
                 }
 
                 if ($translation == "")
                 {
                         $log->writeLanguageLog($a_topic,$this->lang_key);
                         return "-".$a_topic."-";
                 }
                 else
                 {
                         return $translation;
                 }
         }

◆ txt() [2/2]

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

public

Parameters

string topic

Returns: string text clear-text

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

References _lookupEntry().

         {
                 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->writeLanguageLog($a_topic,$this->lang_key);
                         }
                         return "-".$a_topic."-";
                 }
                 else
                 {
                         if($this->usage_log_enabled)
                         {
                                 self::logUsage($this->map_modules_txt[$a_topic], $a_topic);
                         }
                         return $translation;
                 }
         }

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

public

Parameters

	string	topic
string	$a_language	The language of the output string

Returns: string text clear-text

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

References _lookupEntry(), and txt().

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

Here is the call graph for this function:

◆ updateLangEntry()

static ilLanguage::updateLangEntry	(	$a_module,
		$a_identifier,
		$a_lang_key,
		$a_value,
		$a_local_change = `null`
	)

staticfinal

Update lang entry.

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

References $ilDB.

Referenced by insertLanguage().

         {
                 global $ilDB;
                 
                 $ilDB->manipulate(sprintf("UPDATE lng_data " .
                         "SET value = %s, local_change = %s ".
                         "WHERE module = %s AND identifier = %s AND lang_key = %s ",
                         $ilDB->quote($a_value, "text"), $ilDB->quote($a_local_change, "timestamp"),
                         $ilDB->quote($a_module, "text"), $ilDB->quote($a_identifier, "text"),
                         $ilDB->quote($a_lang_key, "text")));
         }

Here is the caller 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.

Referenced by __construct().

◆ $lang_default

ilLanguage::$lang_default = "en"

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 getInstallableLanguages(), getLangKey(), getLanguages(), getLocalLanguages(), installLanguages(), 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.

Referenced by checkLanguage(), and insertLanguage().

◆ $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 = array()

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.

◆ $used_topics

ilLanguage::$used_topics = array()

staticprotected

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

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() [1/2]

◆ __destruct()

◆ __construct() [2/2]

Member Function Documentation

◆ _deleteLangData()

◆ _getInstalledLanguages()

◆ _lookupEntry()

◆ checkLanguage()

◆ cut_header()

◆ exists()

◆ flushLanguage()

◆ getAvailableLanguages()

◆ getDefaultLanguage()

◆ getInstallableLanguages()

◆ getInstalledLanguages() [1/2]

◆ getInstalledLanguages() [2/2]

◆ getInstalledLocalLanguages()

◆ getLangKey()

◆ getLanguages()

◆ getLocalChanges()

◆ getLocalLanguages()

◆ getUsedModules()

◆ getUsedTopics()

◆ getUserLanguage()

◆ insertLanguage()

◆ installLanguages()

◆ loadLanguageModule() [1/2]

◆ loadLanguageModule() [2/2]

◆ logUsage()

◆ lookupId()

◆ replaceLangEntry()

◆ replaceLangModule()

◆ setDbHandler()

◆ toJS()

◆ toJSMap()

◆ txt() [1/2]

◆ txt() [2/2]

◆ txtlng()

◆ updateLangEntry()

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