Inheritance diagram for ilLanguagesInstalledAndUpdatedObjective:

Collaboration diagram for ilLanguagesInstalledAndUpdatedObjective:

Public Member Functions
	__construct (\ilSetupLanguage $il_setup_language, ?InstallLanguage $install_language=null, ?UpdateLanguage $update_language=null)

	getHash ()
	The directory configuration is part of the hash: with a class-only hash Setup could keep the default-directory instance, which refreshes languages without the component-contributed modules. More...

	getLabel ()
	@inheritDoc More...

	isNotable ()
	@inheritDoc More...

	getPreconditions (Setup\Environment $environment)
	@inheritDoc More...

	achieve (Setup\Environment $environment)
	@inheritDoc More...

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

Public Member Functions inherited from ilLanguageObjective
	__construct ()

Protected Member Functions
	getInstallLanguages ()
	Return installed languages. More...

	informAboutSkippedInvalidMarkupEntries (Setup\Environment $environment)
	Customizing entries with disallowed markup are not applied; the languages are installed regardless. More...

	informAboutSkippedDuplicateEntries (Setup\Environment $environment)
	A warning only: the languages are installed regardless. More...

	informAboutOverlaysOfUnshippedModules (Setup\Environment $environment)

	informAboutUnrecordedTakenOverModules (Setup\Environment $environment)

	informAboutInvalidMarkupInLocalChanges (Setup\Environment $environment, array $language_keys)
	Local changes written before the markup check existed are only reported, never changed: that is the administrator's decision. More...

	informAboutMissingClientDataDirectory (Setup\Environment $environment, array $language_keys)
	Typically during "setup install", before the client directory exists: the overlay of local changes cannot be written, the web serves the shipped values (the build) until the next "setup update". More...

	informAboutUnwritableOverlayDirectories (Setup\Environment $environment, array $language_keys)
	Checked before writing. More...

	informIfNotRunAsClientDataDirectoryOwner (Setup\Environment $environment, array $language_keys=[])
	Writable for Setup is not enough: files created by another user (typically root) cannot be replaced by the web server later. More...

	informAboutUnwrittenOverlays (Setup\Environment $environment, array $language_keys)

	useSetupDatabase (Setup\Environment $environment)
	Must run before anything is read from ilSetupLanguage, so that the language list comes from the Setup database. More...

	useSetupClientDataDir (Setup\Environment $environment)
	Taken from the Setup environment, which knows it before ilias.ini.php is written; otherwise ilSetupLanguage falls back to ilias.ini.php. More...

	inform (Setup\Environment $environment, string $message)

	installLanguages (array $language_keys)
	Installs missing languages and refreshes installed ones on every run, so that changed language files take effect. More...

Protected Attributes
ilSetupLanguage	$il_setup_language

InstallLanguage	$install_language

UpdateLanguage	$update_language

Private Attributes
array	$install_languages = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLanguagesInstalledAndUpdatedObjective::__construct	(	\ilSetupLanguage	$il_setup_language,
		?InstallLanguage	$install_language = `null`,
		?UpdateLanguage	$update_language = `null`
	)

Parameters

InstallLanguage \| null	$install_language	null only for callers constructed deep inside the Setup tree (plugin objectives); a Setup-only instance is then built here instead of reading $GLOBALS['DIC']
UpdateLanguage \| null	$update_language	see $install_language

Definition at line 42 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

      {
        $this->il_setup_language = $il_setup_language;
        $this->install_language = $install_language ?? InstallLanguage::forSetup($il_setup_language);
        $this->update_language = $update_language ?? UpdateLanguage::forSetup($il_setup_language);
    }

References $il_setup_language, $install_language, and $update_language.

Member Function Documentation

◆ achieve()

ilLanguagesInstalledAndUpdatedObjective::achieve ( Setup\Environment $environment )

@inheritDoc

Definition at line 123 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                           : Setup\Environment
    {
        // Must come first: getInstallLanguages() reads from the database too.
        $this->useSetupDatabase($environment);
        $this->useSetupClientDataDir($environment);
 
        $language_keys = [];
        $invalid_language_keys = [];
        foreach ($this->getInstallLanguages() as $language_key) {
            if ($this->il_setup_language->checkLanguageForInstallation($language_key)) {
                $language_keys[] = $language_key;
            } else {
                $invalid_language_keys[] = $language_key;
            }
        }
        if ($invalid_language_keys !== []) {
            // an invalid language file only skips that language, the Setup run goes on
            $this->inform(
                $environment,
                'Skipped languages with invalid language files (left unchanged): '
                . implode(', ', $invalid_language_keys)
            );
        }
 
        $this->informAboutMissingClientDataDirectory($environment, $language_keys);
        $this->informAboutUnwritableOverlayDirectories($environment, $language_keys);
        $this->informAboutUnwrittenOverlays($environment, $this->installLanguages($language_keys));
        $this->informAboutSkippedInvalidMarkupEntries($environment);
        $this->informAboutSkippedDuplicateEntries($environment);
        foreach ($this->il_setup_language->getSkippedUnreadableOverlays() as $language_key => $modules) {
            $this->inform($environment, PlainLogText::of(
                'WARNING: The overlay (local changes) of language ' . $language_key . ' cannot be read for the modules '
                . implode(', ', $modules) . ': they were left unchanged, their local changes are only served again '
                . 'once the overlay below <client data dir>/lang is repaired. Until then their rollback copy in '
                . 'lng_data/lng_modules is incomplete.'
            ));
        }
        $this->informAboutOverlaysOfUnshippedModules($environment);
        $this->informAboutUnrecordedTakenOverModules($environment);
        $this->informAboutInvalidMarkupInLocalChanges($environment, $language_keys);
 
        return $environment;
    }

References getInstallLanguages(), inform(), informAboutInvalidMarkupInLocalChanges(), informAboutMissingClientDataDirectory(), informAboutOverlaysOfUnshippedModules(), informAboutSkippedDuplicateEntries(), informAboutSkippedInvalidMarkupEntries(), informAboutUnrecordedTakenOverModules(), informAboutUnwritableOverlayDirectories(), informAboutUnwrittenOverlays(), installLanguages(), useSetupClientDataDir(), and useSetupDatabase().

Here is the call graph for this function:

◆ getHash()

ilLanguagesInstalledAndUpdatedObjective::getHash ( )

The directory configuration is part of the hash: with a class-only hash Setup could keep the default-directory instance, which refreshes languages without the component-contributed modules.

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

                             : string
    {
        $directories = [];
        foreach ($this->il_setup_language->getLanguageFileDirectoryManager()->getAllDirectories() as $directory) {
            $directories[] = implode('|', [
                $directory::class,
                $directory->getPrefix(),
                $directory->getPath(),
                $directory->getSuffix(),
            ]);
        }
 
        return hash("sha256", implode("\n", [
            self::class,
            $this->il_setup_language->usesDefaultLanguageFileDirectories() ? 'default-directories' : 'configured-directories',
            ...$directories,
        ]));
    }

◆ getInstallLanguages()

ilLanguagesInstalledAndUpdatedObjective::getInstallLanguages ( )

protected

Return installed languages.

Definition at line 78 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                            : array
    {
        return $this->install_languages ??= $this->il_setup_language->getInstalledLanguages() ?: ['en'];
    }

Referenced by achieve(), and isApplicable().

Here is the caller graph for this function:

◆ getLabel()

ilLanguagesInstalledAndUpdatedObjective::getLabel ( )

@inheritDoc

Definition at line 86 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                              : string
    {
        // No database access here: the Setup CLI calls this before achieve().
        if ($this->install_languages === null) {
            return "Install/Update languages";
        }
        return "Install/Update languages " . implode(", ", $this->install_languages);
    }

◆ getPreconditions()

ilLanguagesInstalledAndUpdatedObjective::getPreconditions ( Setup\Environment $environment )

@inheritDoc

Definition at line 106 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                    : array
    {
        $preconditions = [new ilDatabaseInitializedObjective()];
        // with the default directories the build would serve no module at all
        if (!$this->il_setup_language->usesDefaultLanguageFileDirectories()) {
            $preconditions[] = new ShippedLanguageFilesCompiledObjective(
                $this->il_setup_language->getLanguageFileDirectoryManager(),
                dirname(__DIR__, 5)
            );
        }
 
        return $preconditions;
    }

◆ inform()

ilLanguagesInstalledAndUpdatedObjective::inform	(	Setup\Environment	$environment,
		string	$message
	)

protected

Definition at line 464 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                              : void
    {
        $io = $environment->getResource(Setup\Environment::RESOURCE_ADMIN_INTERACTION);
        if ($io instanceof Setup\AdminInteraction) {
            $io->inform($message);
            return;
        }
        error_log($message);
    }

References $message.

Referenced by achieve(), informAboutInvalidMarkupInLocalChanges(), informAboutMissingClientDataDirectory(), informAboutOverlaysOfUnshippedModules(), informAboutSkippedDuplicateEntries(), informAboutSkippedInvalidMarkupEntries(), informAboutUnrecordedTakenOverModules(), informAboutUnwritableOverlayDirectories(), informAboutUnwrittenOverlays(), and informIfNotRunAsClientDataDirectoryOwner().

Here is the caller graph for this function:

◆ informAboutInvalidMarkupInLocalChanges()

ilLanguagesInstalledAndUpdatedObjective::informAboutInvalidMarkupInLocalChanges	(	Setup\Environment	$environment,
		array	$language_keys
	)

protected

Local changes written before the markup check existed are only reported, never changed: that is the administrator's decision.

Parameters

list<string> $language_keys

Definition at line 231 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                                                                   : void
    {
        $policy = new TranslationMarkupPolicy();
        $manager = $this->il_setup_language->getLanguageFileDirectoryManager();
        $client_data_dir = $this->il_setup_language->getClientDataDir();
        foreach ($language_keys as $language_key) {
            $values = [];
            try {
                // a module with an overlay, or whose lng_data was taken over, is checked in its overlay only
                $overlay_only = array_fill_keys(MigratedLanguageFileSync::modulesWithLocalChangesTakenOver($client_data_dir, $language_key), true);
                foreach ($manager->getDirectories() as $directory) {
                    $module = $directory->getPrefix();
                    if (MigratedLanguageFileSync::hasOverlay($manager, $language_key, $module, $client_data_dir)) {
                        $overlay_only[$module] = true;
                    }
                    foreach (MigratedLanguageFileSync::loadLocalChanges($manager, $language_key, $module, $client_data_dir) ?? [] as $identifier => $entry) {
                        $values[$module . '#:#' . $identifier] = $entry['value'];
                    }
                }
                foreach ($this->il_setup_language->getLocalChanges($language_key) as $module => $entries) {
                    if (isset($overlay_only[$module])) {
                        continue;
                    }
                    foreach ($entries as $identifier => $value) {
                        $values[$module . '#:#' . $identifier] ??= (string) $value;
                    }
                }
            } catch (\Throwable $t) {
                error_log(PlainLogText::of(sprintf(
                    'Could not check the local changes of language "%s" for markup: %s',
                    $language_key,
                    $t->getMessage()
                )));
                continue;
            }
 
            $keys = array_map('strval', array_keys($policy->findInvalidValues($values)));
            if ($keys === []) {
                continue;
            }
            error_log(PlainLogText::of(sprintf(
                'Local changes of language "%s" contain markup that is not allowed: %s',
                $language_key,
                implode(', ', $keys)
            )));
            $this->inform(
                $environment,
                PlainLogText::of(
                    'WARNING: Local changes of language ' . $language_key . ' contain HTML that is not allowed '
                    . 'in language texts (left unchanged - please correct them in the administration): '
                    . PlainLogText::keyList($keys)
                )
            );
        }
    }

References $module, $policy, and inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutMissingClientDataDirectory()

ilLanguagesInstalledAndUpdatedObjective::informAboutMissingClientDataDirectory	(	Setup\Environment	$environment,
		array	$language_keys
	)

protected

Typically during "setup install", before the client directory exists: the overlay of local changes cannot be written, the web serves the shipped values (the build) until the next "setup update".

Parameters

list<string> $language_keys

Definition at line 293 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                                                                  : void
    {
        if (
            $language_keys === []
            || $this->il_setup_language->getClientDataDir() !== null
            || !$this->il_setup_language->hasMigratedModules($language_keys)
        ) {
            return;
        }
 
        $this->inform(
            $environment,
            'WARNING: The client data directory is not known or does not exist yet, so the local changes '
            . '(e.g. lang/*.lang.local) of modules maintained in PO files are not written to their overlay in '
            . 'this run - these modules show their shipped texts without local changes until then. Run "setup '
            . 'update" (as the web server user) once the client data directory exists.'
        );
    }

References inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutOverlaysOfUnshippedModules()

ilLanguagesInstalledAndUpdatedObjective::informAboutOverlaysOfUnshippedModules ( Setup\Environment $environment )

protected

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

                                                                                            : void
    {
        foreach ($this->il_setup_language->getOverlaysOfUnshippedModules() as $language_key => $modules) {
            $this->inform($environment, PlainLogText::of(
                'WARNING: The modules ' . implode(', ', $modules) . ' have no shipped .po for language '
                . $language_key . ', but an overlay below <client data dir>/lang or an entry in <client data '
                . 'dir>/lang/taken-over.' . $language_key . '.json. Remove the overlay directory <client data '
                . 'dir>/lang/<module>/' . $language_key . ' and the entry before the module is shipped again (or '
                . 'if it no longer exists) - otherwise they win over the local changes in lng_data.'
            ));
        }
    }

References inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutSkippedDuplicateEntries()

ilLanguagesInstalledAndUpdatedObjective::informAboutSkippedDuplicateEntries ( Setup\Environment $environment )

protected

A warning only: the languages are installed regardless.

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

                                                                                         : void
    {
        foreach ($this->il_setup_language->getSkippedDuplicateEntries() as $language_key => $entries) {
            $this->inform(
                $environment,
                PlainLogText::of(
                    'WARNING: Customizing entries of language ' . $language_key . ' were not applied, their '
                    . 'identifier already exists in another module or in another spelling: '
                    . PlainLogText::keyList(array_map('strval', array_keys($entries)))
                )
            );
        }
    }

References inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutSkippedInvalidMarkupEntries()

ilLanguagesInstalledAndUpdatedObjective::informAboutSkippedInvalidMarkupEntries ( Setup\Environment $environment )

protected

Customizing entries with disallowed markup are not applied; the languages are installed regardless.

Definition at line 170 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                                             : void
    {
        foreach ($this->il_setup_language->getSkippedInvalidMarkupEntries() as $language_key => $entries) {
            $this->inform(
                $environment,
                PlainLogText::of(
                    'WARNING: Customizing entries of language ' . $language_key . ' were not applied, their '
                    . 'value contains HTML that is not allowed in language texts: '
                    . PlainLogText::keyList(array_map('strval', array_keys($entries)))
                )
            );
        }
    }

References inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutUnrecordedTakenOverModules()

ilLanguagesInstalledAndUpdatedObjective::informAboutUnrecordedTakenOverModules ( Setup\Environment $environment )

protected

Definition at line 212 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                                            : void
    {
        foreach ($this->il_setup_language->getUnrecordedTakenOverModules() as $language_key => $modules) {
            $this->inform($environment, PlainLogText::of(
                'WARNING: Could not record in <client data dir>/lang/taken-over.' . $language_key . '.json that the '
                . 'local changes of language ' . $language_key . ' in lng_data were taken over for the modules '
                . implode(', ', $modules) . ' (see the PHP error log for details). They are taken over again by the '
                . 'next "setup update" - <client data dir>/lang (including .locks and the record file) must be '
                . 'writable for the user running Setup.'
            ));
        }
    }

References inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutUnwritableOverlayDirectories()

ilLanguagesInstalledAndUpdatedObjective::informAboutUnwritableOverlayDirectories	(	Setup\Environment	$environment,
		array	$language_keys
	)

protected

Checked before writing.

Does not abort: the database is written regardless, the files are repaired by the next run with sufficient permissions.

Parameters

list<string> $language_keys

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

                                                                                                                    : void
    {
        $unwritable_directories = $this->il_setup_language->findUnwritableOverlayDirectories($language_keys);
        if ($unwritable_directories !== []) {
            $this->inform(
                $environment,
                'WARNING: The PO/MO language files of modules maintained in PO files cannot be written to '
                . implode(', ', $unwritable_directories) . ' (not writable, or a file occupies the '
                . 'directory\'s place). The languages are still installed/updated in the database, but these '
                . 'modules keep showing outdated texts. Setup must be run as the web server user (the owner '
                . 'of the client data directory) - re-run "setup update" as that user to repair the files.'
            );
        }
 
        $this->informIfNotRunAsClientDataDirectoryOwner($environment, $language_keys);
    }

References inform(), and informIfNotRunAsClientDataDirectoryOwner().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informAboutUnwrittenOverlays()

ilLanguagesInstalledAndUpdatedObjective::informAboutUnwrittenOverlays	(	Setup\Environment	$environment,
		array	$language_keys
	)

protected

Parameters

list<string> $language_keys languages whose PO/MO overlay could not be written

Definition at line 405 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                                                         : void
    {
        if ($language_keys === []) {
            return;
        }
 
        $this->inform(
            $environment,
            'WARNING: The PO/MO language files of modules maintained in PO files could not be written for '
            . 'the languages ' . implode(', ', $language_keys) . ' (see the PHP error log for details). '
            . 'Setup must be run as the web server user - re-run "setup update" as that user.'
        );
    }

References inform().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ informIfNotRunAsClientDataDirectoryOwner()

ilLanguagesInstalledAndUpdatedObjective::informIfNotRunAsClientDataDirectoryOwner	(	Setup\Environment	$environment,
		array	$language_keys = `[]`
	)

protected

Writable for Setup is not enough: files created by another user (typically root) cannot be replaced by the web server later.

The owner of the client data directory counts as web server user.

Parameters

list<string> $language_keys

Definition at line 341 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                                                                          : void
    {
        $client_data_dir = $this->il_setup_language->getClientDataDir();
        if ($client_data_dir === null || !function_exists('posix_geteuid')) {
            return;
        }
        $owner = @fileowner($client_data_dir);
        $current_user = posix_geteuid();
        if ($owner === false || ($owner === $current_user && $current_user !== 0)) {
            return;
        }
        if (!$this->il_setup_language->hasMigratedModules($language_keys)) {
            return;
        }
 
        $overlay_root = rtrim($client_data_dir, '/') . '/lang';
        if ($owner === 0) {
            $this->inform(
                $environment,
                sprintf(
                    'WARNING: Setup runs as user id %d, and the client data directory %s belongs to root. '
                    . 'Running Setup as root is not supported: the web server cannot replace the PO/MO '
                    . 'language files and directories of modules maintained in PO files that this run '
                    . 'creates. Fix: run "chown -R <web server user> %s" after this run, and run Setup '
                    . 'as the web server user from now on.',
                    $current_user,
                    $client_data_dir,
                    $overlay_root
                )
            );
            return;
        }
 
        $owner_info = function_exists('posix_getpwuid') ? @posix_getpwuid($owner) : false;
        $owner_name = is_array($owner_info) ? (string) $owner_info['name'] : (string) $owner;
        $unwritable_for_owner = $this->il_setup_language->findUnwritableOverlayDirectories($language_keys, $owner);
 
        $this->inform(
            $environment,
            sprintf(
                'WARNING: Setup runs as user id %d, but the client data directory %s belongs to user id %d. '
                . 'Running Setup as another user than the web server user (the owner of the client data '
                . 'directory) is not supported%s: the PO/MO language files and directories of modules '
                . 'maintained in PO files that this run creates belong to user id %d and cannot be '
                . 'replaced by the web server later on.%s Fix: run "chown -R %s %s" after this run, and '
                . 'run Setup as user %s from now on.',
                $current_user,
                $client_data_dir,
                $owner,
                $current_user === 0 ? ' (this includes root)' : '',
                $current_user,
                $unwritable_for_owner === []
                    ? ''
                    : ' Already not writable for user id ' . $owner . ': ' . implode(', ', $unwritable_for_owner) . '.',
                $owner_name,
                $overlay_root,
                $owner_name
            )
        );
    }

References inform().

Referenced by informAboutUnwritableOverlayDirectories().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ installLanguages()

ilLanguagesInstalledAndUpdatedObjective::installLanguages ( array $language_keys )

protected

Installs missing languages and refreshes installed ones on every run, so that changed language files take effect.

Both Activities get the full list and ignore keys that do not apply to them; UpdateLanguage also runs on just-installed keys, which is harmless.

An instance with only the default directories never refreshes: that would delete the lng_data rows of component-contributed modules.

Parameters

list<string> $language_keys

Returns: list<string> the languages whose PO/MO overlay could not be written (see InstallLanguage/UpdateLanguage, "overlay_write_failed_language_keys")

Definition at line 487 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                             : array
    {
        if ($language_keys === []) {
            return [];
        }
 
        $install_result = $this->install_language->perform([
            'language_keys' => $language_keys,
            'mode' => InstallLanguage::MODE_INSTALL,
        ]);
        $overlay_write_failed = $install_result['overlay_write_failed_language_keys'] ?? [];
 
        if (!$this->il_setup_language->usesDefaultLanguageFileDirectories()) {
            $update_result = $this->update_language->perform([
                'language_keys' => $language_keys,
            ]);
            $overlay_write_failed = array_merge(
                $overlay_write_failed,
                $update_result['overlay_write_failed_language_keys'] ?? []
            );
        }
 
        return array_values(array_unique($overlay_write_failed));
    }

Referenced by achieve().

Here is the caller graph for this function:

◆ isApplicable()

ilLanguagesInstalledAndUpdatedObjective::isApplicable ( Setup\Environment $environment )

@inheritDoc

Definition at line 422 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                : bool
    {
        // getLabel() is shown between isApplicable() and achieve() and lists the languages.
        if ($environment->getResource(Setup\Environment::RESOURCE_DATABASE) instanceof \ilDBInterface) {
            $this->useSetupDatabase($environment);
            $this->getInstallLanguages();
        }
 
        return true;
    }

References getInstallLanguages(), and useSetupDatabase().

Here is the call graph for this function:

◆ isNotable()

ilLanguagesInstalledAndUpdatedObjective::isNotable ( )

@inheritDoc

Definition at line 98 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                               : bool
    {
        return true;
    }

◆ useSetupClientDataDir()

ilLanguagesInstalledAndUpdatedObjective::useSetupClientDataDir ( Setup\Environment $environment )

protected

Taken from the Setup environment, which knows it before ilias.ini.php is written; otherwise ilSetupLanguage falls back to ilias.ini.php.

Definition at line 447 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                            : void
    {
        $ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);
        $client_id = $environment->getResource(Setup\Environment::RESOURCE_CLIENT_ID);
        if (!$ini instanceof ilIniFile || $client_id === null) {
            return;
        }
 
        $client_data_dir = \ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths::fromDataDirAndClientId(
            (string) $ini->readVariable('clients', 'datadir'),
            (string) $client_id
        );
        if ($client_data_dir !== null) {
            $this->il_setup_language->setClientDataDir($client_data_dir);
        }
    }

References $client_id, and ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\fromDataDirAndClientId().

Referenced by achieve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ useSetupDatabase()

ilLanguagesInstalledAndUpdatedObjective::useSetupDatabase ( Setup\Environment $environment )

protected

Must run before anything is read from ilSetupLanguage, so that the language list comes from the Setup database.

Definition at line 436 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

                                                                       : void
    {
        $this->il_setup_language->setDbHandler(
            $environment->getResource(Setup\Environment::RESOURCE_DATABASE)
        );
    }

Referenced by achieve(), and isApplicable().

Here is the caller graph for this function:

Field Documentation

◆ $il_setup_language

ilSetupLanguage ilLanguagesInstalledAndUpdatedObjective::$il_setup_language

protected

Definition at line 31 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

Referenced by __construct().

◆ $install_language

InstallLanguage ilLanguagesInstalledAndUpdatedObjective::$install_language

protected

Definition at line 32 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

Referenced by __construct().

◆ $install_languages

array ilLanguagesInstalledAndUpdatedObjective::$install_languages = null

private

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

◆ $update_language

UpdateLanguage ilLanguagesInstalledAndUpdatedObjective::$update_language

protected

Definition at line 33 of file class.ilLanguagesInstalledAndUpdatedObjective.php.

Referenced by __construct().

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

components/ILIAS/Language/classes/Setup/class.ilLanguagesInstalledAndUpdatedObjective.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ achieve()

◆ getHash()

◆ getInstallLanguages()

◆ getLabel()

◆ getPreconditions()

◆ inform()

◆ informAboutInvalidMarkupInLocalChanges()

◆ informAboutMissingClientDataDirectory()

◆ informAboutOverlaysOfUnshippedModules()

◆ informAboutSkippedDuplicateEntries()

◆ informAboutSkippedInvalidMarkupEntries()

◆ informAboutUnrecordedTakenOverModules()

◆ informAboutUnwritableOverlayDirectories()

◆ informAboutUnwrittenOverlays()

◆ informIfNotRunAsClientDataDirectoryOwner()

◆ installLanguages()

◆ isApplicable()

◆ isNotable()

◆ useSetupClientDataDir()

◆ useSetupDatabase()

Field Documentation

◆ $il_setup_language

◆ $install_language

◆ $install_languages

◆ $update_language