Inheritance diagram for ilObjLanguage:

Collaboration diagram for ilObjLanguage:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=false)
	Constructor. More...

	getKey ()
	get language key More...

	getStatus ()
	get language status More...

	isSystemLanguage ()
	check if language is system language More...

	isUserLanguage ()
	check if language is system language More...

	isInstalled ()
	Check language object status, and return true if language is installed. More...

	isLocal ()
	Check language object status, and return true if a local language file is installed. More...

	install (string $scope="")
	install current language More...

	uninstall ()
	uninstall current language More...

	refresh ()
	refresh current language More...

	flush (string $a_mode="all")
	remove language data from database $a_mode "all" or "keep_local" More...

	getLocalChanges (string $a_min_date="", string $a_max_date="")
	get locally changed language entries $a_min_date minimum change date "yyyy-mm-dd hh:mm:ss" $a_max_date maximum change date "yyyy-mm-dd hh:mm:ss" Return array [module][identifier] => value More...

	insert (string $scope="")
	insert language data from file into database More...

	resetUserLanguage (string $lang_key)
	search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english). More...

	optimizeData ()
	optimizes the db-table langdata More...

	check (string $scope="")
	Validate the logical structure of a lang file. More...

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

	updateOwner ()
	update owner of object in db More...

	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...

	selfOrParentWithRatingEnabled ()

	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getInstalledLanguages ()
	Get the language objects of the installed languages. More...

static	refreshAll ()
	Refresh all installed languages. More...

static	refreshPlugins (?array $a_lang_keys=null)
	Refresh languages of activated plugins $a_lang_keys keys of languages to be refreshed (not yet supported, all available will be refreshed) More...

static	_deleteLangData (string $a_lang_key, bool $a_keep_local_change=false)
	Delete languge data $a_lang_key lang key. More...

static	_getLastLocalChange (string $a_key)
	get the date of the last local change $a_key language key Return change_date "yyyy-mm-dd hh:mm:ss" More...

static	_getLocalChangesByModule (string $a_key, string $a_module)
	Get the local changes of a language module $a_key Language key $a_module Module key Return array identifier => value. More...

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

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

static	updateLangEntry (string $a_module, string $a_identifier, string $a_lang_key, string $a_value, ?string $a_local_change=null, ?string $a_remarks=null)
	Replace lang entry. More...

static	deleteLangEntry (string $a_module, string $a_identifier, string $a_lang_key)
	Delete lang entry. More...

static	cut_header (array $content)
	remove lang-file haeder information from '$content' This function seeks for a special keyword where the language information starts. More...

static	countUsers (string $a_lang)
	Count number of users that use a language. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
string	$separator
	separator of module, comment separator, identifier & values in language files More...

string	$comment_separator

string	$lang_default

string	$lang_user

string	$lang_path

string	$key

string	$status

string	$cust_lang_path

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Additional Inherited Members
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Detailed Description

Class ilObjLanguage.

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version: $Id$

Definition at line 29 of file class.ilObjLanguage.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLanguage::__construct	(	int	$a_id = `0`,
		bool	$a_call_by_reference = `false`
	)

Constructor.

$a_id reference_id or object_id $a_call_by_reference treat the id as reference_id (true) or object_id (false)

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

    {
        global $DIC;
        $lng = $DIC->language();
 
        $this->type = "lng";
        parent::__construct($a_id, $a_call_by_reference);
 
        $this->type = "lng";
        $this->key = $this->title;
        $this->status = $this->desc;
        $this->lang_default = $lng->lang_default;
        $this->lang_user = $lng->lang_user;
        $this->lang_path = $lng->lang_path;
        $this->cust_lang_path = $lng->getCustomLangPath();
        $this->separator = $lng->separator;
        $this->comment_separator = $lng->comment_separator;
    }

References ilObject\$desc, $DIC, ilObject\$lng, ilObject\$title, ILIAS\GlobalScreen\Provider\__construct(), and ilLanguage\getCustomLangPath().

Here is the call graph for this function:

Member Function Documentation

◆ _deleteLangData()

static ilObjLanguage::_deleteLangData	(	string	$a_lang_key,
		bool	$a_keep_local_change = `false`
	)

static

Delete languge data $a_lang_key lang key.

Definition at line 292 of file class.ilObjLanguage.php.

                                                                                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        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 $DIC, and $ilDB.

Referenced by flush().

Here is the caller graph for this function:

◆ _getLastLocalChange()

static ilObjLanguage::_getLastLocalChange ( string $a_key )

static

get the date of the last local change $a_key language key Return change_date "yyyy-mm-dd hh:mm:ss"

Definition at line 365 of file class.ilObjLanguage.php.

                                                             : string
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $q = sprintf(
            "SELECT MAX(local_change) last_change FROM lng_data " .
                    "WHERE lang_key = %s AND local_change IS NOT NULL",
            $ilDB->quote($a_key, "text")
        );
        $result = $ilDB->query($q);
 
        if ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            return (string) $row["last_change"];
        } else {
            return "";
        }
    }

References $DIC, $ilDB, $q, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by ilObjLanguageFolderGUI\buildConfirmModal(), ilObjLanguageFolderGUI\confirmRefreshSelectedObject(), and ilLanguageFolderTable\getRows().

Here is the caller graph for this function:

◆ _getLocalChangesByModule()

static ilObjLanguage::_getLocalChangesByModule	(	string	$a_key,
		string	$a_module
	)

static

Get the local changes of a language module $a_key Language key $a_module Module key Return array identifier => value.

Definition at line 391 of file class.ilObjLanguage.php.

                                                                                    : array
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $changes = array();
        $result = $ilDB->queryF(
            "SELECT * FROM lng_data WHERE lang_key = %s AND module = %s AND local_change IS NOT NULL",
            array("text", "text"),
            array($a_key, $a_module)
        );
 
        while ($row = $ilDB->fetchAssoc($result)) {
            $changes[$row["identifier"]] = $row["value"];
        }
        return $changes;
    }

References $DIC, and $ilDB.

Referenced by ilPluginLanguage\updateLanguages().

Here is the caller graph for this function:

◆ check()

ilObjLanguage::check ( string $scope = "" )

Validate the logical structure of a lang file.

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

$scope empty (global) or "local" Return system message

Definition at line 671 of file class.ilObjLanguage.php.

                                             : bool
    {
        global $DIC;
        $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();
 
        // dir check
        if (!is_dir($path)) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                "Directory not found: " . $path,
                true
            );
            $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
        }
 
        chdir($path);
 
        // compute lang-file name format
        $lang_file = "ilias_" . $this->key . ".lang" . $scopeExtension;
 
        // file check
        if (!is_file($lang_file)) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                "File not found: " . $lang_file,
                true
            );
            $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
        }
 
        // header check
        $content = self::cut_header(file($lang_file));
        if ($content === false) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                "Wrong Header in " . $lang_file,
                true
            );
            $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
        }
 
        // check (counting) elements of each lang-entry
        $line = 0;
        $n = 0;
        foreach ($content as $key => $val) {
            $separated = explode($this->separator, trim($val));
            $num = count($separated);
            ++$n;
            if ($num !== 3) {
                $line = $n + 36;
                $DIC->ui()->mainTemplate()->setOnScreenMessage(
                    'failure',
                    "Wrong parameter count in " . $lang_file . " in line $line (Value: $val)! Please check your language file!",
                    true
                );
                $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
            }
            if (!ilStr::isUtf8($separated[2])) {
                $DIC->ui()->mainTemplate()->setOnScreenMessage(
                    'failure',
                    "Non UTF8 character found in " . $lang_file . " in line $line (Value: $val)! Please check your language file!",
                    true
                );
                $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
            }
        }
 
        chdir($tmpPath);
 
        // no error occured
        return true;
    }

References $DIC, $path, $scope, and ilStr\isUtf8().

Referenced by install(), and refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countUsers()

static ilObjLanguage::countUsers ( string $a_lang )

static

Count number of users that use a language.

Definition at line 761 of file class.ilObjLanguage.php.

                                                     : int
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $set = $ilDB->query("SELECT COUNT(*) cnt FROM usr_data ud JOIN usr_pref up" .
            " ON ud.usr_id = up.usr_id " .
            " WHERE up.value = " . $ilDB->quote($a_lang, "text") .
            " AND up.keyword = " . $ilDB->quote("language", "text"));
        $rec = $ilDB->fetchAssoc($set);
 
        // add users with no usr_pref set to default language
        if ($a_lang == $lng->lang_default) {
            $set2 = $ilDB->query("SELECT COUNT(*) cnt FROM usr_data ud LEFT JOIN usr_pref up" .
                " ON (ud.usr_id = up.usr_id AND up.keyword = " . $ilDB->quote("language", "text") . ")" .
                " WHERE up.value IS NULL ");
            $rec2 = $ilDB->fetchAssoc($set2);
        }
 
        return (int) $rec["cnt"] + (int) ($rec2["cnt"] ?? 0);
    }

References $DIC, $ilDB, $lng, and ILIAS\Repository\int().

Referenced by ilLanguageFolderTable\getRows(), and ILIAS\Dashboard\DataRetrieval\Language\getRows().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cut_header()

static ilObjLanguage::cut_header ( array $content )

static

remove lang-file haeder 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 expecting an ILIAS lang-file Return content without header info OR false if no valid header was found

Returns: bool|array

Definition at line 639 of file class.ilObjLanguage.php.

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

Referenced by ilObjLanguageFolder\checkAllLanguages().

Here is the caller graph for this function:

◆ deleteLangEntry()

static ilObjLanguage::deleteLangEntry	(	string	$a_module,
		string	$a_identifier,
		string	$a_lang_key
	)

staticfinal

Delete lang entry.

Definition at line 595 of file class.ilObjLanguage.php.

                                                                                                            : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $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")
        ));
 
        return true;
    }

References $DIC, and $ilDB.

Referenced by ilObjLanguageExt\_deleteValues().

Here is the caller graph for this function:

◆ flush()

ilObjLanguage::flush ( string $a_mode = "all" )

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

Definition at line 311 of file class.ilObjLanguage.php.

                                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        self::_deleteLangData($this->key, ($a_mode === "keep_local"));
 
        if ($a_mode === "all") {
            $ilDB->manipulate("DELETE FROM lng_modules WHERE lang_key = " .
                $ilDB->quote($this->key, "text"));
        }
    }

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

Referenced by install(), refresh(), and uninstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstalledLanguages()

static ilObjLanguage::getInstalledLanguages ( )

static

Get the language objects of the installed languages.

Definition at line 73 of file class.ilObjLanguage.php.

                                                  : array
    {
        $objects = array();
        $languages = ilObject::_getObjectsByType("lng");
        foreach ($languages as $lang) {
            $langObj = new ilObjLanguage((int) $lang["obj_id"], false);
            if ($langObj->isInstalled()) {
                $objects[] = $langObj;
            } else {
                unset($langObj);
            }
        }
        return $objects;
    }

References $lang, and ilObject\_getObjectsByType().

Referenced by ilPluginLanguage\updateLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKey()

ilObjLanguage::getKey ( )

get language key

Return language key

Definition at line 94 of file class.ilObjLanguage.php.

                            : string
    {
        return $this->key;
    }

References $key.

Referenced by install(), and refresh().

Here is the caller graph for this function:

◆ getLocalChanges()

ilObjLanguage::getLocalChanges	(	string	$a_min_date = `""`,
		string	$a_max_date = `""`
	)

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

Definition at line 331 of file class.ilObjLanguage.php.

                                                                                     : array
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        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($this->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 $DIC, $ilDB, $q, and ilDBConstants\FETCHMODE_ASSOC.

Referenced by insert().

Here is the caller graph for this function:

◆ getStatus()

ilObjLanguage::getStatus ( )

get language status

Return language status

Definition at line 104 of file class.ilObjLanguage.php.

                               : string
    {
        return $this->status;
    }

References $status.

Referenced by isInstalled(), isLocal(), and refresh().

Here is the caller graph for this function:

◆ insert()

ilObjLanguage::insert ( string $scope = "" )

insert language data from file into database

$scope empty (global) or "local"

Definition at line 415 of file class.ilObjLanguage.php.

                                              : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $scopeExtension = "";
        if (!empty($scope)) {
            if ($scope === "global") {
                $scope = "";
            } else {
                $scopeExtension = "." . $scope;
            }
        }
 
        $path = $this->lang_path;
        if ($scope === "local") {
            $path = $this->cust_lang_path;
        }
 
        $lang_file = $path . "/ilias_" . $this->key . ".lang" . $scopeExtension;
 
        if (is_file($lang_file)) {
            // remove header first
            if ($content = self::cut_header(file($lang_file))) {
                $local_changes = null;
                if (empty($scope)) {
                    // get all local changes for a global file
                    $local_changes = $this->getLocalChanges();
                } elseif ($scope === "local") {
                    // get the modification date of the local file
                    // get the newer local changes for a local file
                    $min_date = gmdate("Y-m-d H:i:s", filemtime($lang_file));
                    $local_changes = $this->getLocalChanges($min_date);
                }
                $dbAccess = new ilObjLanguageDBAccess($ilDB, $this->key, $content, $local_changes, $scope);
                $lang_array = $dbAccess->insertLangEntries($lang_file);
                $dbAccess->replaceLangModules($lang_array);
            }
        }
    }

References $cust_lang_path, $DIC, $ilDB, $lang_path, $path, $scope, and getLocalChanges().

Referenced by install(), and refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ install()

ilObjLanguage::install ( string $scope = "" )

install current language

$scope empty (global) or "local" Return installed language key

Definition at line 168 of file class.ilObjLanguage.php.

                                               : string
    {
        if (!empty($scope)) {
            if ($scope === "global") {
                $scope = "";
            } else {
                $scopeExtension = "." . $scope;
            }
        }
 
        if (!$this->isInstalled() || (!$this->isLocal() && !empty($scope))) {
            if ($this->check($scope)) {
                // lang-file is ok. Flush data in db and...
                if (empty($scope)) {
                    $this->flush("keep_local");
                }
 
                // ...re-insert data from lang-file
                $this->insert($scope);
 
                // update information in db-table about available/installed languages
                $newDesc = '';
                if (empty($scope)) {
                    $newDesc = "installed";
                } elseif ($scope === "local") {
                    $newDesc = "installed_local";
                }
                $this->setDescription($newDesc);
                $this->update();
                return $this->getKey();
            }
        }
        return "";
    }

References $scope, check(), flush(), getKey(), insert(), isInstalled(), isLocal(), ilObject\setDescription(), and ilObject\update().

Here is the call graph for this function:

◆ isInstalled()

ilObjLanguage::isInstalled ( )

Check language object status, and return true if language is installed.

Return true if installed

Definition at line 138 of file class.ilObjLanguage.php.

                                 : bool
    {
        if (str_starts_with($this->getStatus(), "installed")) {
            return true;
        } else {
            return false;
        }
    }

References getStatus().

Referenced by install(), refresh(), and ilObjLanguageExt\setLocal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLocal()

ilObjLanguage::isLocal ( )

Check language object status, and return true if a local language file is installed.

Return true if local language is installed

Definition at line 153 of file class.ilObjLanguage.php.

                             : bool
    {
        if (substr($this->getStatus(), 10) === "local") {
            return true;
        } else {
            return false;
        }
    }

References getStatus().

Referenced by install(), and refresh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSystemLanguage()

ilObjLanguage::isSystemLanguage ( )

check if language is system language

Definition at line 112 of file class.ilObjLanguage.php.

                                      : bool
    {
        if ($this->key == $this->lang_default) {
            return true;
        } else {
            return false;
        }
    }

◆ isUserLanguage()

ilObjLanguage::isUserLanguage ( )

check if language is system language

Definition at line 124 of file class.ilObjLanguage.php.

                                    : bool
    {
        if ($this->key == $this->lang_user) {
            return true;
        } else {
            return false;
        }
    }

◆ optimizeData()

ilObjLanguage::optimizeData ( )

optimizes the db-table langdata

Return true on success

Deprecated:

Definition at line 656 of file class.ilObjLanguage.php.

                                  : bool
    {
        // Mantis #22313: removed table optimization
        return true;
    }

◆ refresh()

ilObjLanguage::refresh ( )

refresh current language

Definition at line 227 of file class.ilObjLanguage.php.

                             : bool
    {
        if ($this->isInstalled() && $this->check()) {
            $this->flush("keep_local");
            $this->insert();
            $this->setTitle($this->getKey());
            $this->setDescription($this->getStatus());
            $this->update();
 
            if ($this->isLocal() && $this->check("local")) {
                $this->insert("local");
                $this->setTitle($this->getKey());
                $this->setDescription($this->getStatus());
                $this->update();
            }
 
            return true;
        }
 
        return false;
    }

References check(), flush(), getKey(), getStatus(), insert(), isInstalled(), isLocal(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().

Here is the call graph for this function:

◆ refreshAll()

static ilObjLanguage::refreshAll ( )

static

Refresh all installed languages.

Definition at line 252 of file class.ilObjLanguage.php.

                                       : void
    {
        $languages = ilObject::_getObjectsByType("lng");
        $refreshed = array();
 
        foreach ($languages as $lang) {
            $langObj = new ilObjLanguage($lang["obj_id"], false);
            if ($langObj->refresh()) {
                $refreshed[] = $langObj->getKey();
            }
            unset($langObj);
        }
 
        self::refreshPlugins($refreshed);
    }

References $lang, ilObject\_getObjectsByType(), and refreshPlugins().

Referenced by ilObjLanguageFolderGUI\refreshObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshPlugins()

static ilObjLanguage::refreshPlugins ( ?array $a_lang_keys = null )

static

Refresh languages of activated plugins $a_lang_keys keys of languages to be refreshed (not yet supported, all available will be refreshed)

Definition at line 273 of file class.ilObjLanguage.php.

                                                                     : void
    {
        global $DIC;
 
        $component_repository = $DIC["component.repository"];
        foreach ($component_repository->getPlugins() as $plugin) {
            if (!$plugin->isActive()) {
                continue;
            }
            $handler = new ilPluginLanguage($plugin);
            $handler->updateLanguages($a_lang_keys);
        }
    }

References $DIC, $handler, and XapiProxy\$plugin.

Referenced by refreshAll(), ilObjLanguageFolderGUI\refreshSelectedObject(), and ilObjLanguageFolderGUI\uninstallChangesObject().

Here is the caller graph for this function:

◆ replaceLangEntry()

static ilObjLanguage::replaceLangEntry	(	string	$a_module,
		string	$a_identifier,
		string	$a_lang_key,
		string	$a_value,
		?string	$a_local_change = `null`,
		?string	$a_remarks = `null`
	)

staticfinal

Replace lang entry.

Definition at line 506 of file class.ilObjLanguage.php.

     : bool {
        global $DIC;
        $ilDB = $DIC->database();
 
        // avoid a cache flush here (see mantis #28818)
        // ilGlobalCache::flushAll();
 
        if (is_string($a_remarks) && $a_remarks !== '') {
            $a_remarks = substr($a_remarks, 0, 250);
        }
 
        if ($a_remarks === '') {
            $a_remarks = null;
        }
 
        if ($a_value === "") {
            $a_value = null;
        } else {
            $a_value = substr($a_value, 0, 4000);
        }
 
        $ilDB->replace(
            "lng_data",
            array(
                "module" => array("text",$a_module),
                "identifier" => array("text",$a_identifier),
                "lang_key" => array("text",$a_lang_key)
                ),
            array(
                "value" => array("text",$a_value),
                "local_change" => array("timestamp",$a_local_change),
                "remarks" => array("text", $a_remarks)
            )
        );
        return true;
    }

Referenced by ilObjLanguageExt\_saveValues(), ilObjLanguageExtGUI\saveNewEntryObject(), and ilPluginLanguage\updateLanguages().

Here is the caller graph for this function:

◆ replaceLangModule()

static ilObjLanguage::replaceLangModule	(	string	$a_key,
		string	$a_module,
		array	$a_array
	)

staticfinal

Replace language module array.

Definition at line 458 of file class.ilObjLanguage.php.

                                                                                                   : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        // avoid flushing the whole cache (see mantis #28818)
        ilCachedLanguage::getInstance($a_key)->deleteInCache();
 
        $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))
            ));
 
        // check if the module is correctly saved
        // see mantis #20046 and #19140
        $result = $ilDB->queryF(
            "SELECT lang_array FROM lng_modules WHERE lang_key = %s AND module = %s",
            array("text","text"),
            array($a_key, $a_module)
        );
        $row = $ilDB->fetchAssoc($result);
 
        $unserialied = unserialize($row["lang_array"], ["allowed_classes" => false]);
        if (!is_array($unserialied)) {
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                "Data for module '" . $a_module . "' of  language '" . $a_key . "' is not correctly saved. " .
                "Please check the collation of your database tables lng_data and lng_modules. It must be utf8_unicode_ci.",
                true
            );
            $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
        }
    }

References $DIC, $ilDB, and ilCachedLanguage\getInstance().

Referenced by ilObjLanguageExt\_deleteValues(), ilObjLanguageExt\_saveValues(), ilObjLanguageExtGUI\saveNewEntryObject(), and ilPluginLanguage\updateLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetUserLanguage()

ilObjLanguage::resetUserLanguage ( string $lang_key )

search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english).

A message is sent to all affected users

$lang_key international language key (2 digits)

Definition at line 618 of file class.ilObjLanguage.php.

                                                       : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $query = "UPDATE usr_pref SET " .
                "value = " . $ilDB->quote($this->lang_default, "text") . " " .
                "WHERE keyword = " . $ilDB->quote('language', "text") . " " .
                "AND value = " . $ilDB->quote($lang_key, "text");
        $ilDB->manipulate($query);
    }

References $DIC, and $ilDB.

Referenced by uninstall().

Here is the caller graph for this function:

◆ uninstall()

ilObjLanguage::uninstall ( )

uninstall current language

Return uninstalled language key

Definition at line 209 of file class.ilObjLanguage.php.

                               : string
    {
        if ((str_starts_with($this->status, "installed")) && ($this->key != $this->lang_default) && ($this->key != $this->lang_user)) {
            $this->flush();
            $this->setTitle($this->key);
            $this->setDescription("not_installed");
            $this->update();
            $this->resetUserLanguage($this->key);
 
            return $this->key;
        }
        return "";
    }

References $key, flush(), resetUserLanguage(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().

Here is the call graph for this function:

◆ updateLangEntry()

static ilObjLanguage::updateLangEntry	(	string	$a_module,
		string	$a_identifier,
		string	$a_lang_key,
		string	$a_value,
		?string	$a_local_change = `null`,
		?string	$a_remarks = `null`
	)

staticfinal

Replace lang entry.

Definition at line 553 of file class.ilObjLanguage.php.

     : void {
        global $DIC;
        $ilDB = $DIC->database();
 
        if (is_string($a_remarks) && $a_remarks !== '') {
            $a_remarks = substr($a_remarks, 0, 250);
        }
 
        if ($a_remarks === '') {
            $a_remarks = null;
        }
 
        if ($a_value === "") {
            $a_value = null;
        } else {
            $a_value = substr($a_value, 0, 4000);
        }
 
        $ilDB->manipulate(sprintf(
            "UPDATE lng_data " .
            "SET value = %s, local_change = %s, remarks = %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_remarks, "text"),
            $ilDB->quote($a_module, "text"),
            $ilDB->quote($a_identifier, "text"),
            $ilDB->quote($a_lang_key, "text")
        ));
    }

Field Documentation

◆ $comment_separator

string ilObjLanguage::$comment_separator

Definition at line 36 of file class.ilObjLanguage.php.

◆ $cust_lang_path

string ilObjLanguage::$cust_lang_path

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

Referenced by ilObjLanguageExt\getCustLangPath(), and insert().

◆ $key

string ilObjLanguage::$key

Definition at line 40 of file class.ilObjLanguage.php.

Referenced by getKey(), and uninstall().

◆ $lang_default

string ilObjLanguage::$lang_default

Definition at line 37 of file class.ilObjLanguage.php.

◆ $lang_path

string ilObjLanguage::$lang_path

Definition at line 39 of file class.ilObjLanguage.php.

Referenced by ilObjLanguageExt\getLangPath(), and insert().

◆ $lang_user

string ilObjLanguage::$lang_user

Definition at line 38 of file class.ilObjLanguage.php.

◆ $separator

string ilObjLanguage::$separator

separator of module, comment separator, identifier & values in language files

Definition at line 35 of file class.ilObjLanguage.php.

◆ $status

string ilObjLanguage::$status

Definition at line 41 of file class.ilObjLanguage.php.

Referenced by getStatus().

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

components/ILIAS/Language/classes/class.ilObjLanguage.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteLangData()

◆ _getLastLocalChange()

◆ _getLocalChangesByModule()

◆ check()

◆ countUsers()

◆ cut_header()

◆ deleteLangEntry()

◆ flush()

◆ getInstalledLanguages()

◆ getKey()

◆ getLocalChanges()

◆ getStatus()

◆ insert()

◆ install()

◆ isInstalled()

◆ isLocal()

◆ isSystemLanguage()

◆ isUserLanguage()

◆ optimizeData()

◆ refresh()

◆ refreshAll()

◆ refreshPlugins()

◆ replaceLangEntry()

◆ replaceLangModule()

◆ resetUserLanguage()

◆ uninstall()

◆ updateLangEntry()

Field Documentation

◆ $comment_separator

◆ $cust_lang_path

◆ $key

◆ $lang_default

◆ $lang_path

◆ $lang_user

◆ $separator

◆ $status