ilSetupLanguage Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSetupLanguage:

Collaboration diagram for ilSetupLanguage:

Public Member Functions
	__construct (string $a_lang_key)
	Constructor read the single-language file and put this in an array text. More...
	txt (string $a_topic, string $a_default_lang_fallback_mod='')
	gets the text for a given topic More...
	installLanguages (array $a_lang_keys, array $a_local_keys)
	install languages More...
	getInstalledLanguages ()
	get already installed languages (in db) More...
	getInstalledLocalLanguages ()
	get already installed local languages (in db) More...
	getLocalChanges (string $a_lang_key, string $a_min_date="", string $a_max_date="")
	get locally changed language entries $a_lang_key language key $a_min_date minimum change date "yyyy-mm-dd hh:mm:ss" $a_max_date maximum change date "yyyy-mm-dd hh:mm:ss" Returned value [module][identifier] => value More...
	getLocalLanguages ()
	Searches for the existence of *.lang.local files. More...
	getInstallableLanguages ()
	Return installable languages. More...
	setDbHandler (ilDBInterface $a_db_handler)
	set db handler object @string object db handler Return true on success More...
	loadLanguageModule (string $a_module)
	Load language module. More...
Public Member Functions inherited from ilLanguage
	__construct (string $a_lang_key)
	Constructor read the single-language file and put this in an array text. More...
	getLangKey ()
	Return lang key. More...
	getDefaultLanguage ()
	Return default language. More...
	getTextDirection ()
	Return text direction. More...
	getContentLanguage ()
	Return content language. More...
	txtlng (string $a_module, string $a_topic, string $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 (string $a_topic, string $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 (string $a_topic)
	Check if language entry exists. More...
	loadLanguageModule (string $a_module)
	Load language module. More...
	getInstalledLanguages ()
	Get installed languages. More...
	getUsedTopics ()
	Return used topics. More...
	getUsedModules ()
	Return used modules. More...
	getUserLanguage ()
	Return language of user. More...
	getCustomLangPath ()
	toJS ($a_lang_key, ilGlobalTemplateInterface $a_tpl=null)
	Transfer text to Javascript. More...
	toJSMap (array $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 (string $a_lang_key, bool $a_keep_local_change)
	Delete languge data. More...
Static Public Member Functions inherited from ilLanguage
static	_getInstalledLanguages ()
	Get installed languages. More...
static	_lookupEntry (string $a_lang_key, string $a_mod, string $a_id)
static	lookupId (string $a_lang_key)
	Lookup obj_id of language. More...
static	getFallbackInstance ()
	Builds a global default language instance. More...
static	getGlobalInstance ()
	Builds the global language object. More...

Data Fields
array	$text
string	$lang_default = "en"
string	$lang_path
string	$lang_key
string	$separator = "#:#"
string	$comment_separator = "###"
Data Fields inherited from ilLanguage
ILIAS	$ilias
array	$text = []
string	$lang_default
string	$lang_user
string	$lang_path
string	$lang_key
string	$lang_name
string	$separator = "#:#"
string	$comment_separator = "###"
array	$loaded_modules = array()

Protected Member Functions
	getAvailableLanguages ()
	get already registered languages (in db) More...
	checkLanguage (string $a_lang_key, string $scope="")
	validate the logical structure of a lang-file More...
	cut_header (array $content)
	Remove *.lang header information from '$content'. More...
	flushLanguage (string $a_lang_key, string $a_mode="all")
	remove language data from database $a_lang_key language key $a_mode "all" or "keep_local" More...
	insertLanguage (string $lang_key, string $scope="")
	insert language data from file in database More...

Protected Attributes
ilDBInterface	$db
Protected Attributes inherited from ilLanguage
array	$cached_modules = array()
array	$map_modules_txt = array()
bool	$usage_log_enabled = false
string	$cust_lang_path
ilLogger	$log
ilCachedLanguage	$global_cache

Additional Inherited Members
Static Protected Member Functions inherited from ilLanguage
static	logUsage (string $a_module, string $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...
Static Protected Attributes inherited from ilLanguage
static array	$used_topics = array()
static array	$used_modules = array()
static array	$lng_log = array()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 40 of file class.ilSetupLanguage.php.

Constructor & Destructor Documentation

__construct()

ilSetupLanguage::__construct

(

string

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

$a_lang_key language code (two characters), e.g. "de", "en", "in" Return false if reading failed, otherwise true

Reimplemented from ilLanguage.

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

    {
        $this->lang_key = $a_lang_key ?: $this->lang_default;
        $il_absolute_path = realpath(__DIR__ . "/../../../../");
        $this->lang_path = $il_absolute_path . "/lang";
        $this->cust_lang_path = $il_absolute_path . "/Customizing/global/lang";
    }

References $lang_default.

Member Function Documentation

_deleteLangData()

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

static

Delete languge data.

$a_lang_key lang key

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

                                                                                         : void
    {
        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");
        }
    }

References $ilDB.

Referenced by flushLanguage().

Here is the caller graph for this function:

checkLanguage()

ilSetupLanguage::checkLanguage ( string  $a_lang_key, string  $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).

$a_lang_key international language key (2 digits) $scope empty (global) or "local" $info_text message about results of check OR "1" if all checks successfully passed

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

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

References ilLanguage\$cust_lang_path, ILIAS\LTI\ToolProvider\$key, $lang_path, $path, $scope, and cut_header().

Referenced by installLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

cut_header()

ilSetupLanguage::cut_header ( array  $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.

$content expect an ILIAS lang-file

Returns

bool|string[]

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

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by checkLanguage(), and insertLanguage().

Here is the caller graph for this function:

flushLanguage()

ilSetupLanguage::flushLanguage ( string  $a_lang_key, string  $a_mode = "all"  )

protected

remove language data from database $a_lang_key language key $a_mode "all" or "keep_local"

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

                                                                                : void
    {
        global $ilDB;
 
        self::_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"));
        }
    }

References $ilDB, and _deleteLangData().

Referenced by installLanguages().

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)

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

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

References $ilDB, and $query.

Referenced by installLanguages().

Here is the caller graph for this function:

getInstallableLanguages()

ilSetupLanguage::getInstallableLanguages

(

)

Return installable languages.

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

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

References $d, and $lang_key.

getInstalledLanguages()

ilSetupLanguage::getInstalledLanguages

(

)

get already installed languages (in db)

Reimplemented from ilLanguage.

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

                                           : array
    {
        global $ilDB;
        $arr = [];
        if ($ilDB instanceof ilDBInterface) {
            $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;
    }

References $ilDB, and $query.

getInstalledLocalLanguages()

ilSetupLanguage::getInstalledLocalLanguages

(

)

get already installed local languages (in db)

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

                                                : array
    {
        global $ilDB;
        $arr = [];
        if ($ilDB instanceof ilDBInterface) {
            $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;
    }

References $ilDB, and $query.

getLocalChanges()

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

get locally changed language entries $a_lang_key language key $a_min_date minimum change date "yyyy-mm-dd hh:mm:ss" $a_max_date maximum change date "yyyy-mm-dd hh:mm:ss" Returned value [module][identifier] => value

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

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

References $ilDB, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by insertLanguage().

Here is the caller graph for this function:

getLocalLanguages()

ilSetupLanguage::getLocalLanguages

(

)

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

Returns array with language keys

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

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

References $d, and $lang_key.

insertLanguage()

ilSetupLanguage::insertLanguage ( string  $lang_key, string  $scope = ""  )

protected

insert language data from file in database

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

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

                                                                           : void
    {
        global $ilDB;
 
        $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;
        $change_date = null;
 
        if (is_file($lang_file)) {
            // initialize the array for updating lng_modules below
            $lang_array = [];
            $lang_array["common"] = [];
    
            // 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);
                }
 
                $query_check = false;
                $query = "INSERT INTO lng_data (module,identifier,lang_key,value,local_change,remarks) VALUES ";
                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 = "";
                    }
            
                    if (empty($scope)) {
                        if ($local_value !== "" && $local_value !== $separated[2]) {
                            // keep the locally changed value
                            $lang_array[$separated[0]][$separated[1]] = $local_value;
                            continue;
                        }
                    } 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;
                            continue;
                        }
                    }
            
                    $query .= sprintf(
                        "(%s,%s,%s,%s,%s,%s),",
                        $ilDB->quote($separated[0], "text"),
                        $ilDB->quote($separated[1], "text"),
                        $ilDB->quote($lang_key, "text"),
                        $ilDB->quote($separated[2], "text"),
                        $ilDB->quote($change_date, "timestamp"),
                        $ilDB->quote($separated[3] ?? null, "text")
                    );
                    $query_check = true;
                    $lang_array[$separated[0]][$separated[1]] = $separated[2];
                }
                $query = rtrim($query, ",") . " ON DUPLICATE KEY UPDATE value=VALUES(value),remarks=VALUES(remarks);";
                if ($query_check) {
                    $ilDB->manipulate($query);
                }
            }
    
            $query = "INSERT INTO lng_modules (module, lang_key, lang_array) VALUES ";
            $modules_to_delete = [];
            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"], ["allowed_classes" => false]);
                    if (is_array($arr2)) {
                        $lang_arr = array_merge($arr2, $lang_arr);
                    }
                }
                $query .= sprintf(
                    "(%s,%s,%s),",
                    $ilDB->quote($module, "text"),
                    $ilDB->quote($lang_key, "text"),
                    $ilDB->quote(serialize($lang_arr), "clob"),
                );
                $modules_to_delete[] = $module;
            }
 
            $inModulesToDelete = $ilDB->in('module', $modules_to_delete, false, 'text');
            $ilDB->manipulate(sprintf("DELETE FROM lng_modules WHERE lang_key = %s AND $inModulesToDelete",
                $ilDB->quote($lang_key, "text")
            ));
 
            $query = rtrim($query, ",") . ";";
            $ilDB->manipulate($query);
        }
 
        chdir($tmpPath);
    }

References ilLanguage\$cust_lang_path, $ilDB, ILIAS\LTI\ToolProvider\$key, $lang_key, $lang_path, $path, $query, $scope, cut_header(), and getLocalChanges().

Referenced by installLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

installLanguages()

ilSetupLanguage::installLanguages	(	array	$a_lang_keys,
		array	$a_local_keys
	)

install languages

$a_lang_keys array with lang_keys of languages to install

Returns

array|bool

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

    {
        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, true) && 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, true)) {
                        $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() .
                            ")";
                    $ilDB->manipulate($query);
                }
            } else {
                $err_lang[] = $lang_key;
            }
        }
 
        foreach ($db_langs as $key => $val) {
            if (!in_array($key, $err_lang, true)) {
                if (in_array($key, $a_lang_keys, true)) {
                    if (in_array($key, $a_local_keys, true)) {
                        $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 (strpos($val["status"], "installed") === 0) {
                        $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) ?: true;
    }

References $ilDB, ILIAS\LTI\ToolProvider\$key, $lang_key, $query, checkLanguage(), flushLanguage(), getAvailableLanguages(), and insertLanguage().

Here is the call graph for this function:

loadLanguageModule()

ilSetupLanguage::loadLanguageModule

(

string

$a_module

)

Load language module.

Reimplemented from ilLanguage.

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

                                                        : void
    {
    }

setDbHandler()

ilSetupLanguage::setDbHandler

(

ilDBInterface

$a_db_handler

)

set db handler object @string object db handler Return true on success

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

                                                             : bool
    {
        $this->db = &$a_db_handler;
        return true;
    }

txt()

ilSetupLanguage::txt	(	string	$a_topic,
		string	$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

$a_topic topic

Reimplemented from ilLanguage.

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

                                                                                  : string
    {
        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 . "-";
        }
 
        return $translation;
    }

References ilLanguage\$log, and ilLogger\writeLanguageLog().

Here is the call graph for this function:

Field Documentation

$comment_separator

string ilSetupLanguage::$comment_separator = "###"

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

$db

ilDBInterface ilSetupLanguage::$db

protected

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

$lang_default

string ilSetupLanguage::$lang_default = "en"

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

Referenced by __construct().

$lang_key

string ilSetupLanguage::$lang_key

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

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

$lang_path

string ilSetupLanguage::$lang_path

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

Referenced by checkLanguage(), and insertLanguage().

$separator

string ilSetupLanguage::$separator = "#:#"

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

$text

array ilSetupLanguage::$text

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

---

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

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