Inheritance diagram for ilObjLanguage:

Collaboration diagram for ilObjLanguage:

Public Member Functions
	__construct ($a_id=0, $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 ($scope='')
	install current language More...

	uninstall ()
	uninstall current language More...

	refresh ()
	refresh current language More...

	flush ($a_mode='all')
	remove language data from database More...

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

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

	resetUserLanguage ($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 ($scope='')
	Validate the logical structure of a lang file. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

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

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

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

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

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

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects 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 ($a_lang_keys=null)

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

static	_getLastLocalChange ($a_key)
	get the date of the last local change More...

static	_getLocalChangesByModule ($a_key, $a_module)
	Get the local changes of a language module. More...

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

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

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

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

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

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

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

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

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

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

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

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$separator

	$comment_separator

	$lang_default

	$lang_user

	$lang_path

	$key

	$status

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Additional Inherited Members
Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

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 14 of file class.ilObjLanguage.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

public

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

References ilObject\$desc, $DIC, ilObject\$lng, and ilObject\$title.

     {
         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->cust_lang_path;
         $this->separator = $lng->separator;
         $this->comment_separator = $lng->comment_separator;
     }

Member Function Documentation

◆ _deleteLangData()

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

static

Delete languge data.

Parameters

string lang key

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

References $DIC, and $ilDB.

Referenced by flush(), and ilObjLanguageExt\getMergedRemarks().

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

Here is the caller graph for this function:

◆ _getLastLocalChange()

static ilObjLanguage::_getLastLocalChange ( $a_key )

static

get the date of the last local change

Parameters

string language key

Returns: array change_date "yyyy-mm-dd hh:mm:ss"

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

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

Referenced by ilObjLanguageFolderGUI\confirmRefreshSelectedObject(), and ilLanguageTableGUI\fillRow().

     {
         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 $row['last_change'];
         } else {
             return "";
         }
     }

Here is the caller graph for this function:

◆ _getLocalChangesByModule()

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

static

Get the local changes of a language module.

Parameters

string	$a_key	Language key
string	$a_module	Module key

Returns: array identifier => value

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

References $DIC, $ilDB, $result, and $row.

Referenced by ilPlugin\updateLanguages().

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

Here is the caller graph for this function:

◆ check()

ilObjLanguage::check ( $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).

Returns: string system message

Parameters

string $scope empty (global) or "local"

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

References $key, $lang_path, $n, $path, cut_header(), and ilStr\isUtf8().

Referenced by install(), and refresh().

     {
         include_once("./Services/Utilities/classes/class.ilStr.php");
         
         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)) {
             $this->ilias->raiseError("Directory not found: " . $path, $this->ilias->error_obj->MESSAGE);
         }
 
         chdir($path);
 
         // compute lang-file name format
         $lang_file = "ilias_" . $this->key . ".lang" . $scopeExtension;
 
         // file check
         if (!is_file($lang_file)) {
             $this->ilias->raiseError("File not found: " . $lang_file, $this->ilias->error_obj->MESSAGE);
         }
 
         // header check
         $content = $this->cut_header(file($lang_file));
         if ($content === false) {
             $this->ilias->raiseError("Wrong Header in " . $lang_file, $this->ilias->error_obj->MESSAGE);
         }
         
         // check (counting) elements of each lang-entry
         $line = 0;
         foreach ($content as $key => $val) {
             $separated = explode($this->separator, trim($val));
             $num = count($separated);
             ++$n;
             if ($num != 3) {
                 $line = $n + 36;
                 $this->ilias->raiseError("Wrong parameter count in " . $lang_file . " in line $line (Value: $val)! Please check your language file!", $this->ilias->error_obj->MESSAGE);
             }
             if (!ilStr::isUtf8($separated[2])) {
                 $this->ilias->raiseError("Non UTF8 character found in " . $lang_file . " in line $line (Value: $val)! Please check your language file!", $this->ilias->error_obj->MESSAGE);
             }
         }
 
         chdir($tmpPath);
 
         // no error occured
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countUsers()

static ilObjLanguage::countUsers ( $a_lang )

static

Count number of users that use a language.

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

References $DIC, $ilDB, and ilObject\$lng.

Referenced by ilLanguageTableGUI\fillRow().

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

Here is the caller graph for this function:

◆ cut_header()

static ilObjLanguage::cut_header ( $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

Parameters

string $content expecting an ILIAS lang-file

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

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

References $key.

Referenced by check(), ilObjLanguageFolder\checkAllLanguages(), and insert().

     {
         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:

◆ deleteLangEntry()

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

staticfinal

Delete lang entry.

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

References $DIC, and $ilDB.

Referenced by ilObjLanguageExt\_deleteValues().

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

Here is the caller graph for this function:

◆ flush()

ilObjLanguage::flush ( $a_mode = 'all' )

remove language data from database

Parameters

string "all" or "keep_local"

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

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

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

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

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.

Returns: self[]

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

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

Referenced by ilPlugin\updateLanguages().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getKey()

ilObjLanguage::getKey ( )

get language key

Returns: string language key

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

References $key.

Referenced by install(), and refresh().

     {
         return $this->key;
     }

Here is the caller graph for this function:

◆ getLocalChanges()

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

get locally changed language entries

Parameters

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 342 of file class.ilObjLanguage.php.

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

Referenced by insert().

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

Here is the caller graph for this function:

◆ getStatus()

ilObjLanguage::getStatus ( )

get language status

Returns: string language status

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

References $status.

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

     {
         return $this->status;
     }

Here is the caller graph for this function:

◆ insert()

ilObjLanguage::insert ( $scope = '' )

insert language data from file into database

Parameters

string $scope empty (global) or "local"

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

References $DIC, $ilDB, $ilErr, $key, $lang_path, $ld, $module, $path, $query, $result, $row, cut_header(), ilCachedLanguage\getInstance(), getLocalChanges(), and replaceLangEntry().

Referenced by install(), and refresh().

     {
         global $DIC;
         $ilDB = $DIC->database();
         
         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)) {
             // 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))) {
                 if (empty($scope)) {
                     // reset change date for a global file
                     // get all local changes for a global file
                     $change_date = null;
                     $local_changes = $this->getLocalChanges();
                 } 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($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));
                     $pos = strpos($separated[2], $this->comment_separator);
                     if ($pos !== false) {
                         $separated[3] = substr($separated[2], $pos + strlen($this->comment_separator));
                         $separated[2] = substr($separated[2], 0, $pos);
                     }
 
                     // check if the value has a local change
                     $local_value = $local_changes[$separated[0]][$separated[1]];
 
                     if (empty($scope)) {
                         // import of a global language file
 
                         if ($local_value != "" and $local_value != $separated[2]) {
                             // keep an existing and different local calue
                             $lang_array[$separated[0]][$separated[1]] = $local_value;
                         } else {
                             // check for double entries in global file
                             if ($double_checker[$separated[0]][$separated[1]][$this->key]) {
                                 $this->ilias->raiseError(
                                     "Duplicate Language Entry in $lang_file:\n$val",
                                     $this->ilias->error_obj->MESSAGE
                                 );
                             }
                             $double_checker[$separated[0]][$separated[1]][$this->key] = true;
                             
                             // insert a new value if no local value exists
                             // reset local change date if the values are equal
                             ilObjLanguage::replaceLangEntry(
                                 $separated[0],
                                 $separated[1],
                                 $this->key,
                                 $separated[2],
                                 $change_date,
                                 $separated[3]
                             );
 
                             $lang_array[$separated[0]][$separated[1]] = $separated[2];
                         }
                     } elseif ($scope == 'local') {
                         // import of a local language file
 
                         if ($local_value != "") {
                             // keep a locally changed value that is newer than the file
                             $lang_array[$separated[0]][$separated[1]] = $local_value;
                         } else {
                             // insert a new value if no global value exists
                             // (local files may have additional entries for customizations)
                             // set the change date to the import date
                             ilObjLanguage::replaceLangEntry(
                                 $separated[0],
                                 $separated[1],
                                 $this->key,
                                 $separated[2],
                                 $change_date,
                                 $separated[3]
                             );
 
                             $lang_array[$separated[0]][$separated[1]] = $separated[2];
                         }
                     }
                 }
 
                 $ld = "";
                 if (empty($scope)) {
                     $ld = "installed";
                 } elseif ($scope == 'local') {
                     $ld = "installed_local";
                 }
                 if ($ld) {
                     $query = "UPDATE object_data SET " .
                             "description = " . $ilDB->quote($ld, "text") . ", " .
                             "last_update = " . $ilDB->now() . " " .
                             "WHERE title = " . $ilDB->quote($this->key, "text") . " " .
                             "AND type = 'lng'";
                     $ilDB->manipulate($query);
                 }
             }
             
             foreach ($lang_array as $module => $lang_arr) {
                 if ($scope == "local") {
                     $q = "SELECT * FROM lng_modules WHERE " .
                         " lang_key = " . $ilDB->quote($this->key, "text") .
                         " AND module = " . $ilDB->quote($module, "text");
                     $set = $ilDB->query($q);
                     $row = $ilDB->fetchAssoc($set);
                     $arr2 = unserialize($row["lang_array"]);
                     if (is_array($arr2)) {
                         $lang_arr = array_merge($arr2, $lang_arr);
                     }
                 }
                 ilObjLanguage::replaceLangModule($this->key, $module, $lang_arr);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ install()

ilObjLanguage::install ( $scope = '' )

install current language

Returns: string installed language key

Parameters

string $scope empty (global) or "local"

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

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

     {
         if (!empty($scope)) {
             if ($scope == 'global') {
                 $scope = '';
             } else {
                 $scopeExtension = '.' . $scope;
             }
         }
 
         if (($this->isInstalled() == false) ||
                 ($this->isInstalled() == true && $this->isLocal() == false && !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
                 if (empty($scope)) {
                     $newDesc = 'installed';
                 } elseif ($scope == 'local') {
                     $newDesc = 'installed_local';
                 }
                 $this->setDescription($newDesc);
                 $this->update();
                 return $this->getKey();
             }
         }
         return "";
     }

Here is the call graph for this function:

◆ isInstalled()

ilObjLanguage::isInstalled ( )

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

Returns: boolean true if installed

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

References getStatus().

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

     {
         if (substr($this->getStatus(), 0, 9) == "installed") {
             return true;
         } else {
             return false;
         }
     }

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.

Returns: boolean true if local language is installed

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

References getStatus().

Referenced by install(), and refresh().

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

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 103 of file class.ilObjLanguage.php.

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

◆ isUserLanguage()

ilObjLanguage::isUserLanguage ( )

check if language is system language

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

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

◆ optimizeData()

ilObjLanguage::optimizeData ( )

optimizes the db-table langdata

Returns: boolean true on success

Deprecated:

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

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

◆ refresh()

ilObjLanguage::refresh ( )

refresh current language

Returns: bool

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

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

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

Here is the call graph for this function:

◆ refreshAll()

static ilObjLanguage::refreshAll ( )

static

Refresh all installed languages.

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

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

Referenced by ilObjLanguageFolderGUI\refreshObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshPlugins()

static ilObjLanguage::refreshPlugins ( $a_lang_keys = null )

static

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

References $DIC, ilPluginSlot\getAllSlots(), and ilPlugin\getPluginObject().

Referenced by ilObjLanguageFolderGUI\refreshSelectedObject().

     {
         global $DIC;
         $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
         // refresh languages of activated plugins
         include_once("./Services/Component/classes/class.ilPluginSlot.php");
         $slots = ilPluginSlot::getAllSlots();
         foreach ($slots as $slot) {
             $act_plugins = $ilPluginAdmin->getActivePluginsForSlot(
                 $slot["component_type"],
                 $slot["component_name"],
                 $slot["slot_id"]
             );
             foreach ($act_plugins as $plugin) {
                 include_once("./Services/Component/classes/class.ilPlugin.php");
                 $pl = ilPlugin::getPluginObject(
                     $slot["component_type"],
                     $slot["component_name"],
                     $slot["slot_id"],
                     $plugin
                 );
                 if (is_object($pl)) {
                     $pl->updateLanguages($a_lang_keys);
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replaceLangEntry()

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

staticfinal

Replace lang entry.

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

References $DIC, and $ilDB.

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

       {
         global $DIC;
         $ilDB = $DIC->database();
 
         // avoid a cache flush here (see mantis #28818)
         // ilGlobalCache::flushAll();
 
         if (isset($a_remarks)) {
             $a_remarks = substr($a_remarks, 0, 250);
         }
         if ($a_remarks == '') {
             unset($a_remarks);
         }
 
         if (isset($a_value)) {
             $a_value = substr($a_value, 0, 4000);
         }
         if ($a_value == '') {
             unset($a_value);
         }
 
         $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;
         
         /*
         $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")));
 
 
         $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:

◆ resetUserLanguage()

ilObjLanguage::resetUserLanguage ( $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

Parameters

string $lang_key international language key (2 digits)

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

References $DIC, $ilDB, and $query.

Referenced by uninstall().

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

Here is the caller graph for this function:

◆ uninstall()

ilObjLanguage::uninstall ( )

uninstall current language

Returns: string uninstalled language key

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

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

     {
         if ((substr($this->status, 0, 9) == "installed") && ($this->key != $this->lang_default) && ($this->key != $this->lang_user)) {
             $this->flush('all');
             $this->setTitle($this->key);
             $this->setDescription("not_installed");
             $this->update();
             $this->resetUserLanguage($this->key);
 
             return $this->key;
         }
         return "";
     }

Here is the call graph for this function:

◆ updateLangEntry()

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

staticfinal

Replace lang entry.

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

References $DIC, and $ilDB.

       {
         global $DIC;
         $ilDB = $DIC->database();
 
         if (isset($a_remarks)) {
             $a_remarks = substr($a_remarks, 0, 250);
         }
         if ($a_remarks == '') {
             unset($a_remarks);
         }
 
         if (isset($a_value)) {
             $a_value = substr($a_value, 0, 4000);
         }
         if ($a_value == '') {
             unset($a_value);
         }
 
         $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

ilObjLanguage::$comment_separator

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

◆ $key

ilObjLanguage::$key

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

Referenced by ilObjLanguageExt\_deleteValues(), ilObjLanguageExt\_saveValues(), check(), cut_header(), getKey(), ilObjLanguageExt\getMergedRemarks(), insert(), and uninstall().

◆ $lang_default

ilObjLanguage::$lang_default

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

◆ $lang_path

ilObjLanguage::$lang_path

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

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

◆ $lang_user

ilObjLanguage::$lang_user

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

◆ $separator

ilObjLanguage::$separator

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

◆ $status

ilObjLanguage::$status

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

Referenced by getStatus().

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

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

◆ resetUserLanguage()

◆ uninstall()

◆ updateLangEntry()

Field Documentation

◆ $comment_separator

◆ $key

◆ $lang_default

◆ $lang_path

◆ $lang_user

◆ $separator

◆ $status