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

	getEffectiveRemarks ()
	The remark as the admin table shows it: the local remark, else the note of the shipped .po (`#`, else `#.` More...

	getAllValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get all values from the database; a migrated module is read from its shipped .po with the overlay delta on top (see _getValues()). More...

	getChangedValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get only the changed values (source as in getAllValues()) 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 (source as in getAllValues()) 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 shipped language files (see getShippedValues()) - source as in getAllValues() More...

	getCommentedValues (array $a_modules=array(), string $a_pattern="", array $a_topics=array())
	Get all values for which the shipped language files have a comment (see getShippedComments()) - source as in getAllValues() More...

	getMergedValues ()
	Get the local values merged into the shipped values (see getShippedValues()), source as in getAllValues() More...

	getMergedRemarks ()
	Get the local remarks merged into the comments of the shipped language files (see getShippedComments()) More...

	getShippedValues ()
	The global language file, except for modules maintained in PO files: their shipped .po is used (see LanguageInstallationManager). More...

	getShippedComments ()
	Counterpart of getShippedValues(): modules maintained in PO files contribute the comments of their shipped .po. More...

	getShippedCommentsForDisplay ()
	For display only (admin GUI): adds the "not translated yet" marker for fuzzy entries (see withFuzzyMarkers()). More...

	getModulesMaintainedInPoFiles ()
	Every module maintained in PO files for this language (its shipped .po exists). More...

	getUnreadableShippedPoModules ()
	The modules maintained in PO files whose shipped .po cannot be read - see getShippedValues(). More...

	mergeLocalChangesIntoGlobalLanguageFile (bool $write_global_file=true)
	The "merge" maintenance action of the developer mode (LANGMODE): More...

	hasLocalChangesOutsidePoModules ()
	Whether "merge" has something to write into the global language file: a local change (a changed remark sets local_change as well, see _saveValues()) of a module outside the PO files. More...

	backupShippedPoFiles (string $directory)
	The backup the filter "conflicts" compares with (see getShippedChangesSinceBackup()), written by the "save_dist" action next to the backup of the global language file. More...

	getShippedChangesSinceBackup (ilLanguageFile $former_file, string $po_backup_directory)
	Entries of the global language file (without modules maintained in PO files) and of their shipped .po that differ from the backup; a module without backup contributes nothing. More...

	getSkippedInvalidMarkupValues ()
	The values the last importLanguageFile() with $skipInvalidEntries left out for their markup. More...

	getSkippedDuplicateValues ()
	The values the last importLanguageFile() with $skipInvalidEntries left out as duplicates of another module. More...

Public Member Functions inherited from ilObjLanguage
	__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	_getShippedMigratedComments (string $a_lang_key, array $a_modules=[])
	For display only (like getShippedCommentsForDisplay()), e.g. More...

static	findInvalidMarkupOfChangedValues (string $a_lang_key, array $values)
	The values a save into $a_lang_key would change and that contain markup TranslationMarkupPolicy does not allow, see TranslationMarkupPolicy::findInvalidChangedValues(). More...

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

Private Member Functions
	writeLocalChangesIntoGlobalLanguageFile ()

	mergeLocalChangesIntoShippedPoFiles ()

	shippedMigratedModules ()

	moduleEntriesOf (array $values)

	syncMigratedFilesAfterDeleteModeImport (array $modules_before_delete, array $to_save, array $remarks)
	A module that existed before the "delete" wipe but is absent from the imported file is never visited by _saveValues(); its orphaned overlay would keep serving stale values. More...

Static Private Member Functions
static	requestedLocalRemark (string $requested, string $stored, string $note)
	The shipped note itself is no local remark (''), an empty remark removes the local one; a shipped note cannot be hidden locally. More...

static	withFuzzyMarkers (array $comments, array $shipped)
	Appends SHIPPED_FUZZY_MARKER_TOPIC to the shipped note of every fuzzy entry. More...

static	mergeIntoDatabase (string $a_lang_key, string $module, array $identifiers, array $remark_identifiers)
	Database part of the merge into the shipped .po: the lng_data rows of $identifiers lose local_change - unlike the global language file, since the next update compares local changes with the shipped value (see LanguageInstallationManager::resolveMigratedModule()) and a remaining one would come back once the shipped value changes. More...

static	readShippedMigratedModules (string $a_lang_key, array $only_modules=[])
	An unreadable shipped .po is logged and listed in "unreadable_modules" (its module stays in "modules"); callers decide whether that is fatal (importLanguageFile()) or a warning. More...

static	shippedValuesAndComments (ilLanguageFile $global_file, array $shipped)
	$global_file with every readable module maintained in PO files replaced by its shipped .po, see getShippedValues(). More...

static	withoutModules (array $values, array $modules, string $separator)

static	matchesLikePattern (string $value, string $pattern)
	PHP counterpart of the ‘UPPER(value) LIKE UPPER(’%<pattern>')` condition of getValues() (see ilDBInterface::like()): case-insensitive, "%" any sequence, "</em>" any character, "\" escapes. More...

static	saveValues (string $a_lang_key, array $a_values, array $a_remarks, bool $merge_onto_current_content)
	With $merge_onto_current_content `false` the saved entries are each module's complete new content ("delete"-mode import). More...

static	withPluralFormKeys (array $entries, array $shipped_migrated, string $separator)
	Replaces the plain identifier of a plural message of a module maintained in PO files by the key of its default form (see MigratedLanguageFileSync::defaultFormKeyOf()), the form its lng_data row stands for. More...

static	shippedModuleValues (array $shipped_migrated, string $module, string $separator)
	identifier => value out of the values of readShippedMigratedModules(). More...

static	setOverlayRemarks (string $a_lang_key, string $module, array $changes)
	Writes $changes (identifier => remark, '' removes it) into the overlay; `false` if that failed (logged), lng_data holds them regardless. More...

static	normalizedRemarks (array $a_remarks)
	Remarks as stored, identically for lng_data and the overlay: cut to 250 characters (not bytes); one that is not valid UTF-8 is dropped (logged), it would make the overlay unreadable. More...

static	isMaintainedInPoFiles (string $a_lang_key, string $module)
	Whether $module is maintained in PO files for $a_lang_key (its shipped .po exists). More...

static	updateRemark (string $module, string $identifier, string $a_lang_key, string $remark)
	Sets only the remark of an existing lng_data row ('' removes it), like replaceLangEntry() cuts it to 250 characters. More...

static	writePluralRows (string $a_lang_key, string $module, array $content, array $shipped_values, array $plural_rows, string $save_date)
	The database holds a plural message only under its identifier, with the value of its default form, marked as local change only if that differs from the shipped default form (a local change of another form lives in the overlay only): after a rollback a later update of the legacy `.lang` files is not held back by it. More...

static	currentModuleContent (string $a_lang_key, string $module)
	The content a partial save/delete is applied to: for a PO module its shipped state plus overlay, never its DB rows; `null` (reported) if unreadable, as applying to nothing would reset every unsaved entry. More...

static	withoutUnreadableModules (string $a_lang_key, array $entries, string $separator, array &$skipped_modules)
	Drops the entries of modules whose content cannot be read (see currentModuleContent()), before anything is written. More...

static	withModuleLock (string $a_lang_key, string $module, \Closure $callback)
	See MigratedLanguageFileSync::withOverlayLock(). More...

Private Attributes
const string	SHIPPED_FUZZY_MARKER_TOPIC = 'lng_not_translated'
	Language variable of the admin GUI marker for an entry that is fuzzy (not translated yet) in its shipped .po. More...

array	$shipped_migrated_modules = null

array	$skipped_invalid_markup_values = []

array	$skipped_duplicate_values = []

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

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

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

Returns: list<string> see _saveValues()

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

                                                                                       : array
    {
        global $DIC;
        $lng = $DIC->language();
 
        $delete_array = array();
        $modules_with_unwritten_overlay = [];
        $a_values = self::withoutUnreadableModules($a_lang_key, $a_values, $lng->separator, $modules_with_unwritten_overlay);
        $shipped_migrated = null;
        $shipped_by_module = [];
        $plural_rows = [];
        $db_comments = null;
        $remark_changes = [];
 
        // 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;
 
                // a form of a plural message has no row of its own: the message's row is rewritten once, see below
                if (PluralFormKey::parse($topic) !== null) {
                    $shipped_migrated ??= self::readShippedMigratedModules($a_lang_key);
                    $shipped_by_module[$module] ??= self::shippedModuleValues($shipped_migrated, $module, $lng->separator);
                }
                $plural_identifier = isset($shipped_by_module[$module])
                    ? MigratedLanguageFileSync::pluralMessageOf($topic, $shipped_by_module[$module])
                    : null;
                if ($plural_identifier !== null) {
                    // the remark of the identifier is kept
                    $db_comments ??= self::_getRemarks($a_lang_key);
                    $plural_rows[$module][$plural_identifier] = $db_comments[$module . $lng->separator . $plural_identifier] ?? null;
                    continue;
                }
                ilObjLanguage::deleteLangEntry($module, $topic, $a_lang_key);
                // the remark goes with the row, for a PO module also from its overlay
                if (self::isMaintainedInPoFiles($a_lang_key, $module)) {
                    $remark_changes[$module][$topic] = '';
                }
            }
        }
 
        // save the serialized module entries in lng_modules
        $save_date = (new DateTimeImmutable('now', new DateTimeZone('UTC')))->format('Y-m-d H:i:s');
        foreach ($delete_array as $module => $entries) {
            $module = (string) $module;
            $module_plural_rows = $plural_rows[$module] ?? [];
            $shipped_module_values = $shipped_by_module[$module] ?? [];
            $module_remark_changes = $remark_changes[$module] ?? [];
            $written = self::withModuleLock(
                $a_lang_key,
                $module,
                static function () use ($a_lang_key, $module, $entries, $module_plural_rows, $shipped_module_values, $save_date, $module_remark_changes): bool {
                    // without a current content nothing is left to keep; the entries to delete must not be written back
                    $current = self::currentModuleContent($a_lang_key, $module);
                    if ($current === null) {
                        return false;
                    }
                    $content = array_diff_key($current, $entries);
                    $written = ilObjLanguage::replaceLangModule($a_lang_key, $module, $content);
                    self::writePluralRows($a_lang_key, $module, $content, $shipped_module_values, $module_plural_rows, $save_date);
                    return self::setOverlayRemarks($a_lang_key, $module, $module_remark_changes) && $written;
                }
            );
            if (!$written) {
                $modules_with_unwritten_overlay[] = $module;
            }
        }
 
        return $modules_with_unwritten_overlay;
    }

References $DIC, $lng, $module, $written, ilObjLanguage\deleteLangEntry(), and ilObjLanguage\replaceLangModule().

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

                                                          : 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"];
        }
 
        // a migrated module is included even if lng_data holds no row for it: its .po/.mo is authoritative
        if ($DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            $migrated_modules = MigratedLanguageFileSync::getMigratedModules(
                $DIC[LanguageFileDirectoryManager::class],
                $a_lang_key,
                MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH)
            );
            $modules = array_unique(array_merge($modules, $migrated_modules));
            sort($modules);
        }
 
        return $modules;
    }

References $DIC, $ilDB, ilDBConstants\FETCHMODE_ASSOC, and ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

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

Here is the call graph for this function:

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 module maintained in PO files: remarks of its overlay win over lng_data.

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

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

                                                                                       : 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"];
        }
 
        // A module maintained in PO files keeps its remarks in its overlay as well (see
        // MigratedLanguageFileSync::sync()) - they win; a remark only lng_data holds (written before
        // the overlay kept remarks) is shown until the next reconciling write takes it over
        if ($DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            $manager = $DIC[LanguageFileDirectoryManager::class];
            $client_data_dir = MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH);
            foreach (MigratedLanguageFileSync::getMigratedModules($manager, $a_lang_key, $client_data_dir) as $module) {
                try {
                    $overlay_remarks = MigratedLanguageFileSync::loadRemarks($manager, $a_lang_key, $module, $client_data_dir) ?? [];
                } catch (\Throwable $t) {
                    $DIC->logger()->forComponent('lang')->warning(sprintf(
                        'Could not read the remarks of migrated module "%s", language "%s" - using lng_data: %s',
                        $module,
                        $a_lang_key,
                        $t->getMessage()
                    ));
                    continue;
                }
                foreach ($overlay_remarks as $identifier => $remark) {
                    $remarks[$module . $lng->separator . $identifier] = $remark;
                }
            }
        }
 
        return $remarks;
    }

References $DIC, $ilDB, $lng, and $module.

Referenced by ilObjLanguageExtGUI\compareComments(), getAllRemarks(), getMergedRemarks(), SaveValuesOverlayRemarksTest\testGetRemarksOverlayRemarkWinsOverAStaleLngDataOne(), and SaveValuesOverlayRemarksTest\testGetRemarksShowsALngDataOnlyRemarkWithoutAnOverlayOne().

Here is the caller graph for this function:

◆ _getShippedMigratedComments()

static ilObjLanguageExt::_getShippedMigratedComments	(	string	$a_lang_key,
		array	$a_modules = `[]`
	)

static

For display only (like getShippedCommentsForDisplay()), e.g.

of a compare language; with $a_modules only those modules' shipped .po are read.

Parameters

list<string> $a_modules

Returns: array<string, string> module.separator.topic => comment

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

                                                                                                 : array
    {
        $shipped = self::readShippedMigratedModules($a_lang_key, $a_modules);
 
        return self::withFuzzyMarkers($shipped['comments'], $shipped);
    }

References readShippedMigratedModules(), and withFuzzyMarkers().

Referenced by ilObjLanguageExtGUI\compareComments(), and SaveValuesOverlayRemarksTest\testGetShippedMigratedCommentsAppendsTheFuzzyMarkerForAFuzzyEntryOnly().

Here is the call graph for this function:

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

     : array {
        global $DIC;
        $ilDB = $DIC->database();
        $lng = $DIC->language();
 
        // migrated modules are read from their .po file, exactly as ilLanguage::txt() serves them; the filters
        // are re-applied in PHP, mirroring the SQL WHERE clauses below
        $migrated_values = [];
        // never their (dual-written) lng_data rows, also if their files cannot be read
        $migrated_modules_found = [];
        $has_manager = $DIC->offsetExists(LanguageFileDirectoryManager::class);
        if ($has_manager) {
            $manager = $DIC[LanguageFileDirectoryManager::class];
            $client_data_dir = MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH);
            $candidate_modules = $a_modules !== [] || !MigratedLanguageFilePaths::isValidLanguageKey($a_lang_key)
                ? $a_modules
                : array_keys(MigratedLanguageFileSync::findShippedModuleFiles($manager, ILIAS_ABSOLUTE_PATH, $a_lang_key));
 
            foreach ($candidate_modules as $module) {
                $module = (string) $module;
                try {
                    $translations = MigratedLanguageFileSync::loadEditableModuleTranslations(
                        $manager,
                        $a_lang_key,
                        $module,
                        $client_data_dir,
                        ILIAS_ABSOLUTE_PATH
                    );
                } catch (\Throwable $t) {
                    MigratedTranslations::reportProblem(sprintf(
                        'The language file of module "%s" for "%s" cannot be read, its values are not shown: %s',
                        $module,
                        $a_lang_key,
                        $t->getMessage()
                    ));
                    $migrated_modules_found[] = $module;
                    continue;
                }
                if ($translations === null) {
                    continue;
                }
                $migrated_modules_found[] = $module;
 
                foreach ($translations as $identifier => $entry) {
                    $identifier = (string) $identifier;
                    // a plural message is listed as its forms (see PluralFormKey); a topic selects all of them
                    if (
                        $a_topics !== []
                        && !in_array($identifier, $a_topics, true)
                        && !in_array(PluralFormKey::parse($identifier)[0] ?? null, $a_topics, true)
                    ) {
                        continue;
                    }
                    if ($a_pattern !== '' && !self::matchesLikePattern($entry['value'], $a_pattern)) {
                        continue;
                    }
                    if ($a_state === 'changed' && !$entry['local_change']) {
                        continue;
                    }
                    if ($a_state === 'unchanged' && $entry['local_change']) {
                        continue;
                    }
                    $migrated_values[$module . $lng->separator . $identifier] = $entry['value'];
                }
            }
        }
 
        $q = "SELECT module, identifier, value FROM lng_data WHERE" .
            " lang_key = " . $ilDB->quote($a_lang_key, "text") . " ";
 
        if ($migrated_modules_found !== []) {
            // excluded, not merely overridden: the dual-written lng_data copy must not appear next to the file-sourced entry
            $q .= " AND " . $ilDB->in("module", $migrated_modules_found, true, "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)) {
            if (!$has_manager && MigratedTranslations::shipsPoFor((string) $rec["module"], $a_lang_key)) {
                MigratedTranslations::reportProblem(sprintf(
                    'Without the language file directories the values of module "%s" are not shown.',
                    $rec["module"]
                ));
                continue;
            }
            $values[$rec["module"] . $lng->separator . $rec["identifier"]] = $rec["value"];
        }
 
        $values = array_merge($values, $migrated_values);
        // restores ORDER BY module, identifier for the merged-in modules: case-insensitive like *_unicode_ci, and
        // since "#" of the separator sorts before every character of a module name, this sorts by module first
        ksort($values, SORT_STRING | SORT_FLAG_CASE);
 
        return $values;
    }

References $DIC, $lng, and $module.

Here is the caller graph for this function:

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

Returns: list<string> the modules whose PO/MO overlay could not be written (the database was written regardless)

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

     : array {
        return self::saveValues($a_lang_key, $a_values, $a_remarks, true)['unwritten'];
    }

Here is the caller graph for this function:

◆ backupShippedPoFiles()

ilObjLanguageExt::backupShippedPoFiles ( string $directory )

The backup the filter "conflicts" compares with (see getShippedChangesSinceBackup()), written by the "save_dist" action next to the backup of the global language file.

Returns: list<string> the modules whose .po could not be copied

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

                                                           : array
    {
        global $DIC;
 
        if (!$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return [];
        }
 
        return ShippedPoMerger::backupShippedPoFiles(
            $DIC[LanguageFileDirectoryManager::class],
            ILIAS_ABSOLUTE_PATH,
            $this->key,
            $directory,
            // e.g. lang_data below the client data directory: no symbolic link out of it
            defined('CLIENT_DATA_DIR') ? (string) CLIENT_DATA_DIR : $directory
        );
    }

References $DIC, and CLIENT_DATA_DIR.

◆ currentModuleContent()

static ilObjLanguageExt::currentModuleContent	(	string	$a_lang_key,
		string	$module
	)

staticprivate

The content a partial save/delete is applied to: for a PO module its shipped state plus overlay, never its DB rows; null (reported) if unreadable, as applying to nothing would reset every unsaved entry.

Other modules: the lng_modules row, [] if none.

Must be called under the module's overlay lock (see withModuleLock()).

Returns: array<string, string>|null identifier => value

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

                                                                                    : ?array
    {
        global $DIC;
 
        if ($DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            try {
                $content = MigratedLanguageFileSync::loadEditableModuleTranslations(
                    $DIC[LanguageFileDirectoryManager::class],
                    $a_lang_key,
                    $module,
                    MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH),
                    ILIAS_ABSOLUTE_PATH,
                    true
                );
            } catch (\Throwable $t) {
                MigratedTranslations::reportProblem(sprintf(
                    'The language file of module "%s" for "%s" cannot be read, the changes are not saved: %s',
                    $module,
                    $a_lang_key,
                    $t->getMessage()
                ));
                return null;
            }
            if ($content !== null) {
                return array_map(static fn(array $entry): string => $entry['value'], $content);
            }
        } elseif (MigratedTranslations::shipsPoFor($module, $a_lang_key)) {
            MigratedTranslations::reportProblem(sprintf(
                'Without the language file directories the changes of module "%s" are not saved.',
                $module
            ));
            return null;
        }
 
        $ilDB = $DIC->database();
        $set = $ilDB->query(sprintf(
            "SELECT lang_array FROM lng_modules WHERE lang_key = %s AND module = %s",
            $ilDB->quote($a_lang_key, "text"),
            $ilDB->quote($module, "text")
        ));
        $row = $ilDB->fetchAssoc($set);
        $content = is_array($row) && isset($row["lang_array"])
            ? unserialize((string) $row["lang_array"], ["allowed_classes" => false])
            : null;
 
        return is_array($content) ? $content : [];
    }

References $DIC, $ilDB, and $module.

◆ findInvalidMarkupOfChangedValues()

static ilObjLanguageExt::findInvalidMarkupOfChangedValues	(	string	$a_lang_key,
		array	$values
	)

static

The values a save into $a_lang_key would change and that contain markup TranslationMarkupPolicy does not allow, see TranslationMarkupPolicy::findInvalidChangedValues().

Parameters

array<string,string> $values

Returns: array<string, list<string>> key => violations

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

                                                                                              : array
    {
        // current and shipped values are only read if a value breaks the rules at all
        $policy = new TranslationMarkupPolicy();
        $candidates = array_intersect_key($values, $policy->findInvalidValues($values));
        if ($candidates === []) {
            return [];
        }
        [$shipped_values] = self::shippedValuesAndComments(
            ilLanguageFile::_getGlobalLanguageFile($a_lang_key),
            self::readShippedMigratedModules($a_lang_key)
        );
 
        return $policy->findInvalidChangedValues($candidates, self::_getValues($a_lang_key), $shipped_values);
    }

References $policy, ilLanguageFile\_getGlobalLanguageFile(), and shippedValuesAndComments().

Referenced by ilObjLanguageExtGUI\saveObject(), SaveValuesMergesOntoOverlayTest\testFindInvalidMarkupOfChangedValuesAppliesTheCurrentAndShippedComparison(), and SaveValuesMergesOntoOverlayTest\testFindInvalidMarkupOfChangedValuesNeverReadsCurrentOrShippedValuesWhenNothingIsSuspicious().

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 shipped language files (see getShippedValues()) - source as in getAllValues()

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

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

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

References _getValues(), and getShippedValues().

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

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

References _getRemarks().

Referenced by getEffectiveRemarks().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllValues()

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

Get all values from the database; a migrated module is read from its shipped .po with the overlay delta on top (see _getValues()).

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

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

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

References _getValues().

Referenced by getShippedChangesSinceBackup().

Here is the call graph for this function:

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 (source as in getAllValues()) 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 208 of file class.ilObjLanguageExt.php.

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

References _getValues().

Here is the call graph for this function:

◆ getCommentedValues()

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

Get all values for which the shipped language files have a comment (see getShippedComments()) - source as in getAllValues()

Note: This function checks the comments in the shipped language files, 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 254 of file class.ilObjLanguageExt.php.

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

References _getValues(), and getShippedComments().

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

                                     : string
    {
        return $this->cust_lang_path;
    }

References ilObjLanguage\$cust_lang_path.

Referenced by mergeLocalChangesIntoShippedPoFiles().

Here is the caller graph for this function:

◆ getDataPath()

ilObjLanguageExt::getDataPath ( )

Return the path for language data written by ILIAS.

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

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

References CLIENT_DATA_DIR, and ilFileUtils\makeDir().

Here is the call graph for this function:

◆ getEffectiveRemarks()

ilObjLanguageExt::getEffectiveRemarks ( )

The remark as the admin table shows it: the local remark, else the note of the shipped .po (#, else #.

; plural notes are listed per form, see PluralFormKey). saveValues() compares against the same remarks.

Returns: array<string, string> module.separator.topic => remark, no empty ones

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

                                         : array
    {
        $local_remarks = array_filter(
            array_map(static fn(?string $remark): string => (string) $remark, $this->getAllRemarks()),
            static fn(string $remark): bool => $remark !== ''
        );
        $shipped = $this->shippedMigratedModules();
        $readable_modules = array_diff($shipped['modules'], $shipped['unreadable_modules']);
        $remarks = [];
        foreach ($shipped['comments'] as $key => $note) {
            $keys = explode($this->separator, (string) $key, 2);
            if (count($keys) !== 2 || !in_array($keys[0], $readable_modules, true) || (string) $note === '') {
                continue;
            }
            $message_key = $keys[0] . $this->separator . (PluralFormKey::parse($keys[1])[0] ?? $keys[1]);
            if (!isset($local_remarks[$key]) && !isset($local_remarks[$message_key])) {
                $remarks[$key] = (string) $note;
            }
        }
 
        return array_merge($remarks, $local_remarks);
    }

References ilObjLanguage\$key, getAllRemarks(), and shippedMigratedModules().

Here is the call graph for this function:

◆ getGlobalLanguageFile()

ilObjLanguageExt::getGlobalLanguageFile ( )

Read and get the global language file as an object.

Lines of modules maintained in PO files are not that module's source, see getShippedValues()/getShippedComments().

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

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

References ilLanguageFile\_getGlobalLanguageFile().

Referenced by getShippedChangesSinceBackup(), getShippedComments(), getShippedValues(), and writeLocalChangesIntoGlobalLanguageFile().

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

                                 : string
    {
        return $this->lang_path;
    }

References ilObjLanguage\$lang_path.

◆ getLongDescription()

ilObjLanguageExt::getLongDescription ( )

Get the full language description.

Return description

Reimplemented from ilObject.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getMergedRemarks()

ilObjLanguageExt::getMergedRemarks ( )

Get the local remarks merged into the comments of the shipped language files (see getShippedComments())

The returned array contains:

all comments that exist in the shipped language files, with their local values, ordered like in the global language file (modules maintained in PO files last)
all additional local remarks, ordered by module and identifier

Return array module.separator.topic => value

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

                                      : array
    {
        // Get remarks including empty remarks for local changes
        $local_remarks = self::_getRemarks($this->key, true);
 
        return array_merge($this->getShippedComments(), $local_remarks);
    }

References _getRemarks(), and getShippedComments().

Here is the call graph for this function:

◆ getMergedValues()

ilObjLanguageExt::getMergedValues ( )

Get the local values merged into the shipped values (see getShippedValues()), source as in getAllValues()

The returned array contains:

all entries that exist in the shipped language files, with their local values, ordered like in the global language file (modules maintained in PO files last)
all additional local entries, ordered by module and identifier

Not for writing the global language file - see mergeLocalChangesIntoGlobalLanguageFile().

Return array module.separator.topic => value

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

                                     : array
    {
        return array_merge($this->getShippedValues(), self::_getValues($this->key));
    }

References getShippedValues().

Here is the call graph for this function:

◆ getModulesMaintainedInPoFiles()

ilObjLanguageExt::getModulesMaintainedInPoFiles ( )

Every module maintained in PO files for this language (its shipped .po exists).

Returns: list<string>

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

                                                   : array
    {
        return $this->shippedMigratedModules()['modules'];
    }

References shippedMigratedModules().

Referenced by writeLocalChangesIntoGlobalLanguageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShippedChangesSinceBackup()

ilObjLanguageExt::getShippedChangesSinceBackup	(	ilLanguageFile	$former_file,
		string	$po_backup_directory
	)

Entries of the global language file (without modules maintained in PO files) and of their shipped .po that differ from the backup; a module without backup contributes nothing.

Returns: array<string, string> module.separator.identifier => current shipped value

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

                                                                                                          : array
    {
        global $DIC;
 
        $changes = self::withoutModules(
            array_diff_assoc($this->getGlobalLanguageFile()->getAllValues(), $former_file->getAllValues()),
            $this->getModulesMaintainedInPoFiles(),
            $this->separator
        );
        if (!$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return $changes;
        }
        $po_changes = ShippedPoMerger::findShippedChangesSinceBackup(
            $DIC[LanguageFileDirectoryManager::class],
            ILIAS_ABSOLUTE_PATH,
            $this->key,
            $po_backup_directory
        );
        foreach ($po_changes['changes'] as $module => $values) {
            foreach ($values as $identifier => $value) {
                $changes[$module . $this->separator . $identifier] = $value;
            }
        }
 
        return $changes;
    }

References $DIC, $module, ilLanguageFile\getAllValues(), getAllValues(), getGlobalLanguageFile(), and withoutModules().

Here is the call graph for this function:

◆ getShippedComments()

ilObjLanguageExt::getShippedComments ( )

Counterpart of getShippedValues(): modules maintained in PO files contribute the comments of their shipped .po.

Returns: array<string, string> module.separator.topic => comment

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

                                        : array
    {
        return self::shippedValuesAndComments($this->getGlobalLanguageFile(), $this->shippedMigratedModules())[1];
    }

References getGlobalLanguageFile(), shippedMigratedModules(), and shippedValuesAndComments().

Referenced by getCommentedValues(), getMergedRemarks(), and getShippedCommentsForDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getShippedCommentsForDisplay()

ilObjLanguageExt::getShippedCommentsForDisplay ( )

For display only (admin GUI): adds the "not translated yet" marker for fuzzy entries (see withFuzzyMarkers()).

The marker is no comment: not exported, not filtered for, not compared on saving.

Returns: array<string, string> module.separator.topic => comment

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

                                                  : array
    {
        return self::withFuzzyMarkers($this->getShippedComments(), $this->shippedMigratedModules());
    }

References getShippedComments(), shippedMigratedModules(), and withFuzzyMarkers().

Here is the call graph for this function:

◆ getShippedValues()

ilObjLanguageExt::getShippedValues ( )

The global language file, except for modules maintained in PO files: their shipped .po is used (see LanguageInstallationManager).

An unreadable .po keeps that module's .lang lines as approximation; logged and reported by getUnreadableShippedPoModules().

Returns: array<string, string> module.separator.topic => value

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

                                      : array
    {
        return self::shippedValuesAndComments($this->getGlobalLanguageFile(), $this->shippedMigratedModules())[0];
    }

References getGlobalLanguageFile(), shippedMigratedModules(), and shippedValuesAndComments().

Referenced by getAddedValues(), and getMergedValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSkippedDuplicateValues()

ilObjLanguageExt::getSkippedDuplicateValues ( )

The values the last importLanguageFile() with $skipInvalidEntries left out as duplicates of another module.

Returns: array<string, list<string>> module.separator.identifier => "<module>: <identifier>" it would duplicate

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

                                               : array
    {
        return $this->skipped_duplicate_values;
    }

References $skipped_duplicate_values.

◆ getSkippedInvalidMarkupValues()

ilObjLanguageExt::getSkippedInvalidMarkupValues ( )

The values the last importLanguageFile() with $skipInvalidEntries left out for their markup.

Returns: array<string, list<string>> module.separator.identifier => violations

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

                                                   : array
    {
        return $this->skipped_invalid_markup_values;
    }

References $skipped_invalid_markup_values.

◆ getUnchangedValues()

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

Get only the unchanged values (source as in getAllValues()) which are equal to the original language file.

Return array module.separator.topic => value

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

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

References _getValues().

Here is the call graph for this function:

◆ getUnreadableShippedPoModules()

ilObjLanguageExt::getUnreadableShippedPoModules ( )

The modules maintained in PO files whose shipped .po cannot be read - see getShippedValues().

Returns: list<string>

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

                                                   : array
    {
        return $this->shippedMigratedModules()['unreadable_modules'];
    }

References shippedMigratedModules().

Here is the call graph for this function:

◆ hasLocalChangesOutsidePoModules()

ilObjLanguageExt::hasLocalChangesOutsidePoModules ( )

Whether "merge" has something to write into the global language file: a local change (a changed remark sets local_change as well, see _saveValues()) of a module outside the PO files.

Shipped comments do not count.

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

                                                     : bool
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $ilDB->setLimit(1, 0);
        $result = $ilDB->query(
            "SELECT 1 FROM lng_data WHERE lang_key = " . $ilDB->quote($this->key, "text")
            . " AND local_change IS NOT NULL"
            . " AND " . $ilDB->in("module", $this->getModulesMaintainedInPoFiles(), true, "text")
        );
 
        return $ilDB->fetchAssoc($result) !== null;
    }

References $DIC, and $ilDB.

◆ isMaintainedInPoFiles()

static ilObjLanguageExt::isMaintainedInPoFiles	(	string	$a_lang_key,
		string	$module
	)

staticprivate

Whether $module is maintained in PO files for $a_lang_key (its shipped .po exists).

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

                                                                                     : bool
    {
        global $DIC;
 
        return $DIC->offsetExists(LanguageFileDirectoryManager::class)
            && isset(MigratedLanguageFileSync::findShippedModuleFiles(
                $DIC[LanguageFileDirectoryManager::class],
                ILIAS_ABSOLUTE_PATH,
                $a_lang_key
            )[$module]);
    }

References $DIC, and $module.

◆ matchesLikePattern()

static ilObjLanguageExt::matchesLikePattern	(	string	$value,
		string	$pattern
	)

staticprivate

PHP counterpart of the ‘UPPER(value) LIKE UPPER(’%<pattern>')` condition of getValues() (see ilDBInterface::like()): case-insensitive, "%" any sequence, "</em>" any character, "\" escapes.

Not replicated: accent-insensitivity of *_unicode_ci. Consecutive "%" collapse to one ".*" to avoid needless backtracking.

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

                                                                              : bool
    {
        $regex = '';
        $length = mb_strlen($pattern);
        $previous_was_any_sequence = false;
        for ($i = 0; $i < $length; $i++) {
            $char = mb_substr($pattern, $i, 1);
            $is_any_sequence = $char === '%';
            if ($char === '\\' && $i + 1 < $length) {
                $regex .= preg_quote(mb_substr($pattern, ++$i, 1), '/');
            } elseif ($is_any_sequence) {
                $regex .= $previous_was_any_sequence ? '' : '.*';
            } elseif ($char === '_') {
                $regex .= '.';
            } else {
                $regex .= preg_quote($char, '/');
            }
            $previous_was_any_sequence = $is_any_sequence;
        }
 
        return preg_match('/' . $regex . '/isu', $value) === 1;
    }

References $pattern.

◆ mergeIntoDatabase()

static ilObjLanguageExt::mergeIntoDatabase	(	string	$a_lang_key,
		string	$module,
		array	$identifiers,
		array	$remark_identifiers
	)

staticprivate

Database part of the merge into the shipped .po: the lng_data rows of $identifiers lose local_change - unlike the global language file, since the next update compares local changes with the shipped value (see LanguageInstallationManager::resolveMigratedModule()) and a remaining one would come back once the shipped value changes.

The remarks of $remark_identifiers became comments of the .po and are removed. lng_modules is unchanged.

Parameters

list<string>	$identifiers
list<string>	$remark_identifiers

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

                                                                                                                                : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        foreach (['local_change' => $identifiers, 'remarks' => $remark_identifiers] as $column => $keys) {
            if ($keys === []) {
                continue;
            }
            $ilDB->manipulate(sprintf(
                "UPDATE lng_data SET %s = NULL WHERE lang_key = %s AND module = %s AND %s",
                $column,
                $ilDB->quote($a_lang_key, "text"),
                $ilDB->quote($module, "text"),
                $ilDB->in("identifier", $keys, false, "text")
            ));
        }
    }

References $DIC, $ilDB, and $module.

Referenced by mergeLocalChangesIntoShippedPoFiles().

Here is the caller graph for this function:

◆ mergeLocalChangesIntoGlobalLanguageFile()

ilObjLanguageExt::mergeLocalChangesIntoGlobalLanguageFile ( bool $write_global_file = true )

The "merge" maintenance action of the developer mode (LANGMODE):

modules not maintained in PO files go into the global language file (not if $write_global_file is false), the lines of modules maintained in PO files stay as read (see ilLanguageFile::keepOriginalLines());
modules maintained in PO files with local changes go into their shipped .po (new entries into the .pot, see ShippedPoMerger), after a backup into the customizing directory. The lng_data rows of taken over entries lose local_change, and their remarks where these became comments of the .po (see mergeIntoDatabase()). The overlay keeps serving the taken over values until "setup build" (the web server does not build) and "setup update" ran.

Returns: array{ written: list<string>, skipped: list<string>, invalid_markup: array<string, list<string>>, not_merged: list<string>, unwritten_database: list<string> } for the modules maintained in PO files: written - shipped .po files written (relative to the ILIAS directory); skipped - modules left out as a whole (logged); invalid_markup - module.separator.identifier => violations of values not taken over; not_merged - module.separator.identifier of entries not taken over (logged); unwritten_database - modules whose lng_data rows could not be updated (logged; their files are written)

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

                                                                                           : array
    {
        if ($write_global_file) {
            $this->writeLocalChangesIntoGlobalLanguageFile();
        }
 
        $result = $this->mergeLocalChangesIntoShippedPoFiles();
        $this->shipped_migrated_modules = null;
 
        return $result;
    }

References mergeLocalChangesIntoShippedPoFiles(), and writeLocalChangesIntoGlobalLanguageFile().

Here is the call graph for this function:

◆ mergeLocalChangesIntoShippedPoFiles()

ilObjLanguageExt::mergeLocalChangesIntoShippedPoFiles ( )

private

Returns: array{written: list<string>, skipped: list<string>, invalid_markup: array<string, list<string>>, not_merged: list<string>, unwritten_database: list<string>}

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

                                                          : array
    {
        global $DIC;
 
        $result = ['written' => [], 'skipped' => [], 'invalid_markup' => [], 'not_merged' => [], 'unwritten_database' => []];
        if (!$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return $result;
        }
        $lang_key = $this->key;
        $merged = ShippedPoMerger::merge(
            $DIC[LanguageFileDirectoryManager::class],
            ILIAS_ABSOLUTE_PATH,
            $lang_key,
            MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH),
            $this->getCustLangPath(),
            static function (string $module, array $identifiers, array $remark_identifiers) use ($lang_key): void {
                self::mergeIntoDatabase($lang_key, $module, $identifiers, $remark_identifiers);
            }
        );
 
        $logger = $DIC->logger()->forComponent('lang');
        $root = rtrim(ILIAS_ABSOLUTE_PATH, '/') . '/';
        foreach ($merged['written'] as $file) {
            $result['written'][] = str_starts_with($file, $root) ? substr($file, strlen($root)) : $file;
        }
        foreach ($merged['skipped'] as $module => $reason) {
            $result['skipped'][] = (string) $module;
            $logger->warning(PlainLogText::of(sprintf(
                'The local changes of module "%s", language "%s" were not merged into its shipped PO file: %s',
                $module,
                $lang_key,
                $reason
            )));
        }
        foreach ($merged['invalid_markup'] as $module => $invalid) {
            foreach ($invalid as $identifier => $violations) {
                $result['invalid_markup'][$module . $this->separator . $identifier] = $violations;
            }
        }
        foreach ($merged['not_merged'] as $module => $identifiers) {
            foreach ($identifiers as $identifier) {
                $result['not_merged'][] = $module . $this->separator . $identifier;
            }
        }
        if ($result['not_merged'] !== []) {
            $logger->warning(PlainLogText::of(sprintf(
                'Language entries not merged into their shipped PO file (a plural message with an empty first form next to other forms, a plural message for a singular shipped one, or a new identifier in the form of a plural form): %s',
                implode(', ', $result['not_merged'])
            )));
        }
        foreach ($merged['unwritten_database'] as $module => $reason) {
            $result['unwritten_database'][] = (string) $module;
            $logger->error(PlainLogText::of(sprintf(
                'The shipped PO file of module "%s", language "%s" was merged, but its lng_data rows could not be updated (local_change/remarks stay set): %s',
                $module,
                $lang_key,
                $reason
            )));
        }
        foreach ($merged['unmarked_overlay'] as $module => $reason) {
            $logger->error(PlainLogText::of(sprintf(
                'The shipped PO file of module "%s", language "%s" was merged, but its overlay entries could not be marked as taken over (until "php cli/setup.php build", saving the module again may fall back to the former shipped values - merging again marks them): %s',
                $module,
                $lang_key,
                $reason
            )));
        }
        if ($result['written'] !== []) {
            $logger->info(PlainLogText::of(sprintf(
                'Merged the local changes of language "%s" into (now owned by the web server user; served from the overlay until "php cli/setup.php build" and "php cli/setup.php update" ran): %s',
                $lang_key,
                implode(', ', $result['written'])
            )));
        }
 
        return $result;
    }

References $DIC, ilObjLanguage\$key, ILIAS\TestQuestionPool\ExportImport\Foundation\Export\$logger, $module, getCustLangPath(), and mergeIntoDatabase().

Referenced by mergeLocalChangesIntoGlobalLanguageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moduleEntriesOf()

ilObjLanguageExt::moduleEntriesOf ( array $values )

private

Parameters

array<string,string> $values module.separator.identifier => value

Returns: array<string, array{module: string, identifier: string}>

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

                                                   : array
    {
        $entries = [];
        foreach (array_keys($values) as $key) {
            $parts = explode($this->separator, (string) $key);
            if (count($parts) === 2) {
                $entries[$key] = ['module' => $parts[0], 'identifier' => $parts[1]];
            }
        }
 
        return $entries;
    }

◆ normalizedRemarks()

static ilObjLanguageExt::normalizedRemarks ( array $a_remarks )

staticprivate

Remarks as stored, identically for lng_data and the overlay: cut to 250 characters (not bytes); one that is not valid UTF-8 is dropped (logged), it would make the overlay unreadable.

Parameters

array<string,mixed> $a_remarks

Returns: array<string, mixed>

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

                                                               : array
    {
        global $DIC;
 
        foreach ($a_remarks as $key => $remark) {
            if (!is_string($remark)) {
                continue;
            }
            if (!mb_check_encoding($remark, 'UTF-8')) {
                $DIC->logger()->forComponent('lang')->warning(PlainLogText::of(sprintf(
                    'The remark of "%s" is not valid UTF-8 and was not saved.',
                    $key
                )));
                unset($a_remarks[$key]);
                continue;
            }
            $a_remarks[$key] = mb_substr($remark, 0, 250);
        }
 
        return $a_remarks;
    }

References $DIC.

◆ readShippedMigratedModules()

static ilObjLanguageExt::readShippedMigratedModules	(	string	$a_lang_key,
		array	$only_modules = `[]`
	)

staticprivate

An unreadable shipped .po is logged and listed in "unreadable_modules" (its module stays in "modules"); callers decide whether that is fatal (importLanguageFile()) or a warning.

Everything empty without a LanguageFileDirectoryManager.

Returns: array{values: array<string, string>, comments: array<string, string>, modules: list<string>, unreadable_modules: list<string>, fuzzy: list<string>} values/comments/fuzzy keyed module.separator.identifier ("fuzzy": not translated yet)

Parameters

list<string> $only_modules only these modules (all if empty)

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

                                                                                                    : array
    {
        global $DIC;
 
        $result = ['values' => [], 'comments' => [], 'modules' => [], 'unreadable_modules' => [], 'fuzzy' => []];
        if (!$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return $result;
        }
 
        $separator = $DIC->language()->separator;
        $shipped_files = MigratedLanguageFileSync::findShippedModuleFiles(
            $DIC[LanguageFileDirectoryManager::class],
            ILIAS_ABSOLUTE_PATH,
            $a_lang_key
        );
        foreach ($shipped_files as $module => $shipped_po) {
            $module = (string) $module;
            if ($only_modules !== [] && !in_array($module, $only_modules, true)) {
                continue;
            }
            $result['modules'][] = $module;
            try {
                $entries = MigratedLanguageFileSync::loadShippedModuleEntries($shipped_po, $module);
                foreach (array_keys(MigratedLanguageFileSync::loadShippedFuzzyIdentifiers($shipped_po, $module)) as $identifier) {
                    $result['fuzzy'][] = $module . $separator . $identifier;
                }
            } catch (\Throwable $t) {
                $DIC->logger()->forComponent('lang')->warning(sprintf(
                    'Could not read the shipped PO file of module "%s", language "%s": %s',
                    $module,
                    $a_lang_key,
                    $t->getMessage()
                ));
                $result['unreadable_modules'][] = $module;
                continue;
            }
            foreach ($entries as $identifier => $entry) {
                $key = $module . $separator . $identifier;
                $result['values'][$key] = $entry['value'];
                if ($entry['comment'] !== null) {
                    $result['comments'][$key] = $entry['comment'];
                }
            }
        }
 
        return $result;
    }

References $DIC, and $module.

Referenced by _getShippedMigratedComments(), and shippedMigratedModules().

Here is the caller graph for this function:

◆ requestedLocalRemark()

static ilObjLanguageExt::requestedLocalRemark	(	string	$requested,
		string	$stored,
		string	$note
	)

staticprivate

The shipped note itself is no local remark (''), an empty remark removes the local one; a shipped note cannot be hidden locally.

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

                                                                                                 : string
    {
        if ($requested === $stored) {
            return $stored;
        }
 
        // remarks are saved cut to 250 characters (see normalizedRemarks()), a longer note too
        return $note !== '' && ($requested === $note || $requested === mb_substr($note, 0, 250)) ? '' : $requested;
    }

◆ saveValues()

static ilObjLanguageExt::saveValues	(	string	$a_lang_key,
		array	$a_values,
		array	$a_remarks,
		bool	$merge_onto_current_content
	)

staticprivate

With $merge_onto_current_content false the saved entries are each module's complete new content ("delete"-mode import).

Returns: array{unwritten: list<string>, remarks: array<string, array<string, string>>} unwritten: see _saveValues(); remarks: the non-empty remarks written into the overlays

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

     : array {
        global $DIC;
        $lng = $DIC->language();
 
        $save_array = [];
        $save_date = (new DateTimeImmutable('now', new DateTimeZone('UTC')))
            ->format('Y-m-d H:i:s');
        $a_remarks = self::normalizedRemarks($a_remarks);
 
        // shipped values for the comparison; an unreadable .po keeps its .lang lines (see getShippedValues())
        $shipped_migrated = self::readShippedMigratedModules($a_lang_key);
        $a_values = self::withPluralFormKeys($a_values, $shipped_migrated, $lng->separator);
        $a_remarks = self::withPluralFormKeys($a_remarks, $shipped_migrated, $lng->separator);
        $skipped_modules = [];
        if ($merge_onto_current_content) {
            $a_values = self::withoutUnreadableModules($a_lang_key, $a_values, $lng->separator, $skipped_modules);
            $a_remarks = self::withoutUnreadableModules($a_lang_key, $a_remarks, $lng->separator, $skipped_modules);
        }
        [$file_values, $file_comments] = self::shippedValuesAndComments(
            ilLanguageFile::_getGlobalLanguageFile($a_lang_key),
            $shipped_migrated
        );
        // a "delete"-mode import wiped lng_data: every entry is written anew, else an entry equal to the still
        // existing files/overlay of a PO module would not be written and miss in lng_data
        $db_values = $merge_onto_current_content ? self::_getValues($a_lang_key) : [];
        $db_comments = $merge_onto_current_content ? self::_getRemarks($a_lang_key) : [];
        $global_values = array_merge($db_values, $file_values);
        $global_comments = array_merge($db_comments, $file_comments);
 
        // the forms of a plural message have no lng_data row of their own: the message's row is written once, see below
        $plural_rows = [];
        $plural_changed = [];
        $plural_remarks = [];
        // module => identifier => remark ('' removes it) to be written into the overlay
        $remark_changes = [];
        $shipped_by_module = [];
 
        // 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;
            if (in_array($module, $shipped_migrated['modules'], true)) {
                $shipped_by_module[$module] ??= self::shippedModuleValues($shipped_migrated, $module, $lng->separator);
                // written as the overlay keeps it (e.g. an empty value resets to the shipped one), so lng_data does not diverge
                $value = MigratedLanguageFileSync::resolveLocalValue($shipped_migrated['values'][$key] ?? null, (string) $value);
                $plural_identifier = MigratedLanguageFileSync::pluralMessageOf(
                    $topic,
                    $shipped_by_module[$module]
                );
                if ($plural_identifier !== null) {
                    if (PluralFormKey::parse($topic) !== null && !array_key_exists($topic, $shipped_by_module[$module])) {
                        // a form the shipped message does not have would only be an orphan
                        continue;
                    }
                    $save_array[$module][$topic] = $value;
                    if (($db_values[$key] ?? null) !== $value) {
                        $plural_changed[$module][$plural_identifier] = true;
                    }
                    // remarks belong to the identifier (no lng_data row per form): the first form whose remark differs wins
                    $stored_remark = (string) ($db_comments[$module . $lng->separator . $plural_identifier] ?? '');
                    $requested_remark = array_key_exists($key, $a_remarks)
                        ? self::requestedLocalRemark((string) $a_remarks[$key], $stored_remark, (string) ($file_comments[$key] ?? ''))
                        : null;
                    if (
                        $requested_remark !== null
                        && $requested_remark !== $stored_remark
                        && !array_key_exists($plural_identifier, $plural_remarks[$module] ?? [])
                    ) {
                        $plural_remarks[$module][$plural_identifier] = $requested_remark;
                    }
                    continue;
                }
            }
            $save_array[$module][$topic] = $value;
            $is_po_module = in_array($module, $shipped_migrated['modules'], true);
            if ($is_po_module && array_key_exists($key, $a_remarks)) {
                // the remark shown may be the shipped note (see getEffectiveRemarks()); only a local remark is stored
                $a_remarks[$key] = self::requestedLocalRemark(
                    (string) $a_remarks[$key],
                    (string) ($db_comments[$key] ?? ''),
                    (string) ($file_comments[$key] ?? '')
                );
            }
 
            $is_remark_changed = $is_po_module
                && array_key_exists($key, $a_remarks)
                && (string) $a_remarks[$key] !== (string) ($db_comments[$key] ?? '');
            if ($is_remark_changed) {
                $remark_changes[$module][$topic] = (string) $a_remarks[$key];
            }
 
            // PO module: the shipped note is not shown, comparing with it would flag every entry with a note
            $are_comments_set = !$is_po_module && array_key_exists($key, $global_comments) && array_key_exists($key, $a_remarks);
            $is_comment_changed = $are_comments_set ? $global_comments[$key] != $a_remarks[$key] : $are_comments_set;
            $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 && !$is_comment_changed && $is_remark_changed) {
                self::updateRemark($module, $topic, $a_lang_key, (string) $a_remarks[$key]);
            } elseif ($are_changes_made || $is_comment_changed) {
                if ($is_po_module) {
                    // a local change exactly if the value differs from the shipped one (like writePluralRows())
                    $local_change = !isset($file_values[$key]) || (string) $file_values[$key] !== (string) $value
                        ? $save_date
                        : null;
                } else {
                    $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,
                    // the value as the build serves it, see MigratedLanguageFileSync::databaseValues()
                    $is_po_module
                        ? MigratedLanguageFileSync::databaseValues([$key => $value], $shipped_migrated['values'])[$key]
                        : $value,
                    $local_change,
                    // PO module: without a requested remark the stored one stays, as in its overlay
                    $a_remarks[$key] ?? ($is_po_module ? ($db_comments[$key] ?? null) : null)
                );
            }
        }
 
        // the row of a plural message is written if a form's value or the remark changed
        foreach (array_keys($plural_changed + $plural_remarks) as $module) {
            $identifiers = array_keys(($plural_changed[$module] ?? []) + ($plural_remarks[$module] ?? []));
            foreach ($identifiers as $plural_identifier) {
                $remark = array_key_exists($plural_identifier, $plural_remarks[$module] ?? [])
                    ? $plural_remarks[$module][$plural_identifier]
                    : ($db_comments[$module . $lng->separator . $plural_identifier] ?? null);
                $plural_rows[$module][$plural_identifier] = $remark === '' ? null : $remark;
                if (array_key_exists($plural_identifier, $plural_remarks[$module] ?? [])) {
                    $remark_changes[$module][$plural_identifier] = $plural_remarks[$module][$plural_identifier];
                }
            }
        }
 
        $remarks = array_filter(array_map(
            static fn(array $changes): array => array_filter($changes, static fn(string $remark): bool => $remark !== ''),
            $remark_changes
        ));
 
        // save the serialized module entries in lng_modules
        $modules_with_unwritten_overlay = $skipped_modules;
        foreach ($save_array as $module => $entries) {
            $module = (string) $module;
            $module_plural_rows = $plural_rows[$module] ?? [];
            $shipped_module_values = $shipped_by_module[$module] ?? [];
            $module_remark_changes = $remark_changes[$module] ?? [];
            // Read and written under the overlay lock, so a concurrent write in between is not lost
            $written = self::withModuleLock(
                $a_lang_key,
                $module,
                static function () use ($a_lang_key, $module, $entries, $merge_onto_current_content, $module_plural_rows, $shipped_module_values, $save_date, $module_remark_changes): bool {
                    // without a current content the entries are written as they are; replaceLangModule() creates the row
                    $current = $merge_onto_current_content ? self::currentModuleContent($a_lang_key, $module) : [];
                    if ($current === null) {
                        return false;
                    }
                    $content = array_merge($current, $entries);
                    $written = ilObjLanguage::replaceLangModule($a_lang_key, $module, $content);
                    self::writePluralRows($a_lang_key, $module, $content, $shipped_module_values, $module_plural_rows, $save_date);
                    return self::setOverlayRemarks($a_lang_key, $module, $module_remark_changes) && $written;
                }
            );
            if (!$written) {
                $modules_with_unwritten_overlay[] = $module;
            }
        }
 
        ilCachedLanguage::getInstance($a_lang_key)->flush();
 
        return ['unwritten' => $modules_with_unwritten_overlay, 'remarks' => $remarks];
    }

◆ setLocal()

ilObjLanguageExt::setLocal ( bool $a_local = true )

Set the local status of the language.

$a_local local status (true/false)

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

                                                  : void
    {
        if ($this->isInstalled()) {
            if ($a_local) {
                $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:

◆ setOverlayRemarks()

static ilObjLanguageExt::setOverlayRemarks	(	string	$a_lang_key,
		string	$module,
		array	$changes
	)

staticprivate

Writes $changes (identifier => remark, '' removes it) into the overlay; false if that failed (logged), lng_data holds them regardless.

Parameters

array<string,string> $changes

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

                                                                                                 : bool
    {
        global $DIC;
 
        if ($changes === [] || !$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return true;
        }
        try {
            MigratedLanguageFileSync::setRemarks(
                $DIC[LanguageFileDirectoryManager::class],
                $a_lang_key,
                $module,
                $changes,
                MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH),
                ILIAS_ABSOLUTE_PATH
            );
        } catch (\Throwable $t) {
            $DIC->logger()->forComponent('lang')->warning(sprintf(
                'Could not write the remarks of migrated module "%s", language "%s": %s',
                $module,
                $a_lang_key,
                $t->getMessage()
            ));
            return false;
        }
 
        return true;
    }

References $DIC, and $module.

◆ shippedMigratedModules()

ilObjLanguageExt::shippedMigratedModules ( )

private

Returns: array{values: array<string, string>, comments: array<string, string>, modules: list<string>, unreadable_modules: list<string>, fuzzy: list<string>}

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

                                             : array
    {
        return $this->shipped_migrated_modules ??= self::readShippedMigratedModules($this->key);
    }

References readShippedMigratedModules().

Referenced by getEffectiveRemarks(), getModulesMaintainedInPoFiles(), getShippedComments(), getShippedCommentsForDisplay(), getShippedValues(), and getUnreadableShippedPoModules().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shippedModuleValues()

static ilObjLanguageExt::shippedModuleValues	(	array	$shipped_migrated,
		string	$module,
		string	$separator
	)

staticprivate

identifier => value out of the values of readShippedMigratedModules().

Parameters

array{values array<string, string>} $shipped_migrated

Returns: array<string, string>

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

                                                                                                           : array
    {
        $prefix = $module . $separator;
        $values = [];
        foreach ($shipped_migrated['values'] as $key => $value) {
            if (str_starts_with((string) $key, $prefix)) {
                $values[substr((string) $key, strlen($prefix))] = $value;
            }
        }
        return $values;
    }

References $module.

◆ shippedValuesAndComments()

static ilObjLanguageExt::shippedValuesAndComments	(	ilLanguageFile	$global_file,
		array	$shipped
	)

staticprivate

$global_file with every readable module maintained in PO files replaced by its shipped .po, see getShippedValues().

Parameters

array{values array<string, string>, comments: array<string, string>, modules: list<string>, unreadable_modules: list<string>} $shipped

Returns: array{0: array<string, string>, 1: array<string, string>} values, comments

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

                                                                                                 : array
    {
        global $DIC;
 
        $separator = $DIC->language()->separator;
        $replaced_modules = array_values(array_diff($shipped['modules'], $shipped['unreadable_modules']));
 
        return [
            array_merge(self::withoutModules($global_file->getAllValues(), $replaced_modules, $separator), $shipped['values']),
            array_merge(self::withoutModules($global_file->getAllComments(), $replaced_modules, $separator), $shipped['comments']),
        ];
    }

References $DIC, ilLanguageFile\getAllComments(), and ilLanguageFile\getAllValues().

Referenced by findInvalidMarkupOfChangedValues(), getShippedComments(), and getShippedValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ syncMigratedFilesAfterDeleteModeImport()

ilObjLanguageExt::syncMigratedFilesAfterDeleteModeImport	(	array	$modules_before_delete,
		array	$to_save,
		array	$remarks
	)

private

A module that existed before the "delete" wipe but is absent from the imported file is never visited by _saveValues(); its orphaned overlay would keep serving stale values.

Syncs every such module with "replace" semantics. For modules present in $to_save this repeats the sync of replaceLangModule(), which is idempotent.

Parameters

list<string>	$modules_before_delete every module this language had any lng_data row for, captured before the DELETE
array<string,string>	$to_save module.separator.topic => value, the complete final DB content now
array<string,array<string,string>>	$remarks module => identifier => remark, the complete remarks now

Returns: list<string> the modules whose overlay could not be written

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

     : array {
        global $DIC;
 
        if (!$DIC->offsetExists(LanguageFileDirectoryManager::class)) {
            return [];
        }
 
        $entries_by_module = [];
        foreach ($to_save as $key => $value) {
            $parts = explode($this->separator, $key);
            if (count($parts) === 2) {
                $entries_by_module[$parts[0]][$parts[1]] = $value;
            }
        }
 
        $manager = $DIC[LanguageFileDirectoryManager::class];
        $client_data_dir = MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH);
        $failed_modules = [];
        foreach (array_unique(array_merge($modules_before_delete, array_keys($entries_by_module))) as $module) {
            try {
                MigratedLanguageFileSync::sync(
                    $manager,
                    ILIAS_ABSOLUTE_PATH,
                    $this->key,
                    (string) $module,
                    $entries_by_module[$module] ?? [],
                    $client_data_dir,
                    false,
                    null,
                    $remarks[$module] ?? []
                );
            } catch (\Throwable $t) {
                $DIC->logger()->forComponent('lang')->warning(sprintf(
                    'Could not sync migrated language file for module "%s", language "%s" after a' .
                    ' "delete"-mode import: %s',
                    $module,
                    $this->key,
                    $t->getMessage()
                ));
                $failed_modules[] = (string) $module;
            }
        }
 
        return $failed_modules;
    }

◆ updateRemark()

static ilObjLanguageExt::updateRemark	(	string	$module,
		string	$identifier,
		string	$a_lang_key,
		string	$remark
	)

staticprivate

Sets only the remark of an existing lng_data row ('' removes it), like replaceLangEntry() cuts it to 250 characters.

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

                                                                                                                : void
    {
        global $DIC;
        $ilDB = $DIC->database();
 
        $ilDB->manipulate(sprintf(
            "UPDATE lng_data SET remarks = %s WHERE module = %s AND identifier = %s AND lang_key = %s",
            $ilDB->quote($remark === '' ? null : mb_substr($remark, 0, 250), "text"),
            $ilDB->quote($module, "text"),
            $ilDB->quote($identifier, "text"),
            $ilDB->quote($a_lang_key, "text")
        ));
    }

References $DIC, $ilDB, and $module.

◆ withFuzzyMarkers()

static ilObjLanguageExt::withFuzzyMarkers	(	array	$comments,
		array	$shipped
	)

staticprivate

Appends SHIPPED_FUZZY_MARKER_TOPIC to the shipped note of every fuzzy entry.

Parameters

array<string,string>	$comments
array{fuzzy	list<string>} $shipped see readShippedMigratedModules()

Returns: array<string, string>

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

                                                                             : array
    {
        if ($shipped['fuzzy'] === []) {
            return $comments;
        }
        global $DIC;
        $lng = $DIC->language();
        $lng->loadLanguageModule('lng');
        $marker = $lng->txt(self::SHIPPED_FUZZY_MARKER_TOPIC);
        if ($marker === '-' . self::SHIPPED_FUZZY_MARKER_TOPIC . '-' && $lng instanceof ilLanguage) {
            // only shipped in de/en: the default language fills the gap, as before
            $marker = ilLanguage::_lookupEntry($lng->getDefaultLanguage(), 'lng', self::SHIPPED_FUZZY_MARKER_TOPIC);
        }
        foreach ($shipped['fuzzy'] as $key) {
            $comments[$key] = isset($comments[$key]) && $comments[$key] !== ''
                ? $comments[$key] . ' - ' . $marker
                : $marker;
        }
 
        return $comments;
    }

References $comments, $DIC, ilObjLanguage\$key, ilObject\$lng, ilLanguage\_lookupEntry(), ilLanguage\getDefaultLanguage(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Referenced by _getShippedMigratedComments(), and getShippedCommentsForDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withModuleLock()

static ilObjLanguageExt::withModuleLock	(	string	$a_lang_key,
		string	$module,
		\Closure	$callback
	)

staticprivate

See MigratedLanguageFileSync::withOverlayLock().

@template T

Parameters

Closure():T $callback

Returns: T

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

                                                                                                  : mixed
    {
        global $DIC;
 
        return MigratedLanguageFileSync::withOverlayLock(
            $DIC->offsetExists(LanguageFileDirectoryManager::class) ? $DIC[LanguageFileDirectoryManager::class] : null,
            $a_lang_key,
            $module,
            MigratedLanguageFilePaths::resolveClientDataDir(ILIAS_ABSOLUTE_PATH),
            $callback,
            ILIAS_ABSOLUTE_PATH
        );
    }

References $DIC, and $module.

◆ withoutModules()

static ilObjLanguageExt::withoutModules	(	array	$values,
		array	$modules,
		string	$separator
	)

staticprivate

Parameters

array<string,string\|null>	$values module.separator.identifier => value
list<string>	$modules

Returns: array<string, string|null> $values without the entries of $modules

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

                                                                                            : array
    {
        if ($modules === []) {
            return $values;
        }
        $excluded = array_flip($modules);
 
        return array_filter(
            $values,
            static fn(int|string $key): bool => !isset($excluded[explode($separator, (string) $key, 2)[0]]),
            ARRAY_FILTER_USE_KEY
        );
    }

Referenced by getShippedChangesSinceBackup().

Here is the caller graph for this function:

◆ withoutUnreadableModules()

static ilObjLanguageExt::withoutUnreadableModules	(	string	$a_lang_key,
		array	$entries,
		string	$separator,
		array &	$skipped_modules
	)

staticprivate

Drops the entries of modules whose content cannot be read (see currentModuleContent()), before anything is written.

Parameters

array<string,mixed>	$entries module.separator.identifier => value or remark
list<string>	$skipped_modules gets the dropped modules

Returns: array<string, mixed>

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

                                                                                                                                    : array
    {
        $modules = [];
        foreach (array_keys($entries) as $key) {
            $keys = explode($separator, (string) $key);
            if (count($keys) === 2) {
                $modules[$keys[0]] = true;
            }
        }
        foreach (array_keys($modules) as $module) {
            $module = (string) $module;
            if (!in_array($module, $skipped_modules, true) && self::currentModuleContent($a_lang_key, $module) === null) {
                $skipped_modules[] = $module;
            }
        }
 
        return array_filter(
            $entries,
            static fn(string|int $key): bool => !in_array(explode($separator, (string) $key)[0], $skipped_modules, true),
            ARRAY_FILTER_USE_KEY
        );
    }

References $module.

◆ withPluralFormKeys()

static ilObjLanguageExt::withPluralFormKeys	(	array	$entries,
		array	$shipped_migrated,
		string	$separator
	)

staticprivate

Replaces the plain identifier of a plural message of a module maintained in PO files by the key of its default form (see MigratedLanguageFileSync::defaultFormKeyOf()), the form its lng_data row stands for.

Where $entries has both, the later one wins. Applied to every input before anything is compared, kept or checked.

Parameters

array<string,mixed>	$entries module.separator.identifier => value or remark
array{values	array<string, string>, modules: list<string>} $shipped_migrated see readShippedMigratedModules()

Returns: array<string, mixed>

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

                                                                                                          : array
    {
        if ($shipped_migrated['modules'] === []) {
            return $entries;
        }
        $shipped_by_module = [];
        $result = [];
        foreach ($entries as $key => $value) {
            $keys = explode($separator, (string) $key);
            if (count($keys) === 2 && in_array($keys[0], $shipped_migrated['modules'], true)) {
                $form_key = MigratedLanguageFileSync::defaultFormKeyOf(
                    $keys[1],
                    $shipped_by_module[$keys[0]] ??= self::shippedModuleValues($shipped_migrated, $keys[0], $separator)
                );
                if ($form_key !== null) {
                    $key = $keys[0] . $separator . $form_key;
                }
            }
            $result[$key] = $value;
        }
 
        return $result;
    }

◆ writeLocalChangesIntoGlobalLanguageFile()

ilObjLanguageExt::writeLocalChangesIntoGlobalLanguageFile ( )

private

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

                                                              : void
    {
        $po_modules = $this->getModulesMaintainedInPoFiles();
        $global_file_obj = $this->getGlobalLanguageFile();
        $global_values = $global_file_obj->getAllValues();
 
        $global_file_obj->setAllValues(array_merge(
            $global_values,
            self::withoutModules(self::_getValues($this->key), $po_modules, $this->separator)
        ));
        $global_file_obj->setAllComments(array_merge(
            $global_file_obj->getAllComments(),
            self::withoutModules(self::_getRemarks($this->key, true), $po_modules, $this->separator)
        ));
        $global_file_obj->keepOriginalLines(array_keys(array_diff_key(
            $global_values,
            self::withoutModules($global_values, $po_modules, $this->separator)
        )));
        $global_file_obj->write();
    }

References getGlobalLanguageFile(), and getModulesMaintainedInPoFiles().

Referenced by mergeLocalChangesIntoGlobalLanguageFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writePluralRows()

static ilObjLanguageExt::writePluralRows	(	string	$a_lang_key,
		string	$module,
		array	$content,
		array	$shipped_values,
		array	$plural_rows,
		string	$save_date
	)

staticprivate

The database holds a plural message only under its identifier, with the value of its default form, marked as local change only if that differs from the shipped default form (a local change of another form lives in the overlay only): after a rollback a later update of the legacy .lang files is not held back by it.

Parameters

array<string,string>	$content
array<string,string>	$shipped_values identifier => shipped value of the module
array<string,?string>	$plural_rows

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

     : void {
        if ($plural_rows === []) {
            return;
        }
        $content = MigratedLanguageFileSync::mapLegacyPluralValues($content, $shipped_values);
        $values = MigratedLanguageFileSync::collapsePluralForms($content, $shipped_values);
        $shipped_defaults = MigratedLanguageFileSync::collapsePluralForms($shipped_values, $shipped_values);
        $database_values = MigratedLanguageFileSync::databaseValues($values, $shipped_defaults);
        foreach ($plural_rows as $identifier => $remarks) {
            if (!isset($database_values[$identifier])) {
                ilObjLanguage::deleteLangEntry($module, (string) $identifier, $a_lang_key);
                continue;
            }
            ilObjLanguage::replaceLangEntry(
                $module,
                (string) $identifier,
                $a_lang_key,
                (string) $database_values[$identifier],
                (string) $values[$identifier] !== (string) ($shipped_defaults[$identifier] ?? '') ? $save_date : null,
                $remarks
            );
        }
    }

Field Documentation

◆ $shipped_migrated_modules

array ilObjLanguageExt::$shipped_migrated_modules = null

private

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

◆ $skipped_duplicate_values

array ilObjLanguageExt::$skipped_duplicate_values = []

private

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

Referenced by getSkippedDuplicateValues().

◆ $skipped_invalid_markup_values

array ilObjLanguageExt::$skipped_invalid_markup_values = []

private

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

Referenced by getSkippedInvalidMarkupValues().

◆ SHIPPED_FUZZY_MARKER_TOPIC

const string ilObjLanguageExt::SHIPPED_FUZZY_MARKER_TOPIC = 'lng_not_translated'

private

Language variable of the admin GUI marker for an entry that is fuzzy (not translated yet) in its shipped .po.

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

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _deleteValues()

◆ _getModules()

◆ _getRemarks()

◆ _getShippedMigratedComments()

◆ _getValues()

◆ _saveValues()

◆ backupShippedPoFiles()

◆ currentModuleContent()

◆ findInvalidMarkupOfChangedValues()

◆ getAddedValues()

◆ getAllRemarks()

◆ getAllValues()

◆ getChangedValues()

◆ getCommentedValues()

◆ getCustLangPath()

◆ getDataPath()

◆ getEffectiveRemarks()

◆ getGlobalLanguageFile()

◆ getLangPath()

◆ getLongDescription()

◆ getMergedRemarks()

◆ getMergedValues()

◆ getModulesMaintainedInPoFiles()

◆ getShippedChangesSinceBackup()

◆ getShippedComments()

◆ getShippedCommentsForDisplay()

◆ getShippedValues()

◆ getSkippedDuplicateValues()

◆ getSkippedInvalidMarkupValues()

◆ getUnchangedValues()

◆ getUnreadableShippedPoModules()

◆ hasLocalChangesOutsidePoModules()

◆ isMaintainedInPoFiles()

◆ matchesLikePattern()

◆ mergeIntoDatabase()

◆ mergeLocalChangesIntoGlobalLanguageFile()

◆ mergeLocalChangesIntoShippedPoFiles()

◆ moduleEntriesOf()

◆ normalizedRemarks()

◆ readShippedMigratedModules()

◆ requestedLocalRemark()

◆ saveValues()

◆ setLocal()

◆ setOverlayRemarks()

◆ shippedMigratedModules()

◆ shippedModuleValues()

◆ shippedValuesAndComments()

◆ syncMigratedFilesAfterDeleteModeImport()

◆ updateRemark()

◆ withFuzzyMarkers()

◆ withModuleLock()

◆ withoutModules()

◆ withoutUnreadableModules()

◆ withPluralFormKeys()

◆ writeLocalChangesIntoGlobalLanguageFile()

◆ writePluralRows()

Field Documentation

◆ $shipped_migrated_modules

◆ $skipped_duplicate_values

◆ $skipped_invalid_markup_values

◆ SHIPPED_FUZZY_MARKER_TOPIC