Inheritance diagram for ilObjLanguageExt:

Collaboration diagram for ilObjLanguageExt:

Public Member Functions
	ilObjLanguageExt ($a_id=0, $a_call_by_reference=false)
	Constructor. More...

	getGlobalLanguageFile ()
	Read and get the global language file as an object. More...

	setLocal ($a_local=true)
	Set the local status of the language. More...

	getLongDescription ()
	Get the full language description. 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 ($a_modules=array(), $a_pattern='')
	Get all values from the database. More...

	getChangedValues ($a_modules=array(), $a_pattern='')
	Get only the changed values from the database which differ from the original language file. More...

	getUnchangedValues ($a_modules=array(), $a_pattern='')
	Get only the unchanged values from the database which are equal to the original language file. More...

	getAddedValues ($a_modules=array(), $a_pattern='')
	Get only the entries which don't exist in the global language file. More...

	getCommentedValues ($a_modules=array(), $a_pattern='')
	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...

	importLanguageFile ($a_file, $a_mode_existing='keepnew')
	Import a language file into the ilias database. More...

Public Member Functions inherited from ilObjLanguage
	ilObjLanguage ($a_id=0, $a_call_by_reference=false)
	Constructor. More...

	getKey ()
	get language key More...

	getStatus ()
	get language status More...

	isSystemLanguage ()
	check if language is system language More...

	isUserLanguage ()
	check if language is system language More...

	isInstalled ()
	Check language object status, and return true if language is installed. More...

	isLocal ()
	Check language object status, and return true if a local language file is installed. More...

	install ($scope='')
	install current language More...

	uninstall ()
	uninstall current language More...

	refresh ()
	refresh current language More...

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

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

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

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

	resetUserLanguage ($lang_key)
	search ILIAS for users which have selected '$lang_key' as their prefered language and reset them to default language (english). More...

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

	optimizeData ()
	optimizes the db-table langdata More...

	check ($scope='')
	Validate the logical structure of a lang file. More...

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

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

	read ($a_force_db=false)
	read object data from db into object More...

	getId ()
	get object id @access public More...

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

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

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

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

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

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access 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...

	getOwner ()
	get object owner More...

	getOwnerName ()

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

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

	getCreateDate ()
	get create date @access public More...

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

	getDiskUsage ()

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

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

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

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

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

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

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

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

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

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

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

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

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

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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...

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

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

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

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

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

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

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_getModules ($a_lang_key)
	Get all modules of a language. More...

static	_getRemarks ($a_lang_key, $a_all_changed=false)
	Get all remarks of a language. More...

static	_getValues ($a_lang_key, $a_modules=array(), $a_topics=array(), $a_pattern='', $a_state='')
	Get the translations of specified topics. More...

static	_saveValues ($a_lang_key, $a_values=array(), $a_remarks=array())
	Save a set of translation in the database. More...

static	_deleteValues ($a_lang_key, $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 ($a_lang_keys=null)

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

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

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

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

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

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

static	_lookupImportId ($a_obj_id)

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

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

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

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

static	_lookupObjId ($a_id)

static	setDeletedDates ($a_ref_ids)
	Set deleted date @global type $ilDB. More...

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

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

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public 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	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. 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	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Additional Inherited Members
Data Fields inherited from ilObjLanguage
	$separator

	$comment_separator

	$lang_default

	$lang_user

	$lang_path

	$key

	$status

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

const	DESC_LENGTH = 128

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

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

Member Function Documentation

◆ _deleteValues()

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

static

Delete a set of translation in the database.

@access static

Parameters

string	language key
array	module.separator.topic => value

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

        {
                global $ilDB, $lng;
 
                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"]);
                        if (is_array($arr))
                        {
                                $entries = array_diff_key($arr, $entries);
                        }
                        ilObjLanguage::replaceLangModule($a_lang_key, $module, $entries);
                }
        }

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

Referenced by ilObjLanguageExtGUI\maintainExecuteObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getModules()

static ilObjLanguageExt::_getModules ( $a_lang_key )

static

Get all modules of a language.

@access static

Parameters

string language key

Returns: array list of modules

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

        {
                global $ilDB;
                
                $q = "SELECT DISTINCT module FROM lng_data WHERE ".
                        " lang_key = ".$ilDB->quote($a_lang_key, "text")." order by module";
                $set = $ilDB->query($q);
 
                while ($rec = $set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $modules[] = $rec["module"];
                }
                return $modules;
        }

References $ilDB, and DB_FETCHMODE_ASSOC.

Referenced by ilLanguageExtTableGUI\initFilter(), and ilObjLanguageExtGUI\statisticsObject().

Here is the caller graph for this function:

◆ _getRemarks()

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

static

Get all remarks of a language.

@access static

Parameters

string	language key
boolean	include empty remarks for local changes

Returns: array module.separator.topic => remarks

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

        {
            global $ilDB, $lng;
 
            $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;
        }

References $ilDB, ilObject\$lng, $result, and $row.

Referenced by getAllRemarks(), getMergedRemarks(), and ilObjLanguageExtGUI\viewObject().

Here is the caller graph for this function:

◆ _getValues()

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

static

Get the translations of specified topics.

@access static

Parameters

string	language key
array	list of modules
array	list of topics
array	search pattern
string	local change state ('changed', 'unchanged', '')

Returns: array module.separator.topic => value

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

        {
                global $ilDB, $lng;
 
                $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(DB_FETCHMODE_ASSOC))
                {
                        $values[$rec["module"].$lng->separator.$rec["identifier"]] = $rec["value"];
                }
                return $values;
        }

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

Referenced by getAddedValues(), getAllValues(), getChangedValues(), getCommentedValues(), getMergedValues(), getUnchangedValues(), and ilObjLanguageExtGUI\viewObject().

Here is the caller graph for this function:

◆ _saveValues()

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

static

Save a set of translation in the database.

@access static

Parameters

string	language key
array	module.separator.topic => value
array	module.separator.topic => remarks

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

        {
                global $ilDB, $lng;
                
                if (!is_array($a_values))
                {
                        return;
                }
                $save_array = array();
                $save_date = date("Y-m-d H:i:s", time());
                
                // read and get the global values
                require_once "./Services/Language/classes/class.ilLanguageFile.php";
                $global_file_obj = ilLanguageFile::_getGlobalLanguageFile($a_lang_key);
                $global_values = $global_file_obj->getAllValues();
                $global_comments = $global_file_obj->getAllComments();
 
                // 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];
                                $save_array[$module][$topic] = $value;
 
                if ($global_values[$key] != $value
                                or  $global_comments[$key] != $a_remarks[$key])
                                {
                                        $local_change = $save_date;
                                }
                                else
                                {
                        $local_change = null;
                    }
 
                                ilObjLanguage::replaceLangEntry($module, $topic,
                                        $a_lang_key, $value, $local_change, $a_remarks[$key]);
                        }
                }
 
                // 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);
                        
                        $arr = unserialize($row["lang_array"]);
                        if (is_array($arr))
                        {
                                $entries = array_merge($arr, $entries);
                        }
                        ilObjLanguage::replaceLangModule($a_lang_key, $module, $entries);
                }
 
 
                require_once('class.ilCachedLanguage.php');
                ilCachedLanguage::getInstance($a_lang_key)->flush();
        }

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

Referenced by importLanguageFile(), and ilObjLanguageExtGUI\saveObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAddedValues()

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

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

Parameters

array	list of modules
array	search pattern

Returns: array module.separator.topic => value

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

        {
                $global_file_obj = $this->getGlobalLanguageFile();
                $global_values = $global_file_obj->getAllValues();
                $local_values = self::_getValues($this->key, $a_modules, NULL, $a_pattern);
 
                return array_diff_key($local_values, $global_values);
        }

References _getValues(), and getGlobalLanguageFile().

Here is the call graph for this function:

◆ getAllRemarks()

ilObjLanguageExt::getAllRemarks ( )

Get all remarks from the database.

Returns: array module.separator.topic => remark

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

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

References _getRemarks().

Here is the call graph for this function:

◆ getAllValues()

ilObjLanguageExt::getAllValues	(	$a_modules = `array()`,
		$a_pattern = `''`
	)

Get all values from the database.

Parameters

array	list of modules
string	search pattern

Returns: array module.separator.topic => value

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

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

References _getValues().

Referenced by importLanguageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChangedValues()

ilObjLanguageExt::getChangedValues	(	$a_modules = `array()`,
		$a_pattern = `''`
	)

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

Parameters

array	list of modules
string	search pattern

Returns: array module.separator.topic => value

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

        {
                return self::_getValues($this->key, $a_modules, NULL, $a_pattern, 'changed');
        }

References _getValues().

Referenced by importLanguageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCommentedValues()

ilObjLanguageExt::getCommentedValues	(	$a_modules = `array()`,
		$a_pattern = `''`
	)

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!

Parameters

array	list of modules
array	search pattern

Returns: array module.separator.topic => value

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

        {
                $global_file_obj = $this->getGlobalLanguageFile();
                $global_comments = $global_file_obj->getAllComments();
                $local_values = self::_getValues($this->key, $a_modules, NULL, $a_pattern);
 
                return array_intersect_key($local_values, $global_comments);
        }

References _getValues(), and getGlobalLanguageFile().

Here is the call graph for this function:

◆ getCustLangPath()

ilObjLanguageExt::getCustLangPath ( )

Get the customized language files path.

Returns: string path of customized language files folder

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

        {
                return $this->cust_lang_path;
        }

◆ getGlobalLanguageFile()

ilObjLanguageExt::getGlobalLanguageFile ( )

Read and get the global language file as an object.

Returns: object global language file

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

        {
                require_once "./Services/Language/classes/class.ilLanguageFile.php";
                return ilLanguageFile::_getGlobalLanguageFile($this->key);
        }

References ilLanguageFile\_getGlobalLanguageFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLangPath()

ilObjLanguageExt::getLangPath ( )

Get the language files path.

Returns: string path of language files folder

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

        {
                return $this->lang_path;
        }

References ilObjLanguage\$lang_path.

◆ getLongDescription()

ilObjLanguageExt::getLongDescription ( )

Get the full language description.

Returns: string description

Reimplemented from ilObject.

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

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

◆ getMergedRemarks()

ilObjLanguageExt::getMergedRemarks ( )

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

The returned array contains:

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

Returns: array module.separator.topic => value

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

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

References _getRemarks(), and getGlobalLanguageFile().

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:

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

Returns: array module.separator.topic => value

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

        {
 
                $global_file_obj = $this->getGlobalLanguageFile();
                $global_values = $global_file_obj->getAllValues();
                $local_values = self::_getValues($this->key);
 
                return array_merge($global_values, $local_values);
        }

References _getValues(), and getGlobalLanguageFile().

Here is the call graph for this function:

◆ getUnchangedValues()

ilObjLanguageExt::getUnchangedValues	(	$a_modules = `array()`,
		$a_pattern = `''`
	)

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

Parameters

array	list of modules
array	search pattern

Returns: array module.separator.topic => value

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

        {
                return self::_getValues($this->key, $a_modules, NULL, $a_pattern, 'unchanged');
        }

References _getValues().

Here is the call graph for this function:

◆ ilObjLanguageExt()

ilObjLanguageExt::ilObjLanguageExt	(	$a_id = `0`,
		$a_call_by_reference = `false`
	)

Constructor.

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

        {
                $this->ilObjLanguage($a_id, $a_call_by_reference);
        }

References ilObjLanguage\ilObjLanguage().

Here is the call graph for this function:

◆ importLanguageFile()

ilObjLanguageExt::importLanguageFile	(	$a_file,
		$a_mode_existing = `'keepnew'`
	)

Import a language file into the ilias database.

Parameters

string handling of existing values ('keepall','keepnew','replace','delete')

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

        {
                global $ilDB, $ilErr;
 
                // read the new language file
                require_once "./Services/Language/classes/class.ilLanguageFile.php";
                $import_file_obj = new ilLanguageFile($a_file);
                if (!$import_file_obj->read())
                {
                        $ilErr->raiseError($import_file_obj->getErrorMessage(),$ilErr->MESSAGE);
                }
 
                switch($a_mode_existing)
                {
                        // keep all existing entries
                        case 'keepall':
                                $to_keep = $this->getAllValues();
                                break;
 
                        // keep existing online changes
                        case 'keepnew':
                                $to_keep = $this->getChangedValues();
                                break;
 
                        // replace all existing definitions
                        case 'replace':
                            $to_keep = array();
                            break;
 
           // delete all existing entries
                        case 'delete':
                                ilObjLanguage::_deleteLangData($this->key, false);
                                $ilDB->manipulate("DELETE FROM lng_modules WHERE lang_key = ".
                                        $ilDB->quote($this->key, "text"));
                                $to_keep = array();
                                break;
                                
                        default:
                            return;
                }
                
                // process the values of the import file
                $to_save = array();
                foreach ($import_file_obj->getAllValues() as $key => $value)
                {
                        if (!isset($to_keep[$key]))
                        {
                                $to_save[$key] = $value;
                        }
                }
                self::_saveValues($this->key, $to_save, $import_file_obj->getAllComments());
        }

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

Here is the call graph for this function:

◆ setLocal()

ilObjLanguageExt::setLocal ( $a_local = true )

Set the local status of the language.

Parameters

boolean local status (true/false)

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

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

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

Here is the call graph for this function:

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

Services/Language/classes/class.ilObjLanguageExt.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _deleteValues()

◆ _getModules()

◆ _getRemarks()

◆ _getValues()

◆ _saveValues()

◆ getAddedValues()

◆ getAllRemarks()

◆ getAllValues()

◆ getChangedValues()

◆ getCommentedValues()

◆ getCustLangPath()

◆ getGlobalLanguageFile()

◆ getLangPath()

◆ getLongDescription()

◆ getMergedRemarks()

◆ getMergedValues()

◆ getUnchangedValues()

◆ ilObjLanguageExt()

◆ importLanguageFile()

◆ setLocal()