Inheritance diagram for ilObjLanguage:

Collaboration diagram for ilObjLanguage:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=false, ?LanguageFileDirectoryManager $language_file_directory_manager=null)
	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...

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

	insert ()
	insert language data from file into database, customizing included More...

	getModulesWithUnwrittenOverlay ()
	Modules whose PO/MO overlay could not be written or removed by the last operation (the database was written regardless). More...

	removeLocalChanges ()
	Reinstalls the language purely from the global/component files. 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 (bool $shipped_only=false)
	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, int $new_obj_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	getInstalledLanguages ()
	Get the language objects of the installed languages. More...

static	getLangKeysOfInstalledLanguages ()
	Return the language keys of the 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. More...

static	replaceLangModule (string $a_key, string $a_module, array $a_array, bool $refresh_original_from_shipped=false)
	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)

Data Fields
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

string	$absolute_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

Static Private Member Functions
static	writeLangModule (string $a_key, string $a_module, array $a_array, bool $refresh_original_from_shipped)

static	syncMigratedLanguageFile (string $a_key, string $a_module, array $a_array, bool $refresh_original_from_shipped=false)
	Mirrors the complete $a_array into the overlay with "replace" semantics (entries no longer in it are removed). More...

Private Attributes
LanguageFileDirectoryManager	$language_file_directory_manager

InstalledLanguageRepository	$repository

LanguageInstallationManager	$manager

array	$modules_with_unwritten_overlay = []

Additional Inherited Members
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 ilObjLanguage.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjLanguage::__construct	(	int	$a_id = `0`,
		bool	$a_call_by_reference = `false`,
		?LanguageFileDirectoryManager	$language_file_directory_manager = `null`
	)

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

      {
        global $DIC;
        $lng = $DIC->language();
 
        // the first constructor argument is the customizing directory, not a global one
        $this->language_file_directory_manager = $language_file_directory_manager
            ?? ($DIC[LanguageFileDirectoryManager::class] ?? null)
            ?? new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), new MainLanguageFileDirectory());
 
        $this->type = "lng";
        parent::__construct($a_id, $a_call_by_reference);
 
        $this->type = "lng";
        $this->key = $this->title;
        $this->status = $this->desc;
        $this->lang_default = $lng->lang_default;
        $this->lang_user = $lng->lang_user;
        $this->lang_path = $lng->lang_path;
        $this->cust_lang_path = $lng->getCustomLangPath();
        $this->separator = $lng->separator;
        $this->comment_separator = $lng->comment_separator;
        $this->absolute_path = (string) realpath(__DIR__ . "/../../../../");
 
        $this->repository = new InstalledLanguageDatabaseRepository(
            $DIC->database(),
            $this->language_file_directory_manager,
            new FixedInstallationRoot($this->absolute_path)
        );
        $this->manager = new LanguageInstallationManager(
            $DIC->database(),
            $this->language_file_directory_manager,
            $this->absolute_path,
            $this->repository,
            null,
            new TranslationCacheLegacyProxy(),
            fn(): ?string => MigratedLanguageFilePaths::resolveClientDataDir($this->absolute_path)
        );
    }

References ilObject\$desc, $DIC, $language_file_directory_manager, ilObject\$lng, ilObject\$title, ILIAS\GlobalScreen\Provider\__construct(), ilLanguage\getCustomLangPath(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

Member Function Documentation

◆ _deleteLangData()

static ilObjLanguage::_deleteLangData	(	string	$a_lang_key,
		bool	$a_keep_local_change = `false`
	)

static

Delete languge data $a_lang_key lang key.

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

                                                                                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        if (!$a_keep_local_change) {
            $ilDB->manipulate("DELETE FROM lng_data WHERE lang_key = " .
                $ilDB->quote($a_lang_key, "text"));
        } else {
            $ilDB->manipulate("DELETE FROM lng_data WHERE lang_key = " .
                $ilDB->quote($a_lang_key, "text") .
                " AND local_change IS NULL");
        }
    }

References $DIC, and $ilDB.

Referenced by flush().

Here is the caller graph for this function:

◆ _getLastLocalChange()

static ilObjLanguage::_getLastLocalChange ( string $a_key )

static

get the date of the last local change $a_key language key Return change_date "yyyy-mm-dd hh:mm:ss"

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

                                                             : string
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $q = sprintf(
            "SELECT MAX(local_change) last_change FROM lng_data " .
                    "WHERE lang_key = %s AND local_change IS NOT NULL",
            $ilDB->quote($a_key, "text")
        );
        $result = $ilDB->query($q);
 
        $db_last_change = null;
        if (($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) && $row["last_change"] !== null) {
            $db_last_change = (string) $row["last_change"];
        }
 
        // a migrated module's overlay .po can carry a local_change lng_data never sees; the more recent one wins
        $po_last_change = self::_getLastMigratedLocalChange($a_key);
 
        return match (true) {
            $db_last_change === null && $po_last_change === null => "",
            $db_last_change === null => $po_last_change,
            $po_last_change === null => $db_last_change,
            default => max($db_last_change, $po_last_change),
        };
    }

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

Referenced by ilObjLanguageFolderGUI\buildConfirmModal(), ilLanguageFolderTable\getRows(), PoLastLocalChangeTest\testDbValueWinsWhenItIsLaterThanThePoValue(), PoLastLocalChangeTest\testPoValueWinsWhenItIsLaterThanTheDbValue(), PoLastLocalChangeTest\testReturnsEmptyStringWhenNeitherSourceHasAnyLocalChange(), and PoLastLocalChangeTest\testReturnsTheDbValueUnchangedWhenNoMigratedModuleContributesAnything().

Here is the caller graph for this function:

◆ _getLocalChangesByModule()

static ilObjLanguage::_getLocalChangesByModule	(	string	$a_key,
		string	$a_module
	)

static

Get the local changes of a language module.

Reads lng_data only, same caveat as getLocalChanges(). Used by ilPluginLanguage::updateLanguages() to preserve local changes across an update.

$a_key Language key $a_module Module key Return array identifier => value

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

                                                                                    : array
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $changes = array();
        $result = $ilDB->queryF(
            "SELECT identifier, value FROM lng_data WHERE lang_key = %s AND module = %s AND local_change IS NOT NULL",
            array("text", "text"),
            array($a_key, $a_module)
        );
 
        while ($row = $ilDB->fetchAssoc($result)) {
            $changes[$row["identifier"]] = $row["value"];
        }
        return $changes;
    }

References $DIC, and $ilDB.

Referenced by ilPluginLanguage\updateLanguages().

Here is the caller graph for this function:

◆ check()

ilObjLanguage::check ( bool $shipped_only = false )

Validate the logical structure of a lang file.

This function checks if a lang file exists, the file has a header, and each lang-entry consists of exactly three elements (module, identifier, value).

$shipped_only all but the customizing directory (see removeLocalChanges())

Delegates to InstalledLanguageRepository; callers (e.g. ilObjLanguageFolderGUI) turn a false into user feedback.

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

                                                     : bool
    {
        if ($shipped_only && $this->repository instanceof InstalledLanguageDatabaseRepository) {
            return $this->repository->checkShippedLanguage($this->key);
        }
 
        return $this->repository->checkLanguage($this->key);
    }

References ILIAS\UI\examples\Deck\repository().

Referenced by refresh(), and removeLocalChanges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countUsers()

static ilObjLanguage::countUsers ( string $a_lang )

static

Count number of users that use a language.

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

                                                     : int
    {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        $set = $ilDB->query("SELECT COUNT(*) cnt FROM usr_data ud JOIN usr_pref up" .
            " ON ud.usr_id = up.usr_id " .
            " WHERE up.value = " . $ilDB->quote($a_lang, "text") .
            " AND up.keyword = " . $ilDB->quote("language", "text"));
        $rec = $ilDB->fetchAssoc($set);
 
        // add users with no usr_pref set to default language
        if ($a_lang == $lng->lang_default) {
            $set2 = $ilDB->query("SELECT COUNT(*) cnt FROM usr_data ud LEFT JOIN usr_pref up" .
                " ON (ud.usr_id = up.usr_id AND up.keyword = " . $ilDB->quote("language", "text") . ")" .
                " WHERE up.value IS NULL ");
            $rec2 = $ilDB->fetchAssoc($set2);
        }
 
        return (int) $rec["cnt"] + (int) ($rec2["cnt"] ?? 0);
    }

References $DIC, $ilDB, $lng, and ILIAS\Repository\int().

Referenced by ilLanguageFolderTable\getRows(), and ILIAS\Dashboard\DataRetrieval\Language\getRows().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cut_header()

static ilObjLanguage::cut_header ( array $content )

static

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

if found it returns the plain language information, otherwise returns false

$content expecting an ILIAS lang-file Return content without header info OR false if no valid header was found

Returns: bool|array

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

    {
        foreach ($content as $key => $val) {
            if (trim($val) === "<!-- language file start -->") {
                return array_slice($content, $key + 1);
            }
        }
 
        return false;
    }

Referenced by ilObjLanguageFolder\checkAllLanguages().

Here is the caller graph for this function:

◆ deleteLangEntry()

static ilObjLanguage::deleteLangEntry	(	string	$a_module,
		string	$a_identifier,
		string	$a_lang_key
	)

staticfinal

Delete lang entry.

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

                                                                                                            : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(sprintf(
            "DELETE FROM lng_data " .
            "WHERE module = %s AND identifier = %s AND lang_key = %s ",
            $ilDB->quote($a_module, "text"),
            $ilDB->quote($a_identifier, "text"),
            $ilDB->quote($a_lang_key, "text")
        ));
 
        return true;
    }

References $DIC, and $ilDB.

Referenced by ilObjLanguageExt\_deleteValues().

Here is the caller graph for this function:

◆ flush()

ilObjLanguage::flush ( string $a_mode = "all" )

remove language data from database $a_mode "all" or "keep_local"

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

                                                 : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        self::_deleteLangData($this->key, ($a_mode === "keep_local"));
 
        if ($a_mode === "all") {
            $ilDB->manipulate("DELETE FROM lng_modules WHERE lang_key = " .
                $ilDB->quote($this->key, "text"));
        }
    }

References $DIC, $ilDB, and _deleteLangData().

Referenced by refresh(), removeLocalChanges(), and uninstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstalledLanguages()

static ilObjLanguage::getInstalledLanguages ( )

static

Get the language objects of the installed languages.

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

                                                  : array
    {
        $objects = array();
        $languages = ilObject::_getObjectsByType("lng");
        foreach ($languages as $lang) {
            $langObj = new ilObjLanguage((int) $lang["obj_id"], false);
            if ($langObj->isInstalled()) {
                $objects[] = $langObj;
            } else {
                unset($langObj);
            }
        }
        return $objects;
    }

References ilObject\_getObjectsByType().

Here is the call graph for this function:

◆ getKey()

ilObjLanguage::getKey ( )

get language key

Return language key

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

                            : string
    {
        return $this->key;
    }

References $key.

Referenced by refresh(), and removeLocalChanges().

Here is the caller graph for this function:

◆ getLangKeysOfInstalledLanguages()

static ilObjLanguage::getLangKeysOfInstalledLanguages ( )

static

Return the language keys of the installed languages.

Matches only "installed", not "installed_local" (unlike ilLanguage::_getInstalledLanguages()); this affects ilPluginLanguage's language selection.

Returns: array

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

                                                            : array
    {
        $lang_keys = [];
        foreach (ilObject::_getObjectsByType("lng") as $lang) {
            if ($lang['desc'] === 'installed') {
                $lang_keys[] = $lang['title'];
            }
        }
        return $lang_keys;
    }

References ilObject\_getObjectsByType().

Referenced by ilPluginLanguage\updateLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalChanges()

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

get locally changed language entries

Reads lng_data only, not merged with the overlay (unlike _getLastLocalChange()): correct only while lng_data is dual-written for migrated modules (see replaceLangModule()).

$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

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

                                                                                     : array
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        if ($a_min_date === "") {
            $a_min_date = "1980-01-01 00:00:00";
        }
        if ($a_max_date === "") {
            $a_max_date = "2200-01-01 00:00:00";
        }
 
        $q = sprintf(
            "SELECT module, identifier, value FROM lng_data WHERE lang_key = %s " .
            "AND local_change >= %s AND local_change <= %s",
            $ilDB->quote($this->key, "text"),
            $ilDB->quote($a_min_date, "timestamp"),
            $ilDB->quote($a_max_date, "timestamp")
        );
        $result = $ilDB->query($q);
 
        $changes = array();
        while ($row = $result->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $changes[$row["module"]][$row["identifier"]] = $row["value"];
        }
        return $changes;
    }

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

◆ getModulesWithUnwrittenOverlay()

ilObjLanguage::getModulesWithUnwrittenOverlay ( )

Modules whose PO/MO overlay could not be written or removed by the last operation (the database was written regardless).

Returns: list<string>

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

                                                    : array
    {
        return $this->modules_with_unwritten_overlay;
    }

References $modules_with_unwritten_overlay.

◆ getStatus()

ilObjLanguage::getStatus ( )

get language status

Return language status

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

                               : string
    {
        return $this->status;
    }

References $status.

Referenced by isInstalled(), and refresh().

Here is the caller graph for this function:

◆ insert()

ilObjLanguage::insert ( )

insert language data from file into database, customizing included

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

                            : void
    {
        $this->modules_with_unwritten_overlay = $this->manager->insertLanguageForInstallation($this->key);
    }

Referenced by refresh().

Here is the caller graph for this function:

◆ isInstalled()

ilObjLanguage::isInstalled ( )

Check language object status, and return true if language is installed.

Return true if installed

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

                                 : bool
    {
        if (str_starts_with($this->getStatus(), "installed")) {
            return true;
        } else {
            return false;
        }
    }

References getStatus().

Referenced by refresh(), removeLocalChanges(), and ilObjLanguageExt\setLocal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSystemLanguage()

ilObjLanguage::isSystemLanguage ( )

check if language is system language

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

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

◆ isUserLanguage()

ilObjLanguage::isUserLanguage ( )

check if language is system language

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

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

◆ optimizeData()

ilObjLanguage::optimizeData ( )

optimizes the db-table langdata

Return true on success

Deprecated:

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

                                  : bool
    {
        // Mantis #22313: removed table optimization
        return true;
    }

◆ refresh()

ilObjLanguage::refresh ( )

refresh current language

A single insert() covers global and local/customizing content.

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

                             : bool
    {
        if ($this->isInstalled() && $this->check()) {
            $this->flush("keep_local");
            $this->insert();
            $this->setTitle($this->getKey());
            $this->setDescription($this->getStatus());
            $this->update();
 
            return true;
        }
 
        return false;
    }

References check(), flush(), getKey(), getStatus(), insert(), isInstalled(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().

Here is the call graph for this function:

◆ refreshPlugins()

static ilObjLanguage::refreshPlugins ( ?array $a_lang_keys = null )

static

Refresh languages of activated plugins $a_lang_keys keys of languages to be refreshed (not yet supported, all available will be refreshed)

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

                                                                     : void
    {
        global $DIC;
 
        $component_repository = $DIC["component.repository"];
        foreach ($component_repository->getPlugins() as $plugin) {
            if (!$plugin->isActive()) {
                continue;
            }
            $handler = new ilPluginLanguage($plugin);
            $handler->updateLanguages($a_lang_keys);
        }
    }

References $DIC, $handler, and XapiProxy\$plugin.

Referenced by ILIAS\Language\Activities\RepositoryProvider\refreshPlugins().

Here is the caller graph for this function:

◆ removeLocalChanges()

ilObjLanguage::removeLocalChanges ( )

Reinstalls the language purely from the global/component files.

Must not use insert(): that merges the customizing directory back in and would reinstate what this method removes.

Return true if the language was installed and could be reinstalled

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

                                        : bool
    {
        // The customizing file is not applied here - an invalid one must not block the reset
        if (!$this->isInstalled() || !$this->check(true)) {
            return false;
        }
 
        $this->flush("all");
        $this->modules_with_unwritten_overlay = $this->manager->insertLanguageForRemovingLocalChanges($this->key);
        $this->setTitle($this->getKey());
        $this->setDescription("installed");
        $this->update();
 
        return true;
    }

References check(), flush(), getKey(), isInstalled(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().

Here is the call graph for this function:

◆ replaceLangEntry()

static ilObjLanguage::replaceLangEntry	(	string	$a_module,
		string	$a_identifier,
		string	$a_lang_key,
		string	$a_value,
		?string	$a_local_change = `null`,
		?string	$a_remarks = `null`
	)

staticfinal

Replace lang entry.

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

     : bool {
        global $DIC;
        $ilDB = $DIC->database();
 
        // avoid a cache flush here (see mantis #28818)
        // ilGlobalCache::flushAll();
 
        if (is_string($a_remarks) && $a_remarks !== '') {
            $a_remarks = mb_substr($a_remarks, 0, 250);
        }
 
        if ($a_remarks === '') {
            $a_remarks = null;
        }
 
        if ($a_value === "") {
            $a_value = null;
        } else {
            $a_value = substr($a_value, 0, 4000);
        }
 
        $ilDB->replace(
            "lng_data",
            array(
                "module" => array("text",$a_module),
                "identifier" => array("text",$a_identifier),
                "lang_key" => array("text",$a_lang_key)
                ),
            array(
                "value" => array("text",$a_value),
                "local_change" => array("timestamp",$a_local_change),
                "remarks" => array("text", $a_remarks)
            )
        );
        return true;
    }

Referenced by ilPluginLanguage\updateLanguages().

Here is the caller graph for this function:

◆ replaceLangModule()

static ilObjLanguage::replaceLangModule	(	string	$a_key,
		string	$a_module,
		array	$a_array,
		bool	$refresh_original_from_shipped = `false`
	)

staticfinal

Replace language module array.

Central write path for module data (admin GUI edits, local-change delete, plugin update): rewrites the lng_modules row and dual-writes the same content into the overlay of a migrated module (see syncMigratedLanguageFile()). lng_data/lng_modules stay the rollback-safe source of truth while the PO/MO pilot runs.

Final: the signature only carries identifier => value, no per-entry reason text (unlike replaceLangEntry()'s $a_remarks); do not widen it.

Parameters

bool $refresh_original_from_shipped forwarded to MigratedLanguageFileSync::sync(); true only where $a_array reflects the current SHIPPED content (module reset, plugin language file re-applied)

Returns: bool false if the database was written but the overlay of a module maintained in PO files could not be

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

     : bool {
        global $DIC;
 
        // DB write and overlay sync form one unit under the lock, also against a caller's read of the current content (see ilObjLanguageExt::_saveValues())
        return MigratedLanguageFileSync::withOverlayLock(
            $DIC->offsetExists(LanguageFileDirectoryManager::class) ? $DIC[LanguageFileDirectoryManager::class] : null,
            $a_key,
            $a_module,
            MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH),
            static fn(): bool => self::writeLangModule($a_key, $a_module, $a_array, $refresh_original_from_shipped),
            ILIAS_ABSOLUTE_PATH
        );
    }

Here is the caller graph for this function:

◆ resetUserLanguage()

ilObjLanguage::resetUserLanguage ( string $lang_key )

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

A message is sent to all affected users

$lang_key international language key (2 digits)

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

                                                       : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $query = "UPDATE usr_pref SET " .
                "value = " . $ilDB->quote($this->lang_default, "text") . " " .
                "WHERE keyword = " . $ilDB->quote('language', "text") . " " .
                "AND value = " . $ilDB->quote($lang_key, "text");
        $ilDB->manipulate($query);
    }

References $DIC, and $ilDB.

Referenced by uninstall().

Here is the caller graph for this function:

◆ syncMigratedLanguageFile()

static ilObjLanguage::syncMigratedLanguageFile	(	string	$a_key,
		string	$a_module,
		array	$a_array,
		bool	$refresh_original_from_shipped = `false`
	)

staticprivate

Mirrors the complete $a_array into the overlay with "replace" semantics (entries no longer in it are removed).

No-op for a module that is not migrated for $a_key. Failures are logged and signalled by false, not thrown: the DB write already succeeded and must not be undone (e.g. data directory not writable).

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

     : bool {
        global $DIC;
 
        if (!$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return true;
        }
 
        try {
            MigratedLanguageFileSync::sync(
                $DIC[LanguageFileDirectoryManager::class],
                ILIAS_ABSOLUTE_PATH,
                $a_key,
                $a_module,
                $a_array,
                MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH),
                $refresh_original_from_shipped
            );
        } catch (\Throwable $t) {
            $DIC->logger()->forComponent('lang')->warning(sprintf(
                'Could not sync migrated language file for module "%s", language "%s": %s',
                $a_module,
                $a_key,
                $t->getMessage()
            ));
            return false;
        }
 
        return true;
    }

◆ uninstall()

ilObjLanguage::uninstall ( )

uninstall current language

Return uninstalled language key

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

                               : string
    {
        if ((str_starts_with($this->status, "installed")) && ($this->key != $this->lang_default) && ($this->key != $this->lang_user)) {
            $this->flush();
            $this->modules_with_unwritten_overlay = self::removeMigratedMoFiles($this->key);
            $this->setTitle($this->key);
            $this->setDescription("not_installed");
            $this->update();
            $this->resetUserLanguage($this->key);
 
            return $this->key;
        }
        return "";
    }

References $key, flush(), resetUserLanguage(), ilObject\setDescription(), ilObject\setTitle(), and ilObject\update().

Here is the call graph for this function:

◆ updateLangEntry()

static ilObjLanguage::updateLangEntry	(	string	$a_module,
		string	$a_identifier,
		string	$a_lang_key,
		string	$a_value,
		?string	$a_local_change = `null`,
		?string	$a_remarks = `null`
	)

staticfinal

Replace lang entry.

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

     : void {
        global $DIC;
        $ilDB = $DIC->database();
 
        if (is_string($a_remarks) && $a_remarks !== '') {
            $a_remarks = mb_substr($a_remarks, 0, 250);
        }
 
        if ($a_remarks === '') {
            $a_remarks = null;
        }
 
        if ($a_value === "") {
            $a_value = null;
        } else {
            $a_value = substr($a_value, 0, 4000);
        }
 
        $ilDB->manipulate(sprintf(
            "UPDATE lng_data " .
            "SET value = %s, local_change = %s, remarks = %s " .
            "WHERE module = %s AND identifier = %s AND lang_key = %s ",
            $ilDB->quote($a_value, "text"),
            $ilDB->quote($a_local_change, "timestamp"),
            $ilDB->quote($a_remarks, "text"),
            $ilDB->quote($a_module, "text"),
            $ilDB->quote($a_identifier, "text"),
            $ilDB->quote($a_lang_key, "text")
        ));
    }

◆ writeLangModule()

static ilObjLanguage::writeLangModule	(	string	$a_key,
		string	$a_module,
		array	$a_array,
		bool	$refresh_original_from_shipped
	)

staticprivate

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

     : bool {
        global $DIC;
        $ilDB = $DIC->database();
 
        // avoid flushing the whole cache (see mantis #28818)
        ilCachedLanguage::getInstance($a_key)->deleteInCache();
 
        $ilDB->manipulate(sprintf(
            "DELETE FROM lng_modules WHERE lang_key = %s AND module = %s",
            $ilDB->quote($a_key, "text"),
            $ilDB->quote($a_module, "text")
        ));
 
        /*$ilDB->manipulate(sprintf("INSERT INTO lng_modules (lang_key, module, lang_array) VALUES ".
            "(%s,%s,%s)", $ilDB->quote($a_key, "text"),
            $ilDB->quote($a_module, "text"),
            $ilDB->quote(serialize($a_array), "clob")));*/
        // a migrated module's shipped values as the build serves them; $a_array stays unprocessed for the overlay sync
        $db_array = $DIC->offsetExists(LanguageFileDirectoryManager::class)
            ? MigratedLanguageFileSync::databaseValuesOf(
                $DIC[LanguageFileDirectoryManager::class],
                ILIAS_ABSOLUTE_PATH,
                $a_key,
                $a_module,
                $a_array
            )
            : $a_array;
        $ilDB->insert("lng_modules", array(
            "lang_key" => array("text", $a_key),
            "module" => array("text", $a_module),
            "lang_array" => array("clob", serialize($db_array))
            ));
 
        // check if the module is correctly saved
        // see mantis #20046 and #19140
        $result = $ilDB->queryF(
            "SELECT lang_array FROM lng_modules WHERE lang_key = %s AND module = %s",
            array("text","text"),
            array($a_key, $a_module)
        );
        $row = $ilDB->fetchAssoc($result);
 
        $unserialied = unserialize($row["lang_array"], ["allowed_classes" => false]);
        if (!is_array($unserialied)) {
            $escape = $DIC->refinery()->encode()->htmlSpecialCharsAsEntities();
            $DIC->ui()->mainTemplate()->setOnScreenMessage(
                'failure',
                "Data for module '" . $escape->transform($a_module) . "' of  language '" . $escape->transform($a_key) . "' is not correctly saved. " .
                "Please check the collation of your database tables lng_data and lng_modules. It must be utf8_unicode_ci.",
                true
            );
            // redirectByClass() exits inside the overlay lock callback: the flock() is released at request end, acceptable here
            $DIC->ctrl()->redirectByClass(ilobjlanguagefoldergui::class, 'view');
        }
 
        return self::syncMigratedLanguageFile($a_key, $a_module, $a_array, $refresh_original_from_shipped);
    }

Field Documentation

◆ $absolute_path

string ilObjLanguage::$absolute_path

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

◆ $comment_separator

string ilObjLanguage::$comment_separator

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

◆ $cust_lang_path

string ilObjLanguage::$cust_lang_path

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

Referenced by ilObjLanguageExt\getCustLangPath().

◆ $key

string ilObjLanguage::$key

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

Referenced by ilObjLanguageExt\getEffectiveRemarks(), getKey(), ilObjLanguageExt\mergeLocalChangesIntoShippedPoFiles(), uninstall(), and ilObjLanguageExt\withFuzzyMarkers().

◆ $lang_default

string ilObjLanguage::$lang_default

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

◆ $lang_path

string ilObjLanguage::$lang_path

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

Referenced by ilObjLanguageExt\getLangPath().

◆ $lang_user

string ilObjLanguage::$lang_user

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

◆ $language_file_directory_manager

LanguageFileDirectoryManager ilObjLanguage::$language_file_directory_manager

private

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

Referenced by __construct().

◆ $manager

LanguageInstallationManager ilObjLanguage::$manager

private

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

◆ $modules_with_unwritten_overlay

array ilObjLanguage::$modules_with_unwritten_overlay = []

private

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

Referenced by getModulesWithUnwrittenOverlay().

◆ $repository

InstalledLanguageRepository ilObjLanguage::$repository

private

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

◆ $separator

string ilObjLanguage::$separator

separator of module, comment separator, identifier & values in language files

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

◆ $status

string ilObjLanguage::$status

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

Referenced by getStatus().

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

components/ILIAS/Language/classes/class.ilObjLanguage.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteLangData()

◆ _getLastLocalChange()

◆ _getLocalChangesByModule()

◆ check()

◆ countUsers()

◆ cut_header()

◆ deleteLangEntry()

◆ flush()

◆ getInstalledLanguages()

◆ getKey()

◆ getLangKeysOfInstalledLanguages()

◆ getLocalChanges()

◆ getModulesWithUnwrittenOverlay()

◆ getStatus()

◆ insert()

◆ isInstalled()

◆ isSystemLanguage()

◆ isUserLanguage()

◆ optimizeData()

◆ refresh()

◆ refreshPlugins()

◆ removeLocalChanges()

◆ replaceLangEntry()

◆ replaceLangModule()

◆ resetUserLanguage()

◆ syncMigratedLanguageFile()

◆ uninstall()

◆ updateLangEntry()

◆ writeLangModule()

Field Documentation

◆ $absolute_path

◆ $comment_separator

◆ $cust_lang_path

◆ $key

◆ $lang_default

◆ $lang_path

◆ $lang_user

◆ $language_file_directory_manager

◆ $manager

◆ $modules_with_unwritten_overlay

◆ $repository

◆ $separator

◆ $status