ilObjLanguageExt Class Reference

Class ilObjLanguageExt. More...

Inheritance diagram for ilObjLanguageExt:

Collaboration diagram for ilObjLanguageExt:

Public Member Functions
	getGlobalLanguageFile ()
	Read and get the global language file as an object. More...
	setLocal (bool $a_local=true)
	Set the local status of the language. More...
	getLongDescription ()
	Get the full language description. More...
	getDataPath ()
	Return the path for language data written by ILIAS. More...
	getLangPath ()
	Get the language files path. More...
	getCustLangPath ()
	Get the customized language files path. More...
	getAllRemarks ()
	Get all remarks from the database. More...
	getAllValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get all values from the database. More...
	getChangedValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get only the changed values from the database which differ from the original language file. More...
	getUnchangedValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get only the unchanged values from the database which are equal to the original language file. More...
	getAddedValues (array $a_modules=array(), string $a_pattern='', array $a_topics=array())
	Get only the entries which don't exist in the global language file. More...
	getCommentedValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get all values from the database for wich the global language file has a comment. More...
	getMergedValues ()
	Get the local values merged into the values of the global language file. More...
	getMergedRemarks ()
	Get the local remarks merged into the remarks of the global language file. More...
Public Member Functions inherited from ilObjLanguage
	__construct (int $a_id=0, bool $a_call_by_reference=false)
	Constructor. More...
	getKey ()
	get language key More...
	getStatus ()
	get language status More...
	isSystemLanguage ()
	check if language is system language More...
	isUserLanguage ()
	check if language is system language More...
	isInstalled ()
	Check language object status, and return true if language is installed. More...
	isLocal ()
	Check language object status, and return true if a local language file is installed. More...
	install (string $scope="")
	install current language More...
	uninstall ()
	uninstall current language More...
	refresh ()
	refresh current language More...
	flush (string $a_mode="all")
	remove language data from database $a_mode "all" or "keep_local" More...
	getLocalChanges (string $a_min_date="", string $a_max_date="")
	get locally changed language entries $a_min_date minimum change date "yyyy-mm-dd hh:mm:ss" $a_max_date maximum change date "yyyy-mm-dd hh:mm:ss" Return array [module][identifier] => value More...
	insert (string $scope="")
	insert language data from file into database More...
	resetUserLanguage (string $lang_key)
	search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english). More...
	optimizeData ()
	optimizes the db-table langdata More...
	check (string $scope="")
	Validate the logical structure of a lang file. More...
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_getModules (string $a_lang_key)
	Get all modules of a language. More...
static	_getRemarks (string $a_lang_key, bool $a_all_changed=false)
	Get all remarks of a language. More...
static	_getValues (string $a_lang_key, array $a_modules=array(), array $a_topics=array(), string $a_pattern='', string $a_state='')
	Get the translations of specified topics. More...
static	_saveValues (string $a_lang_key, array $a_values=array(), array $a_remarks=array())
	Save a set of translation in the database. More...
static	_deleteValues (string $a_lang_key, array $a_values=array())
	Delete a set of translation in the database. More...
Static Public Member Functions inherited from ilObjLanguage
static	getInstalledLanguages ()
	Get the language objects of the installed languages. More...
static	refreshAll ()
	Refresh all installed languages. More...
static	refreshPlugins (?array $a_lang_keys=null)
	Refresh languages of activated plugins $a_lang_keys keys of languages to be refreshed (not yet supported, all available will be refreshed) More...
static	_deleteLangData (string $a_lang_key, bool $a_keep_local_change=false)
	Delete languge data $a_lang_key lang key. More...
static	_getLastLocalChange (string $a_key)
	get the date of the last local change $a_key language key Return change_date "yyyy-mm-dd hh:mm:ss" More...
static	_getLocalChangesByModule (string $a_key, string $a_module)
	Get the local changes of a language module $a_key Language key $a_module Module key Return array identifier => value. More...
static	replaceLangModule (string $a_key, string $a_module, array $a_array)
	Replace language module array. More...
static	replaceLangEntry (string $a_module, string $a_identifier, string $a_lang_key, string $a_value, ?string $a_local_change=null, ?string $a_remarks=null)
	Replace lang entry. More...
static	updateLangEntry (string $a_module, string $a_identifier, string $a_lang_key, string $a_value, ?string $a_local_change=null, ?string $a_remarks=null)
	Replace lang entry. More...
static	deleteLangEntry (string $a_module, string $a_identifier, string $a_lang_key)
	Delete lang entry. More...
static	cut_header (array $content)
	remove lang-file haeder information from '$content' This function seeks for a special keyword where the language information starts. More...
static	countUsers (string $a_lang)
	Count number of users that use a language. More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Static Private Member Functions
static	_mergeLanguageEntriesFromRow (?array $databaseRow, array $entries)
	Merge language entries from a database row with existing entries. More...

Additional Inherited Members
Data Fields inherited from ilObjLanguage
string	$separator
	separator of module, comment separator, identifier & values in language files More...
string	$comment_separator
string	$lang_default
string	$lang_user
string	$lang_path
string	$key
string	$status
string	$cust_lang_path
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Detailed Description

Class ilObjLanguageExt.

Author

Fred Neumann fred..nosp@m.neum.nosp@m.ann@f.nosp@m.im.u.nosp@m.ni-er.nosp@m.lang.nosp@m.en.de

Version

Id

class.ilObjLanguageExt.php

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

Member Function Documentation

_deleteValues()

static ilObjLanguageExt::_deleteValues ( string  $a_lang_key, array  $a_values = array()  )

static

Delete a set of translation in the database.

$a_lang_key language key $a_values module.separator.topic => value

Definition at line 494 of file class.ilObjLanguageExt.php.

References $DIC, $ilDB, ilObjLanguage\$key, ilObject\$lng, ilObjLanguage\deleteLangEntry(), and ilObjLanguage\replaceLangModule().

Referenced by ilObjLanguageExtGUI\maintainExecuteObject().

                                                                                       : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();

        if (!is_array($a_values)) {
            return;
        }
        $delete_array = array();

        // save the single translations in lng_data
        foreach ($a_values as $key => $value) {
            $keys = explode($lng->separator, $key);
            if (count($keys) === 2) {
                $module = $keys[0];
                $topic = $keys[1];
                $delete_array[$module][$topic] = $value;

                ilObjLanguage::deleteLangEntry($module, $topic, $a_lang_key);
            }
        }

        // save the serialized module entries in lng_modules
        foreach ($delete_array as $module => $entries) {
            $set = $ilDB->query(sprintf(
                "SELECT * FROM lng_modules " .
                "WHERE lang_key = %s AND module = %s",
                $ilDB->quote($a_lang_key, "text"),
                $ilDB->quote($module, "text")
            ));
            $row = $ilDB->fetchAssoc($set);

            $arr = unserialize($row["lang_array"], ["allowed_classes" => false]);
            if (is_array($arr)) {
                $entries = array_diff_key($arr, $entries);
            }
            ilObjLanguage::replaceLangModule($a_lang_key, $module, $entries);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getModules()

static ilObjLanguageExt::_getModules ( string  $a_lang_key )

static

Get all modules of a language.

$a_lang_key language key Return list of modules

Definition at line 294 of file class.ilObjLanguageExt.php.

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

Referenced by ilLanguageStatisticsTable\getItems(), and ilLanguageExtTableGUI\initFilter().

                                                          : array
    {
        global $DIC;
        $ilDB = $DIC->database();

        $q = "SELECT DISTINCT module FROM lng_data WHERE " .
            " lang_key = " . $ilDB->quote($a_lang_key, "text") . " order by module";
        $set = $ilDB->query($q);

        $modules = array();
        while ($rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $modules[] = $rec["module"];
        }
        return $modules;
    }

Here is the caller graph for this function:

_getRemarks()

static ilObjLanguageExt::_getRemarks ( string  $a_lang_key, bool  $a_all_changed = false  )

static

Get all remarks of a language.

$a_lang_key language key $a_all_changed include empty remarks for local changes Return array module.separator.topic => remarks

Definition at line 318 of file class.ilObjLanguageExt.php.

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

Referenced by ilObjLanguageExtGUI\viewObject().

                                                                                       : array
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();

        $q = "SELECT module, identifier, remarks"
        . " FROM lng_data"
        . " WHERE lang_key = " . $ilDB->quote($a_lang_key, "text");

        if ($a_all_changed) {
            $q .= " AND (remarks IS NOT NULL OR local_change IS NOT NULL)";
        } else {
            $q .= " AND remarks IS NOT NULL";
        }

        $result = $ilDB->query($q);

        $remarks = array();
        while ($row = $ilDB->fetchAssoc($result)) {
            $remarks[$row["module"] . $lng->separator . $row["identifier"]] = $row["remarks"];
        }
        return $remarks;
    }

Here is the caller graph for this function:

_getValues()

static ilObjLanguageExt::_getValues ( string  $a_lang_key, array  $a_modules = array(), array  $a_topics = array(), string  $a_pattern = '', string  $a_state = ''  )

static

Get the translations of specified topics.

$a_lang_key language key $a_modules list of modules $a_topics list of topics $a_pattern search pattern $a_state local change state ('changed', 'unchanged', '') Return array module.separator.topic => value

Definition at line 354 of file class.ilObjLanguageExt.php.

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

Referenced by ilObjLanguageExtGUI\viewObject().

     : array {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();

        $q = "SELECT * FROM lng_data WHERE" .
            " lang_key = " . $ilDB->quote($a_lang_key, "text") . " ";

        if (is_array($a_modules) && count($a_modules) > 0) {
            $q .= " AND " . $ilDB->in("module", $a_modules, false, "text");
        }
        if (is_array($a_topics) && count($a_topics) > 0) {
            $q .= " AND " . $ilDB->in("identifier", $a_topics, false, "text");
        }
        if ($a_pattern) {
            $q .= " AND " . $ilDB->like("value", "text", "%" . $a_pattern . "%");
        }
        if ($a_state === "changed") {
            $q .= " AND NOT local_change IS NULL ";
        }
        if ($a_state === "unchanged") {
            $q .= " AND local_change IS NULL ";
        }
        $q .= " ORDER BY module, identifier";

        $set = $ilDB->query($q);

        $values = array();
        while ($rec = $set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $values[$rec["module"] . $lng->separator . $rec["identifier"]] = $rec["value"];
        }
        return $values;
    }

Here is the caller graph for this function:

_mergeLanguageEntriesFromRow()

static ilObjLanguageExt::_mergeLanguageEntriesFromRow ( ?array  $databaseRow, array  $entries  )

staticprivate

Merge language entries from a database row with existing entries.

$databaseRow associative array representing a row from the database, may be null $entries array of existing language entries to be merged Return array merged array of language entries

Definition at line 473 of file class.ilObjLanguageExt.php.

References null.

                                                                                             : array
    {
        if ($databaseRow === null || !isset($databaseRow["lang_array"])) {
            return $entries;
        }

        $languageEntries = unserialize($databaseRow["lang_array"], ["allowed_classes" => false]);
        if (!is_array($languageEntries)) {
            return $entries;
        }

        return array_merge($languageEntries, $entries);
    }

_saveValues()

static ilObjLanguageExt::_saveValues ( string  $a_lang_key, array  $a_values = array(), array  $a_remarks = array()  )

static

Save a set of translation in the database.

$a_lang_key language key $a_values module.separator.topic => value $a_remarks module.separator.topic => remarks

Definition at line 401 of file class.ilObjLanguageExt.php.

References $DIC, $ilDB, ilObjLanguage\$key, ilObject\$lng, ilLanguageFile\_getGlobalLanguageFile(), ilCachedLanguage\getInstance(), null, ilObjLanguage\replaceLangEntry(), and ilObjLanguage\replaceLangModule().

Referenced by ilObjLanguageExtGUI\saveObject().

                                                                                                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();

        if (!is_array($a_values)) {
            return;
        }
        $save_array = [];
        $save_date = (new DateTime())->format("Y-m-d H:i:s");

        // read and get the global values
        $global_file_obj = ilLanguageFile::_getGlobalLanguageFile($a_lang_key);
        $file_values = $global_file_obj->getAllValues();
        $file_comments = $global_file_obj->getAllComments();
        $db_values = self::_getValues($a_lang_key);
        $db_comments = self::_getRemarks($a_lang_key);
        $global_values = array_merge($db_values, $file_values);
        $global_comments = array_merge($db_comments, $file_comments);

        // save the single translations in lng_data
        foreach ($a_values as $key => $value) {
            $keys = explode($lng->separator, $key);

            if (count($keys) !== 2) {
                continue;
            }

            list($module, $topic) = $keys;
            $save_array[$module][$topic] = $value;

            $are_comments_set = array_key_exists($key, $global_comments) && array_key_exists($key, $a_remarks);
            $are_changes_made = (isset($global_values[$key]) ? $global_values[$key] != $value : true) || (isset($db_values[$key]) ? $db_values[$key] != $value : true);
            if ($are_changes_made || ($are_comments_set ? $global_comments[$key] != $a_remarks[$key] : $are_comments_set)) {
                $local_change = (isset($db_values[$key]) ? $db_values[$key] == $value : true) || (isset($global_values[$key]) ? $global_values[$key] != $value : true) ? $save_date : null;
                ilObjLanguage::replaceLangEntry(
                    $module,
                    $topic,
                    $a_lang_key,
                    $value,
                    $local_change,
                    $a_remarks[$key] ?? null
                );
            }
        }

        // save the serialized module entries in lng_modules
        foreach ($save_array as $module => $entries) {
            $set = $ilDB->query(sprintf(
                "SELECT * FROM lng_modules " .
                "WHERE lang_key = %s AND module = %s",
                $ilDB->quote($a_lang_key, "text"),
                $ilDB->quote($module, "text")
            ));
            $row = $ilDB->fetchAssoc($set);

            $entries = self::_mergeLanguageEntriesFromRow($row, $entries);

            ilObjLanguage::replaceLangModule($a_lang_key, $module, $entries);
        }

        ilCachedLanguage::getInstance($a_lang_key)->flush();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAddedValues()

ilObjLanguageExt::getAddedValues	(	array	$a_modules = array(),
		string	$a_pattern = '',
		array	$a_topics = array()
	)

Get only the entries which don't exist in the global language file.

$a_modules list of modules $a_pattern search pattern $a_topics list of topics Return array module.separator.topic => value

Definition at line 158 of file class.ilObjLanguageExt.php.

References getGlobalLanguageFile().

                                                                                                                 : array
    {
        $global_file_obj = $this->getGlobalLanguageFile();
        $global_values = $global_file_obj->getAllValues();
        $local_values = self::_getValues($this->key, $a_modules, $a_topics, $a_pattern);

        return array_diff_key($local_values, $global_values);
    }

Here is the call graph for this function:

getAllRemarks()

ilObjLanguageExt::getAllRemarks

(

)

Get all remarks from the database.

Return array module.separator.topic => remark

Definition at line 105 of file class.ilObjLanguageExt.php.

                                   : array
    {
        return self::_getRemarks($this->key);
    }

getAllValues()

ilObjLanguageExt::getAllValues	(	array	$a_modules = array(),
		string	$a_pattern = "",
		array	$a_topics = array()
	)

Get all values from the database.

$a_modules list of modules $a_pattern search pattern $a_topics list of topics Return array module.separator.topic => value

Definition at line 118 of file class.ilObjLanguageExt.php.

Referenced by getMergedRemarks().

                                                                                                               : array
    {
        return self::_getValues($this->key, $a_modules, $a_topics, $a_pattern);
    }

Here is the caller graph for this function:

getChangedValues()

ilObjLanguageExt::getChangedValues	(	array	$a_modules = array(),
		string	$a_pattern = "",
		array	$a_topics = array()
	)

Get only the changed values from the database which differ from the original language file.

$a_modules list of modules $a_pattern search pattern $a_topics list of topics Return array module.separator.topic => value

Definition at line 133 of file class.ilObjLanguageExt.php.

Referenced by getMergedRemarks().

                                                                                                                   : array
    {
        return self::_getValues($this->key, $a_modules, $a_topics, $a_pattern, "changed");
    }

Here is the caller graph for this function:

getCommentedValues()

ilObjLanguageExt::getCommentedValues	(	array	$a_modules = array(),
		string	$a_pattern = "",
		array	$a_topics = array()
	)

Get all values from the database for wich the global language file has a comment.

Note: This function checks the comments in the globel lang file, not the remarks in the database!

$a_modules list of modules $a_pattern search pattern $a_topics list of topics Return array module.separator.topic => value

Definition at line 179 of file class.ilObjLanguageExt.php.

References getGlobalLanguageFile().

                                                                                                                     : array
    {
        $global_file_obj = $this->getGlobalLanguageFile();
        $global_comments = $global_file_obj->getAllComments();
        $local_values = self::_getValues($this->key, $a_modules, $a_topics, $a_pattern);

        return array_intersect_key($local_values, $global_comments);
    }

Here is the call graph for this function:

getCustLangPath()

ilObjLanguageExt::getCustLangPath

(

)

Get the customized language files path.

Return path of customized language files folder

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

References ilObjLanguage\$cust_lang_path.

                                     : string
    {
        return $this->cust_lang_path;
    }

getDataPath()

ilObjLanguageExt::getDataPath

(

)

Return the path for language data written by ILIAS.

Definition at line 72 of file class.ilObjLanguageExt.php.

References CLIENT_DATA_DIR, and ilFileUtils\makeDir().

                                 : string
    {
        if (!is_dir(CLIENT_DATA_DIR . "/lang_data")) {
            ilFileUtils::makeDir(CLIENT_DATA_DIR . "/lang_data");
        }
        return CLIENT_DATA_DIR . "/lang_data";
    }

Here is the call graph for this function:

getGlobalLanguageFile()

ilObjLanguageExt::getGlobalLanguageFile

(

)

Read and get the global language file as an object.

Returns

object global language file

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

References ilLanguageFile\_getGlobalLanguageFile().

Referenced by getAddedValues(), getCommentedValues(), getMergedRemarks(), and getMergedValues().

                                           : object
    {
        return ilLanguageFile::_getGlobalLanguageFile($this->key);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLangPath()

ilObjLanguageExt::getLangPath

(

)

Get the language files path.

Return path of language files folder

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

References ilObjLanguage\$lang_path.

                                 : string
    {
        return $this->lang_path;
    }

getLongDescription()

ilObjLanguageExt::getLongDescription

(

)

Get the full language description.

Return description

Definition at line 63 of file class.ilObjLanguageExt.php.

References ILIAS\Repository\lng().

                                        : string
    {
        return $this->lng->txt($this->desc);
    }

Here is the call graph for this function:

getMergedRemarks()

ilObjLanguageExt::getMergedRemarks

(

)

Get the local remarks merged into the remarks of the global language file.

The returned array contains:

1. all remarks that exist globally, with their local values, ordered like in the global language file
2. all additional local remarks, ordered by module and identifier

Return array module.separator.topic => value

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

References $DIC, $ilDB, $ilErr, ilObjLanguage\$key, ilObjLanguage\_deleteLangData(), getAllValues(), getChangedValues(), and getGlobalLanguageFile().

                                      : array
    {
        $global_file_obj = $this->getGlobalLanguageFile();
        $global_comments = $global_file_obj->getAllComments();

        // get remarks including empty remarks for local changes
        $local_remarks = self::_getRemarks($this->key, true);

        return array_merge($global_comments, $local_remarks);
    }

Here is the call graph for this function:

getMergedValues()

ilObjLanguageExt::getMergedValues

(

)

Get the local values merged into the values of the global language file.

The returned array contains:

1. all entries that exist globally, with their local values, ordered like in the global language file
2. all additional local entries, ordered by module and identifier

Return array module.separator.topic => value

Definition at line 200 of file class.ilObjLanguageExt.php.

References getGlobalLanguageFile().

                                     : array
    {
        $global_file_obj = $this->getGlobalLanguageFile();
        $global_values = $global_file_obj->getAllValues();
        $local_values = self::_getValues($this->key);

        return array_merge($global_values, $local_values);
    }

Here is the call graph for this function:

getUnchangedValues()

ilObjLanguageExt::getUnchangedValues	(	array	$a_modules = array(),
		string	$a_pattern = "",
		array	$a_topics = array()
	)

Get only the unchanged values from the database which are equal to the original language file.

Return array module.separator.topic => value

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

                                                                                                                     : array
    {
        return self::_getValues($this->key, $a_modules, $a_topics, $a_pattern, "unchanged");
    }

setLocal()

ilObjLanguageExt::setLocal

(

bool

$a_local = true

)

Set the local status of the language.

$a_local local status (true/false)

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

References ilObjLanguage\isInstalled(), ilObject\setDescription(), and ilObject\update().

                                                  : void
    {
        if ($this->isInstalled()) {
            if ($a_local) {
                $this->setDescription("installed_local");
            } else {
                $this->setDescription("installed");
            }
            $this->update();
        }
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Language/classes/class.ilObjLanguageExt.php