Class ilObjLanguageFolder contains all function to manage language support for ILIAS3 install, uninstall, checkfiles .... More...

Inheritance diagram for ilObjLanguageFolder:

Collaboration diagram for ilObjLanguageFolder:

Public Member Functions
	__construct ($a_id, $a_call_by_reference=true)
	Constructor public. More...

	getLanguages ()
	gather all information about available languages More...

	addNewLanguages ($a_languages)
	add new languages More...

	removeLanguages ($a_languages)
	remove languages which are not installed AND has no lang-file More...

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

Data Fields
	$lang_default

	$lang_user

	$lang_path

	$separator

	$languages

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

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjLanguageFolder contains all function to manage language support for ILIAS3 install, uninstall, checkfiles ....

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

Version: $Id$

Definition at line 18 of file class.ilObjLanguageFolder.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjLanguageFolder::__construct	(	$a_id,
		$a_call_by_reference = `true`
	)

Constructor public.

Parameters

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

Definition at line 69 of file class.ilObjLanguageFolder.php.

References $DIC, and ilObject\$lng.

     {
         global $DIC;
         $lng = $DIC->language();
 
         $this->type = "lngf";
         parent::__construct($a_id, $a_call_by_reference);
 
         $this->lang_path = $lng->lang_path;
         $this->lang_default = $lng->lang_default;
         $this->lang_user = $lng->lang_user;
         $this->separator = $lng->separator;
     }

Member Function Documentation

◆ addNewLanguages()

ilObjLanguageFolder::addNewLanguages ( $a_languages )

add new languages

This functions checks in $languages for languages with the attribute 'new' and insert these languages in db-table 'languages'

Parameters

array $languages expect $languages

Returns: boolean true: language array is not empty, otherwise false

Definition at line 187 of file class.ilObjLanguageFolder.php.

Referenced by getLanguages().

     {
         if (count($a_languages) > 0) {
             foreach ($a_languages as $lang_key => $lang_data) {
                 if ($lang_data["info"] == "new_language") {
                     include_once("./Services/Language/classes/class.ilObjLanguage.php");
                     $lngObj = new ilObjLanguage();
                     $lngObj->setTitle($lang_key);
                     $lngObj->setDescription("not_installed");
                     $lngObj->create();
 
                     // must get OOP through the whole class some time
                     // (no arrays with db fields! this class doesn't know anything about table object!)
                     $a_languages[$lang_key] = array("obj_id" => $lngObj->getId(),
                                                     "type" => $lngObj->getType(),
                                                     "description" => $lngObj->getDescription(),
                                                     "desc" => $lngObj->getDescription(),
                                                     "owner" => $lngObj->getOwner(),
                                                     "create_date" => $lngObj->getCreateDate(),
                                                     "last_update" => $lngObj->getLastUpdateDate());
 
                     $a_languages[$lang_key]["info"] = "new_language";
                     unset($lngObj);                     // better: the objects should be resident in an member array of this class
                 }
             }
         }
 
         return $a_languages;
     }

Here is the caller graph for this function:

◆ checkAllLanguages()

ilObjLanguageFolder::checkAllLanguages ( )

validate the logical structure of a lang-file

This function is similar to function checkLanguage() (see below) but checks for all lang-files and outputs more helpful information.

Returns: string system message

Definition at line 256 of file class.ilObjLanguageFolder.php.

References $d, $DIC, ilObject\$error, $key, ilObject\$lng, Sabre\VObject\$output, and ilObjLanguage\cut_header().

     {
         global $DIC;
         // TODO: lng object should not be used in this class
         $lng = $DIC->language();
 
         // set path to directory where lang-files reside
         $d = dir($this->lang_path);
         $tmpPath = getcwd();
         chdir($this->lang_path);
 
         // for giving a message when no lang-file was found
         $found = false;
 
         // get available lang-files
         while ($entry = $d->read()) {
             if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang$)~", $entry))) {
                 // textmeldung, wenn langfile gefunden wurde
                 $output .= "<br/><br/>" . $lng->txt("langfile_found") . ": " . $entry;
                 $content = file($entry);
 
                 $found = true;
                 $error = false;
 
                 if ($content = ilObjLanguage::cut_header($content)) {
                     foreach ($content as $key => $val) {
                         $separated = explode($this->separator, trim($val));
                         $num = count($separated);
 
                         if ($num != 3) {
                             $error = true;
                             $line = $key + 37;
 
                             $output .= "<br/><b/>" . $lng->txt("err_in_line") . " " . $line . " !</b>&nbsp;&nbsp;";
                             $output .= $lng->txt("module") . ": " . $separated[0];
                             $output .= ", " . $lng->txt("identifier") . ": " . $separated[1];
                             $output .= ", " . $lng->txt("value") . ": " . $separated[2];
 
                             switch ($num) {
                                 case 1:
                                     if (empty($separated[0])) {
                                         $output .= "<br/>" . $lng->txt("err_no_param") . " " . $lng->txt("check_langfile");
                                     } else {
                                         $output .= "<br/>" . $lng->txt("err_1_param") . " " . $lng->txt("check_langfile");
                                     }
                                 break;
 
                                 case 2:
                                     $output .= "<br/>" . $lng->txt("err_2_param") . " " . $lng->txt("check_langfile");
                                 break;
 
                                 default:
                                     $output .= "<br/>" . $lng->txt("err_over_3_param") . " " . $lng->txt("check_langfile");
                                 break;
                             }
                         }
                     }
 
                     if ($error) {
                         $output .= "<br/>" . $lng->txt("file_not_valid") . " " . $lng->txt("err_count_param");
                     } else {
                         $output .= "<br/>" . $lng->txt("file_valid");
                     }
                 } else {
                     $output .= "<br/>" . $lng->txt("file_not_valid") . " " . $lng->txt("err_wrong_header");
                 }
             }
         }
 
         $d->close();
 
         if (!$found) {
             $output .= "<br/>" . $lng->txt("err_no_langfile_found");
         }
 
         chdir($tmpPath);
         return $output;
     }

Here is the call graph for this function:

◆ getLanguages()

ilObjLanguageFolder::getLanguages ( )

gather all information about available languages

This function builds an array with the following structure: $languages[lang_key][long][installed][update][info]

lang_key: string international language key (2 digits, i.e. de,en,dk...) long: string full language name in the chosen user language installed: boolean is the language installed (true) or not (false)? update: int contains the timestamp of last db-modification info: string optional information. valid is: 'notfound','new'

Returns: array $languages status information about available languages

Definition at line 97 of file class.ilObjLanguageFolder.php.

References $d, $DIC, $lang, $language, $languages, ilObject\$lng, ilObject\_getObjectsByType(), addNewLanguages(), and removeLanguages().

     {
         global $DIC;
         $lng = $DIC->language();
         
         $lng->loadLanguageModule("meta");
 
         // set path to directory where lang-files reside
         $d = dir($this->lang_path);
         $tmpPath = getcwd();
         chdir($this->lang_path);
 
         // get available lang-files
         while ($entry = $d->read()) {
             if (is_file($entry) && (preg_match("~(^ilias_.{2}\.lang$)~", $entry))) {
                 $lang_key = substr($entry, 6, 2);
                 $languages[$lang_key] = ""; // long names will be set in class Out
             }
         }
 
         // ensure that arrays are initiated when no lang file was found
         if (!array($languages)) {
             $language = array();
             $tmp_array = array();
         }
 
         $tmp_array = array_keys($languages);
         $lang_keys = array();
 
         // now get languages from database
         if ($lang_db = ilObject::_getObjectsByType("lng")) {
             foreach ($lang_db as $lang) {
                 // set values
                 $lang_key = $lang["title"];
                 $languages[$lang_key] = $lang;
                 $lang_keys[] = $lang_key;
 
                 // determine default language and language of current user
                 if ($lang_key == $this->lang_user) {
                     $languages[$lang_key]["status"] = "in_use";
                 }
 
                 if ($lang_key == $this->lang_default) {
                     $languages[$lang_key]["status"] = "system_language";
                 }
 
                 // check if files are missing
                 if ((count($tmp_array) > 0) && (!in_array($lang_key, $tmp_array))) {
                     $languages[$lang_key]["info"] = "file_not_found";
                 }
             }
         }
 
         // compute new languages
         foreach ($languages as $lang_key => $lang_data) {
             if (!in_array($lang_key, $lang_keys)) {
                 $languages[$lang_key] = array();
                 $languages[$lang_key]["info"] = "new_language";
                 //$languages[$lang_key]["desc"] = "not_installed";
             }
         }
 
         chdir($tmpPath);
         
         // Insert languages with files new found into table language
         $languages = $this->addNewLanguages($languages);
 
         // Remove from array & db languages which are not installed and no lang-files
         $languages = $this->removeLanguages($languages);
 
         // setting language's full names
         foreach ($languages as $lang_key => $lang_data) {
             $languages[$lang_key]["name"] = $lng->txt("meta_l_" . $lang_key);
         }
 
         $this->languages = $languages;
 
         return $this->languages;
     }

Here is the call graph for this function:

◆ removeLanguages()

ilObjLanguageFolder::removeLanguages ( $a_languages )

remove languages which are not installed AND has no lang-file

This function removes only the entry in db-table 'languages' and in the array $languages. Does not uninstall a language (see: function flushLanguage())

public

Parameters

array $languages

Returns: array $languages updated status information about available languages

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

References $DIC, $ilDB, and $query.

Referenced by getLanguages().

     {
         global $DIC;
         $ilDB = $DIC->database();
 
         foreach ($a_languages as $lang_key => $lang_data) {
             if ($lang_data["desc"] == "not_installed" && $lang_data["info"] == "file_not_found") {
                 // update languages array
                 unset($a_languages[$lang_key]);
 
                 // update object_data table
                 $query = "DELETE FROM object_data " .
                          "WHERE type = " . $ilDB->quote("lng", "text") . " " .
                          "AND title = " . $ilDB->quote($lang_key, "text");
                 $ilDB->manipulate($query);
             }
         }
 
         return $a_languages;
     }