language handling for setup More...

Inheritance diagram for ilSetupLanguage:

Collaboration diagram for ilSetupLanguage:

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

	txt ($a_topic, $a_default_lang_fallback_mod='')
	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...

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

	getInstallableLanguages ()

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

	loadLanguageModule ($a_module)

Public Member Functions inherited from ilLanguage
	__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	_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...

Static Public Member Functions inherited from ilLanguage
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	getFallbackInstance ()
	Builds a global default language instance. More...

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

Data Fields
	$text = array()

	$lang_default = "en"

	$lang_path

	$lang_key

	$separator = "#:#"

	$comment_separator = "###"

Data Fields inherited from ilLanguage
	$ilias

	$text

	$lang_default

	$lang_user

	$lang_path

	$lang_key

	$lang_name

	$separator = "#:#"

	$comment_separator = "###"

	$loaded_modules

Protected Member Functions
	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...

Additional Inherited Members
Static Protected Member Functions inherited from ilLanguage
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 inherited from ilLanguage
	$cached_modules = array()

	$map_modules_txt = array()

	$usage_log_enabled = false

Static Protected Attributes inherited from ilLanguage
static	$used_topics = array()

static	$used_modules = array()

static	$lng_log = array()

Detailed Description

language handling for setup

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

This somehow needs to be reconciled with the base class and most probably be factored into two classes, one for management, one for retrieval.

Definition at line 47 of file class.ilSetupLanguage.php.

Constructor & Destructor Documentation

◆ __construct()

ilSetupLanguage::__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 103 of file class.ilSetupLanguage.php.

References Vendor\Package\$a, and $txt.

     {
         $this->lang_key = ($a_lang_key) ? $a_lang_key : $this->lang_default;
 
         $il_absolute_path = realpath(dirname(__FILE__) . '/../../../../');
         $this->lang_path = $il_absolute_path . "/lang";
         $this->cust_lang_path = $il_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));
                     if (count($a) == 2) {
                         $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));
                     if (count($a) == 2) {
                         $this->text[trim($a[0])] = trim($a[1]);
                     }
                 }
             }
 
             return true;
         }
 
         return false;
     }

Member Function Documentation

◆ _deleteLangData()

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

static

Delete languge data.

Parameters

string lang key

Definition at line 476 of file class.ilSetupLanguage.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:

◆ checkLanguage()

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

protected

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 381 of file class.ilSetupLanguage.php.

References $lang_path, and cut_header().

Referenced by installLanguages().

     {
         $scopeExtension = "";
         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()

ilSetupLanguage::cut_header ( $content )

protected

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 442 of file class.ilSetupLanguage.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:

◆ flushLanguage()

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

protected

remove language data from database

Parameters

string	language key
string	"all" or "keep_local"

Definition at line 459 of file class.ilSetupLanguage.php.

References $ilDB, and _deleteLangData().

Referenced by installLanguages().

     {
         $ilDB = $this->db;
         
         ilSetupLanguage::_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()

ilSetupLanguage::getAvailableLanguages ( )

protected

get already registered languages (in db)

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

Definition at line 352 of file class.ilSetupLanguage.php.

References $ilDB, and $query.

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:

◆ getInstallableLanguages()

ilSetupLanguage::getInstallableLanguages ( )

Definition at line 762 of file class.ilSetupLanguage.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()

ilSetupLanguage::getInstalledLanguages ( )

get already installed languages (in db)

Returns: array array with inforamtion about each installed language

Definition at line 307 of file class.ilSetupLanguage.php.

References $ilDB, and $query.

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

◆ getInstalledLocalLanguages()

ilSetupLanguage::getInstalledLocalLanguages ( )

get already installed local languages (in db)

Returns: array array with inforamtion about each installed language

Definition at line 330 of file class.ilSetupLanguage.php.

References $ilDB, and $query.

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

◆ getLanguages()

ilSetupLanguage::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 187 of file class.ilSetupLanguage.php.

References $d, and $lang_key.

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()

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

protected

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 497 of file class.ilSetupLanguage.php.

References $ilDB, $result, 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()

ilSetupLanguage::getLocalLanguages ( )

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

return $local_langs array of language keys

Definition at line 740 of file class.ilSetupLanguage.php.

References $d, and $lang_key.

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

◆ insertLanguage()

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

protected

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 533 of file class.ilSetupLanguage.php.

References $ilDB, $lang_key, $lang_path, cut_header(), getLocalChanges(), replaceLangEntry(), replaceLangModule(), and updateLangEntry().

Referenced by installLanguages().

     {
         $ilDB = &$this->db;
         
         $lang_array = array();
         
         $scopeExtension = "";
         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 (is_file($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);
                 } elseif ($scope == 'local') {
                     // set the change date to import time for a local file
                     // get the modification date of the local file
                     // get the newer local changes for a local file
                     $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) {
                     // split the line of the language file
                     // [0]:     module
                     // [1]:     identifier
                     // [2]:     value
                     // [3]:     comment (optional)
                     $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
                     if (isset($local_changes[$separated[0]])) {
                         $local_value = $local_changes[$separated[0]][$separated[1]];
                     } else {
                         $local_value = null;
                     }
 
                     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
                             ilSetupLanguage::replaceLangEntry(
                                 $separated[0],
                                 $separated[1],
                                 $lang_key,
                                 $separated[2]
                             );
 
                             $lang_array[$separated[0]][$separated[1]] = $separated[2];
                         }
                     } elseif ($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
                             ilSetupLanguage::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($lang_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);
                     }
                 }
                 ilSetupLanguage::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()

ilSetupLanguage::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 212 of file class.ilSetupLanguage.php.

References $ilDB, $lang_key, $query, 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) && is_dir($this->cust_lang_path)) {
                     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()

ilSetupLanguage::loadLanguageModule ( $a_module )

Definition at line 801 of file class.ilSetupLanguage.php.

802 {

803 }

◆ replaceLangEntry()

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

staticfinal

Replace lang entry.

Definition at line 680 of file class.ilSetupLanguage.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 ilSetupLanguage::replaceLangModule	(	$a_key,
		$a_module,
		$a_array
	)

staticfinal

Replace language module array.

Definition at line 657 of file class.ilSetupLanguage.php.

References $ilDB.

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()

ilSetupLanguage::setDbHandler ( $a_db_handler )

set db handler object object db handler

Returns: boolean true on success

Definition at line 790 of file class.ilSetupLanguage.php.

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

◆ txt()

ilSetupLanguage::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 154 of file class.ilSetupLanguage.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;
         }
     }

◆ updateLangEntry()

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

staticfinal

Update lang entry.

Definition at line 714 of file class.ilSetupLanguage.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

◆ $comment_separator

ilSetupLanguage::$comment_separator = "###"

Definition at line 92 of file class.ilSetupLanguage.php.

◆ $lang_default

ilSetupLanguage::$lang_default = "en"

Definition at line 62 of file class.ilSetupLanguage.php.

◆ $lang_key

ilSetupLanguage::$lang_key

Definition at line 78 of file class.ilSetupLanguage.php.

Referenced by getInstallableLanguages(), getLanguages(), getLocalLanguages(), insertLanguage(), and installLanguages().

◆ $lang_path

ilSetupLanguage::$lang_path

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

Referenced by checkLanguage(), and insertLanguage().

◆ $separator

ilSetupLanguage::$separator = "#:#"

Definition at line 85 of file class.ilSetupLanguage.php.

◆ $text

ilSetupLanguage::$text = array()

Definition at line 54 of file class.ilSetupLanguage.php.

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

Services/Language/classes/Setup/class.ilSetupLanguage.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteLangData()

◆ checkLanguage()

◆ cut_header()

◆ flushLanguage()

◆ getAvailableLanguages()

◆ getInstallableLanguages()

◆ getInstalledLanguages()

◆ getInstalledLocalLanguages()

◆ getLanguages()

◆ getLocalChanges()

◆ getLocalLanguages()

◆ insertLanguage()

◆ installLanguages()

◆ loadLanguageModule()

◆ replaceLangEntry()

◆ replaceLangModule()

◆ setDbHandler()

◆ txt()

◆ updateLangEntry()

Field Documentation

◆ $comment_separator

◆ $lang_default

◆ $lang_key

◆ $lang_path

◆ $separator

◆ $text