ILIAS  Release_3_10_x_branch Revision 61812
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields
ilObjLanguage Class Reference

Class ilObjLanguage. More...

+ Inheritance diagram for ilObjLanguage:
+ Collaboration diagram for ilObjLanguage:

Public Member Functions

 ilObjLanguage ($a_id=0, $a_call_by_reference=false)
 Constructor.
 getKey ()
 get language key
 getStatus ()
 get language status
 isSystemLanguage ()
 check if language is system language
 isUserLanguage ()
 check if language is system language
 isInstalled ()
 Check language object status, and return true if language is installed.
 isLocal ()
 Check language object status, and return true if a local language file is installed.
 install ($scope= '')
 install current language
 uninstall ()
 uninstall current language
 flush ($a_mode= 'all')
 remove language data from database
 getLocalChanges ($a_min_date="", $a_max_date="")
 get locally changed language entries
 insert ($scope= '')
 insert language data from file into database
 resetUserLanguage ($lang_key)
 search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english).
 cut_header ($content)
 remove lang-file haeder information from '$content' This function seeks for a special keyword where the language information starts.
 optimizeData ()
 optimizes the db-table langdata
 check ($scope= '')
 Validate the logical structure of a lang file.
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public.
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not)
 read ($a_force_db=false)
 read object data from db into object
 getId ()
 get object id public
 setId ($a_id)
 set object id public
 setRefId ($a_id)
 set reference id public
 getRefId ()
 get reference id public
 getType ()
 get object type public
 setType ($a_type)
 set object type public
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions
 getTitle ()
 get object title public
 getUntranslatedTitle ()
 get untranslated object title public
 setTitle ($a_title)
 set object title
 getDescription ()
 get object description
 setDescription ($a_desc)
 set object description
 getLongDescription ()
 get object long description (stored in object_description)
 getImportId ()
 get import id
 setImportId ($a_import_id)
 set import id
 _lookupObjIdByImportId ($a_import_id)
 getOwner ()
 get object owner
 getOwnerName ()
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id
 setOwner ($a_owner)
 set object owner
 getCreateDate ()
 get create date public
 getLastUpdateDate ()
 get last update date public
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class)
 create ()
 create
 update ()
 update object in db
 MDUpdateListener ($a_element)
 Meta data update listener.
 createMetaData ()
 create meta data entry
 updateMetaData ()
 update meta data entry
 deleteMetaData ()
 delete meta data entry
 updateOwner ()
 update owner of object in db
 _getIdForImportId ($a_import_id)
 get current object id for import id (static)
 _getAllReferences ($a_id)
 get all reference ids of object
 _lookupTitle ($a_id)
 lookup object title
 _lookupDescription ($a_id)
 lookup object description
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects.
 _lookupObjId ($a_id)
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static)
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static)
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static)
 _lookupType ($a_id, $a_reference=false)
 lookup object type
 _isInTrash ($a_ref_id)
 checks wether object is in trash
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash
 _lookupObjectId ($a_ref_id)
 lookup object id
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!?
 setPermissions ($a_parent_ref)
 set permissions of object
 createReference ()
 creates reference for object
 countReferences ()
 count references of object
 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!!
 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
 createRoleFolder ()
 creates a local role folder
 notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
 notifys an object about an event occured Based on the event passed, each object may decide how it reacts.
 setRegisterMode ($a_bool)
 isUserRegistered ($a_user_id=0)
 requireRegistration ()
 getXMLZip ()
 getHTMLDirectory ()
 cloneObject ($a_target_id, $a_copy_id=0)
 Clone object permissions, put in tree ...
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container.
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies.
 cloneMetaData ($target_obj)
 Copy meta data.

Static Public Member Functions

static replaceLangModule ($a_key, $a_module, $a_array)
 Replace language module array.
- Static Public Member Functions inherited from ilObject
static _getIdsForTitle ($title, $type= '')
 _exists ($a_id, $a_reference=false)
 checks if an object exists in object_data
static _getObjectsByType ($a_obj_type="")
 Get objects by type.
static _prepareCloneSelection ($a_ref_ids, $new_type)
 Prepare copy wizard object selection.
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

Data Fields

 $separator
 $comment_separator
 $lang_default
 $lang_user
 $lang_path
 $key
 $status
- Data Fields inherited from ilObject
 $ilias
 $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
 $obj_data_record
 object_data record

Detailed Description

Class ilObjLanguage.

Author
Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e
Version
Id:
class.ilObjLanguage.php 17608 2008-10-07 10:19:11Z akill

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

Member Function Documentation

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$scopeempty (global) or "local"

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

References $key, $lang_path, $n, and cut_header().

Referenced by install().

{
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
if (!$content = $this->cut_header(file($lang_file)))
{
$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);
}
}
chdir($tmpPath);
// no error occured
return true;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjLanguage::cut_header (   $content)

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$contentexpecting an ILIAS lang-file
Returns
string $content content without header info OR false if no valid header was found

Definition at line 499 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:

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

remove language data from database

Parameters
string"all" or "keep_local"

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

Referenced by install(), and uninstall().

{
global $ilDB;
$query = "DELETE FROM lng_data WHERE lang_key=".
$ilDB->quote($this->key);
if ($a_mode == 'keep_local')
{
$query .= " AND local_change='0000-00-00 00:00:00'";
}
$ilDB->query($query);
if ($a_mode == 'all')
{
$query = "DELETE FROM lng_modules WHERE lang_key=".
$ilDB->quote($this->key);
$ilDB->query($query);
}
}

+ Here is the caller graph for this function:

ilObjLanguage::getKey ( )

get language key

Returns
string language key

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

References $key.

Referenced by install().

{
return $this->key;
}

+ Here is the caller graph for this function:

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

get locally changed language entries

Parameters
stringminimum change date "yyyy-mm-dd hh:mm:ss"
stringmaximum change date "yyyy-mm-dd hh:mm:ss"
Returns
array [module][identifier] => value

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

References $result, and DB_FETCHMODE_ASSOC.

Referenced by insert().

{
global $ilDB;
$query = "SELECT * FROM lng_data WHERE"
." lang_key =".$ilDB->quote($this->key);
if ($a_min_date <> "")
{
$query .= " and local_change >= ".$ilDB->quote($a_min_date);
}
if ($a_max_date <> "")
{
$query .= " and local_change <= ".$ilDB->quote($a_max_date);
}
$result = $ilDB->query($query);
$changes = array();
while ($row = $result->fetchRow(DB_FETCHMODE_ASSOC))
{
$changes[$row["module"]][$row["identifier"]] = $row["value"];
}
return $changes;
}

+ Here is the caller graph for this function:

ilObjLanguage::getStatus ( )

get language status

Returns
string language status

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

References $status.

Referenced by isInstalled(), and isLocal().

{
return $this->status;
}

+ Here is the caller graph for this function:

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

Constructor.

public

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

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

References ilObject\$desc, ilObject\$lng, ilObject\$title, and ilObject\ilObject().

Referenced by ilObjLanguageExt\ilObjLanguageExt().

{
global $lng;
$this->type = "lng";
$this->ilObject($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;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjLanguage::insert (   $scope = '')

insert language data from file into database

Parameters
string$scopeempty (global) or "local"

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

References $key, $lang_path, cut_header(), DB_FETCHMODE_ASSOC, and getLocalChanges().

Referenced by install().

{
global $ilDB;
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_" . $this->key . ".lang" . $scopeExtension;
if ($lang_file)
{
// initialize the array for updating lng_modules below
$lang_array = array();
$lang_array["common"] = array();
// remove header first
if ($content = $this->cut_header(file($lang_file)))
{
// get the local changes from the database
if (empty($scope))
{
$local_changes = $this->getLocalChanges();
}
else if ($scope == 'local')
{
$change_date = date("Y-m-d H:i:s",time());
$min_date = date("Y-m-d H:i:s", filemtime($lang_file));
$local_changes = $this->getLocalChanges($min_date);
}
foreach ($content as $key => $val)
{
$separated = explode($this->separator,trim($val));
//get position of the comment_separator
$pos = strpos($separated[2], $this->comment_separator);
if ($pos !== false)
{
//cut comment of
$separated[2] = substr($separated[2] , 0 , $pos);
}
// check if the value has a local change
$local_value = $local_changes[$separated[0]][$separated[1]];
if (empty($scope))
{
if ($local_value != "" and $local_value != $separated[2])
{
// keep the locally changed value
$lang_array[$separated[0]][$separated[1]] = $local_value;
}
else
{
if ($double_checker[$separated[0]][$separated[1]][$this->key])
{
$this->ilias->raiseError("Duplicate Language Entry: ".
$separated[0]."-".$separated[1]."-".$this->key,
$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 if the values are equal
$query = "REPLACE INTO lng_data " .
"(module, identifier, lang_key, value, local_change) " .
"VALUES " .
"(".$ilDB->quote($separated[0]).",".
$ilDB->quote($separated[1]).",".
$ilDB->quote($this->key).",".
$ilDB->quote($separated[2]).",".
$ilDB->quote("0000-00-00 00:00:00").")";
$ilDB->query($query);
$lang_array[$separated[0]][$separated[1]] = $separated[2];
}
}
else if ($scope == 'local')
{
if ($local_value != "")
{
// keep a locally changed value that is newer than the local file
$lang_array[$separated[0]][$separated[1]] = $local_value;
}
else
{
// UPDATE because the global values have already been INSERTed
$query = "UPDATE lng_data SET ".
"value = ".$ilDB->quote($separated[2]).", " .
"local_change = ".$ilDB->quote($change_date)." " .
"WHERE module = ".$ilDB->quote($separated[0])." " .
"AND identifier = ".$ilDB->quote($separated[1])." " .
"AND lang_key = ".$ilDB->quote($this->key);
$ilDB->query($query);
$lang_array[$separated[0]][$separated[1]] = $separated[2];
}
}
}
if (empty($scope))
{
$query = "UPDATE object_data SET " .
"description = 'installed', " .
"last_update = now() " .
"WHERE title = ".$ilDB->quote($this->key)." " .
"AND type = 'lng'";
$ilDB->query($query);
}
else if ($scope == 'local')
{
$query = "UPDATE object_data SET " .
"description = 'installed_local', " .
"last_update = now() " .
"WHERE title = ".$ilDB->quote($this->key)." " .
"AND type = 'lng'";
$ilDB->query($query);
}
}
foreach($lang_array as $module => $lang_arr)
{
if ($scope == "local")
{
$q = "SELECT * FROM lng_modules WHERE ".
" lang_key = ".$ilDB->quote($this->key).
" AND module = ".$ilDB->quote($module);
$set = $ilDB->query($q);
$row = $set->fetchRow(DB_FETCHMODE_ASSOC);
$arr2 = unserialize($row["lang_array"]);
if (is_array($arr2))
{
$lang_arr = array_merge($arr2, $lang_arr);
}
}
$query = "REPLACE INTO lng_modules (lang_key, module, lang_array) VALUES ".
"(".$ilDB->quote($this->key).", " .
" ".$ilDB->quote($module).", " .
" ".$ilDB->quote(serialize($lang_arr)).") ";
$ilDB->query($query);
}
}
chdir($tmpPath);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjLanguage::install (   $scope = '')

install current language

Returns
string installed language key
Parameters
string$scopeempty (global) or "local"

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

References check(), flush(), getKey(), insert(), isInstalled(), isLocal(), optimizeData(), 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';
}
else if ($scope == 'local')
{
$newDesc = 'installed_local';
}
$this->setDescription($newDesc);
$this->update();
$this->optimizeData();
return $this->getKey();
}
}
return "";
}

+ Here is the call graph for this function:

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

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

References getStatus().

Referenced by install().

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

ilObjLanguage::isSystemLanguage ( )

check if language is system language

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

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

check if language is system language

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

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

optimizes the db-table langdata

Returns
boolean true on success

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

Referenced by install().

{
// optimize
$query = "OPTIMIZE TABLE lng_data";
$this->ilias->db->query($query);
return true;
}

+ Here is the caller graph for this function:

static ilObjLanguage::replaceLangModule (   $a_key,
  $a_module,
  $a_array 
)
staticfinal

Replace language module array.

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

Referenced by ilPlugin\updateLanguages().

{
global $ilDB;
$query = "REPLACE INTO lng_modules (lang_key, module, lang_array) VALUES ".
"(".$ilDB->quote($a_key).", " .
" ".$ilDB->quote($a_module).", " .
" ".$ilDB->quote(serialize($a_array)).") ";
$ilDB->query($query);
}

+ Here is the caller graph for this function:

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_keyinternational language key (2 digits)

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

Referenced by uninstall().

{
global $ilDB;
$query = "UPDATE usr_pref SET " .
"value = ".$ilDB->quote($this->lang_default)." " .
"WHERE keyword = 'language' " .
"AND value = ".$ilDB->quote($lang_key);
$this->ilias->db->query($query);
}

+ Here is the caller graph for this function:

ilObjLanguage::uninstall ( )

uninstall current language

Returns
string uninstalled language key

Definition at line 218 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:

Field Documentation

ilObjLanguage::$comment_separator

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

ilObjLanguage::$key

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

Referenced by ilObjLanguageExt\_saveValues(), check(), cut_header(), ilObjLanguageExt\getCommentedValues(), getKey(), ilObjLanguageExt\importLanguageFile(), insert(), and uninstall().

ilObjLanguage::$lang_default

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

ilObjLanguage::$lang_path

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

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

ilObjLanguage::$lang_user

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

ilObjLanguage::$separator

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

ilObjLanguage::$status

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

Referenced by getStatus().

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