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 (int $a_id, bool $a_call_by_reference=true)
	Constructor $a_id reference_id or object_id $a_call_by_reference treat the id as reference_id (true) or object_id (false) More...

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

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

	removeLanguages (array $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
	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)
	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...

Data Fields
string	$lang_default
	indicator for the system language this language must not be deleted More...

string	$lang_user
	language that is in use by current user this language must not be deleted More...

string	$lang_path
	path to language files relative path is taken from ini file and added to absolute path of ilias More...

string	$separator
	separator value between module,identivier & value More...

array	$languages
	contians all informations about languages More...

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
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	_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)

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

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 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 31 of file class.ilObjLanguageFolder.php.

Constructor & Destructor Documentation

◆ __construct()

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

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 68 of file class.ilObjLanguageFolder.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

Member Function Documentation

◆ addNewLanguages()

ilObjLanguageFolder::addNewLanguages ( array $a_languages )

add new languages

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

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

Referenced by getLanguages().

                                                        : array
     {
         if (count($a_languages) > 0) {
             foreach ($a_languages as $lang_key => $lang_data) {
                 if (isset($lang_data["info"]) && $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.

Return system message

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

References Vendor\Package\$d, ILIAS\LTI\ToolProvider\$key, ILIAS\LTI\ToolProvider\$reason, ilObjLanguage\cut_header(), and ILIAS\Repository\lng().

                                        : string
     {
         // 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;
 
         $output = '';
         // 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/>" . $this->lng->txt("langfile_found") . ": " . $entry;
                 $content = file($entry);
                 $lines_full = count($content);
                 $found = true;
                 $error_param = false;
                 $error_double = false;
                 $double_checker = [];
 
                 if ($content = ilObjLanguage::cut_header($content)) {
                     $lines_cut = count($content);
                     foreach ($content as $key => $val) {
                         $separated = explode($this->separator, trim($val));
                         $num = count($separated);
                         $line = $key + $lines_full - $lines_cut + 1;
 
                         if ($num !== 3) {
                             $error_param = true;
                             $output .= "<br/><b/>" . $this->lng->txt("err_in_line") . " " . $line . " !</b>&nbsp;&nbsp;";
                             
                             switch ($num) {
                                 case 1:
                                     if (empty($separated[0])) {
                                         $output .= "<br/>" . $this->lng->txt("err_no_param") . " " . $this->lng->txt("check_langfile");
                                     } else {
                                         $output .= $this->lng->txt("module") . ": " . $separated[0];
                                         $output .= "<br/>" . $this->lng->txt("err_1_param") . " " . $this->lng->txt("check_langfile");
                                     }
                                     break;
                                 
                                 case 2:
                                     $output .= $this->lng->txt("module") . ": " . $separated[0];
                                     $output .= ", " . $this->lng->txt("identifier") . ": " . $separated[1];
                                     $output .= "<br/>" . $this->lng->txt("err_2_param") . " " . $this->lng->txt("check_langfile");
                                     break;
                                 
                                 default:
                                     $output .= $this->lng->txt("module") . ": " . $separated[0];
                                     $output .= ", " . $this->lng->txt("identifier") . ": " . $separated[1];
                                     $output .= ", " . $this->lng->txt("value") . ": " . $separated[2];
                                     $output .= "<br/>" . $this->lng->txt("err_over_3_param") . " " . $this->lng->txt("check_langfile");
                                     break;
                             }
                             continue;
                         }
                         if ($double_checker[strtolower($separated[0])][strtolower($separated[1])] ?? false) {
                             $error_double = true;
                             
                             $output .= "<br/><b/>" . $this->lng->txt("err_in_line") . " " . $double_checker[strtolower($separated[0])][strtolower($separated[1])] . " " . $this->lng->txt("and") . " " . $line . " !</b>&nbsp;&nbsp;";
                             $output .= $this->lng->txt("module") . ": " . $separated[0];
                             $output .= ", " . $this->lng->txt("identifier") . ": " . $separated[1];
                             $output .= ", " . $this->lng->txt("value") . ": " . $separated[2];
                         }
                         $double_checker[strtolower($separated[0])][strtolower($separated[1])] = $line;
                     }
                     if ($error_param || $error_double) {
                         $reason = "";
                         if ($error_param) {
                             $reason .= " " . $this->lng->txt("err_count_param");
                         }
                         if ($error_double) {
                             $reason .= " " . $this->lng->txt("err_double_entries");
                         }
                         $output .= "<br/>" . $this->lng->txt("file_not_valid") . $reason;
                     } else {
                         $output .= "<br/>" . $this->lng->txt("file_valid");
                     }
                 } else {
                     $output .= "<br/>" . $this->lng->txt("file_not_valid") . " " . $this->lng->txt("err_wrong_header");
                 }
             }
         }
 
         $d->close();
 
         if (!$found) {
             $output .= "<br/>" . $this->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 $languages status information about available languages

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

References Vendor\Package\$d, $lang, $languages, ilObject\_getObjectsByType(), addNewLanguages(), ILIAS\Repository\lng(), and removeLanguages().

                                   : array
     {
         $this->lng->loadLanguageModule("meta");
 
         // set path to directory where lang-files reside
         $d = dir($this->lang_path);
         $tmpPath = getcwd();
         chdir($this->lang_path);
 
         $languages = [];
 
         // 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
             }
         }
 
         $language = 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;
 
                 $languages[$lang_key]["info"] = "";
                 $languages[$lang_key]["status"] = "";
 
                 // 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, true)) {
                     $languages[$lang_key]["info"] = "file_not_found";
                 }
             }
         }
 
         // compute new languages
         foreach ($languages as $lang_key => $lang_data) {
             if (!in_array($lang_key, $lang_keys, true)) {
                 $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"] = $this->lng->txt("meta_l_" . $lang_key);
         }
 
         $this->languages = $languages;
 
         return $this->languages;
     }

Here is the call graph for this function:

◆ removeLanguages()

ilObjLanguageFolder::removeLanguages ( array $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())

Return $languages updated status information about available languages

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

Referenced by getLanguages().

                                                        : array
     {
         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 = " . $this->db->quote("lng", "text") . " " .
                          "AND title = " . $this->db->quote($lang_key, "text");
                 $this->db->manipulate($query);
             }
         }
 
         return $a_languages;
     }