Inheritance diagram for ilSetupLanguageTest:

Collaboration diagram for ilSetupLanguageTest:

Public Member Functions
	testRetrieveLanguageKey ()

	testRetrieveInstalledLanguage ()

	testDatabaseSourcePrecedence (bool $handler, bool $constructor, bool $global, string $winner)

	testFileBasedMethodsWorkWithoutAnyDatabase ()

	testInstallableLanguagesAreTheKeysWithAMainLanguageFile ()

	testDatabaseMethodsWithoutDatabaseThrowLogicException (Closure $call)

	testCheckLanguageWithOnlyMainFile ()

	testCheckLanguageWithBothMainAndComponentFiles ()

	testCheckLanguageWithMissingMainFile ()

	testCheckLanguageFailsOnInvalidComponentLanguageFile ()

	testCheckLanguageFailsOnNonUtf8Value ()

	testGetInvalidLocalLanguageFilesReturnsEmptyForValidFile ()

	testGetInvalidLocalLanguageFilesIgnoresMissingFile ()

	testGetInvalidLocalLanguageFilesReturnsMalformedFileName ()

	testRegisterInstalledLanguageInsertsUnknownLanguage ()

	testRegisterInstalledLanguageInsertsAsInstalledLocalWhenLocalFileIsPresent ()

	testRegisterInstalledLanguageUpdatesKnownLanguage ()

	testWithoutInjectedDirectoriesOnlyTheDefaultDirectoriesAreUsed ()

	testAnInjectedDirectoryManagerIsUsedAndReported ()
	The flag says who built the instance (component graph vs. More...

	testOverlaysOfUnshippedModulesAreOnlyReportedWithContributedDirectories ()

	testNothingIsReportedBeforeAManagerExists ()

	testSetClientDataDirOverridesTheResolutionUntilResetWithNull ()
	setClientDataDir() overrides the resolution lazily, also after construction; null restores resolveClientDataDir(). More...

	testTheTranslationCacheIsANoOpWithoutGlobalCache ()
	CLI Setup has no global cache: the translation cache must be a silent no-op. More...

	testGetClientDataDirReturnsTheSetDirectoryOrTheDefaultResolution ()

	testFindUnwritableOverlayDirectoriesChecksTheSetClientDataDir ()

Static Public Member Functions
static	databaseSources ()

static	databaseMethods ()

Protected Member Functions
	setUp ()

	tearDown ()

Protected Member Functions inherited from ilLanguageBaseTestCase
	setUp ()

	setGlobalVariable (string $name, $value)

	rbacOf (\ilRbacSystem $system)

	languageFolder (int $ref_id=0)

Private Member Functions
	cleanupTempDir ()

	createMockComponentDirectory (string $path='artifacts/test_lang_component', string $prefix='test')

	createMockCustomizingDirectory ()

	emptyDatabase (bool $expect_query)

	callCheckLanguage (ilSetupLanguage $setup_language, string $lang_key)

	createDatabaseMock ()

	withManagerReporting (ilSetupLanguage $setup_language)

	managerOf (ilSetupLanguage $setup_language)

	resolvedClientDataDir (ilSetupLanguage $setup_language)

Private Attributes
ilSetupLanguage	$newLangSetupDe

ilSetupLanguage	$newLangSetupEs

array	$langInstalled

string	$tempComponentDir = 'artifacts/test_lang_component'

Detailed Description

Class ilSetupLanguageTest.

Definition at line 31 of file ilSetupLanguageTest.php.

Member Function Documentation

◆ callCheckLanguage()

ilSetupLanguageTest::callCheckLanguage	(	ilSetupLanguage	$setup_language,
		string	$lang_key
	)

private

Definition at line 233 of file ilSetupLanguageTest.php.

                                                                                         : bool
    {
        $reflection = new ReflectionMethod($setup_language, 'checkLanguage');
        return $reflection->invoke($setup_language, $lang_key);
    }

◆ cleanupTempDir()

ilSetupLanguageTest::cleanupTempDir ( )

private

Definition at line 56 of file ilSetupLanguageTest.php.

                                     : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        if (is_dir($fullPath)) {
            $files = glob($fullPath . '/*');
            if ($files !== false) {
                foreach ($files as $file) {
                    if (is_file($file)) {
                        unlink($file);
                    }
                }
            }
            rmdir($fullPath);
        }
    }

References $files, and $tempComponentDir.

Referenced by tearDown().

Here is the caller graph for this function:

◆ createDatabaseMock()

ilSetupLanguageTest::createDatabaseMock ( )

private

Definition at line 397 of file ilSetupLanguageTest.php.

                                         : ilDBInterface&MockObject
    {
        $db = $this->createMock(ilDBInterface::class);
        $db->method('nextId')->willReturn(42);
        $db->method('quote')->willReturnCallback(
            static fn(mixed $value): string => "'" . (string) $value . "'"
        );
        $db->method('now')->willReturn('NOW()');
        $db->method('manipulate')->willReturn(1);
 
        return $db;
    }

◆ createMockComponentDirectory()

ilSetupLanguageTest::createMockComponentDirectory	(	string	$path = `'artifacts/test_lang_component'`,
		string	$prefix = `'test'`
	)

private

Definition at line 72 of file ilSetupLanguageTest.php.

     : LanguageFileDirectory {
        return new class ($path, $prefix) implements LanguageFileDirectory {
            public function __construct(private string $path, private string $prefix)
            {
            }
 
            public function getPrefix(): string
            {
                return $this->prefix;
            }
 
            public function getPath(): string
            {
                return $this->path;
            }
 
            public function getSuffix(): string
            {
                return '';
            }
 
            public function isLocal(): bool
            {
                return false;
            }
        };
    }

◆ createMockCustomizingDirectory()

ilSetupLanguageTest::createMockCustomizingDirectory ( )

private

Definition at line 103 of file ilSetupLanguageTest.php.

                                                     : LanguageFileDirectory
    {
        return new class ($this->tempComponentDir) implements LanguageFileDirectory {
            public function __construct(private string $path)
            {
            }
 
            public function getPrefix(): string
            {
                return '';
            }
 
            public function getPath(): string
            {
                return $this->path;
            }
 
            public function getSuffix(): string
            {
                return '.local';
            }
 
            public function isLocal(): bool
            {
                return true;
            }
        };
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

◆ databaseMethods()

static ilSetupLanguageTest::databaseMethods ( )

static

Returns: array<string, array{0: Closure(ilSetupLanguage): mixed}>

Definition at line 217 of file ilSetupLanguageTest.php.

                                            : array
    {
        return [
            'repository' => [static fn(ilSetupLanguage $l): array => $l->getInstalledLanguages()],
            'manager' => [static fn(ilSetupLanguage $l) => $l->insertLanguageForInstallation('en')],
        ];
    }

References ilSetupLanguage\getInstalledLanguages(), and ilSetupLanguage\insertLanguageForInstallation().

Here is the call graph for this function:

◆ databaseSources()

static ilSetupLanguageTest::databaseSources ( )

static

Returns: array<string, array{0: bool, 1: bool, 2: bool, 3: string}> handler, constructor, global, winner

Definition at line 164 of file ilSetupLanguageTest.php.

                                            : array
    {
        return [
            'handler beats constructor and global' => [true, true, true, 'handler'],
            'handler beats constructor' => [true, true, false, 'handler'],
            'handler beats global' => [true, false, true, 'handler'],
            'constructor beats global' => [false, true, true, 'constructor'],
            'only constructor' => [false, true, false, 'constructor'],
            'only global' => [false, false, true, 'global'],
        ];
    }

◆ emptyDatabase()

ilSetupLanguageTest::emptyDatabase ( bool $expect_query )

private

Definition at line 149 of file ilSetupLanguageTest.php.

                                                      : ilDBInterface&\PHPUnit\Framework\MockObject\MockObject
    {
        $db = $this->createMock(ilDBInterface::class);
        $db->method('quote')->willReturn("'x'");
        $db->method('like')->willReturn('1=1');
        $db->method('fetchObject')->willReturn(null);
        $db->expects($expect_query ? self::once() : self::never())->method('query')
            ->willReturn($this->createStub(ilDBStatement::class));
 
        return $db;
    }

◆ managerOf()

ilSetupLanguageTest::managerOf ( ilSetupLanguage $setup_language )

private

Definition at line 510 of file ilSetupLanguageTest.php.

                                                               : \ILIAS\Language\Setup\LanguageInstallationManager
    {
        $setup_language->setDbHandler($this->createStub(ilDBInterface::class));
 
        return (new ReflectionMethod(ilSetupLanguage::class, 'manager'))->invoke($setup_language);
    }

References ilSetupLanguage\setDbHandler().

Here is the call graph for this function:

◆ resolvedClientDataDir()

ilSetupLanguageTest::resolvedClientDataDir ( ilSetupLanguage $setup_language )

private

Definition at line 517 of file ilSetupLanguageTest.php.

                                                                           : ?string
    {
        $manager = $this->managerOf($setup_language);
        $resolver = (new ReflectionProperty(\ILIAS\Language\Setup\LanguageInstallationManager::class, 'client_data_dir_resolver'))
            ->getValue($manager);
 
        return $resolver();
    }

References $resolver, and ILIAS\UI\Implementation\Component\Input\getValue().

Here is the call graph for this function:

◆ setUp()

ilSetupLanguageTest::setUp ( )

protected

Reimplemented from ilLanguageBaseTestCase.

Definition at line 38 of file ilSetupLanguageTest.php.

                              : void
    {
        unset($GLOBALS['ilDB']);
        // per process: two PHPUnit runs at once must not share (and delete) the same directory
        $this->tempComponentDir .= '_' . getmypid();
        $this->newLangSetupDe = new ilSetupLanguage('de');
        $this->newLangSetupEs = new ilSetupLanguage('es');
 
        $this->langInstalled[] = $this->newLangSetupDe;
        $this->langInstalled[] = $this->newLangSetupEs;
    }

References $GLOBALS, $newLangSetupDe, and $newLangSetupEs.

◆ tearDown()

ilSetupLanguageTest::tearDown ( )

protected

Definition at line 50 of file ilSetupLanguageTest.php.

                                 : void
    {
        $this->cleanupTempDir();
        parent::tearDown();
    }

References cleanupTempDir(), and tearDown().

Here is the call graph for this function:

◆ testAnInjectedDirectoryManagerIsUsedAndReported()

ilSetupLanguageTest::testAnInjectedDirectoryManagerIsUsedAndReported ( )

The flag says who built the instance (component graph vs.

plugin Setup objective), so even a manager with only the default directories counts as injected.

Definition at line 472 of file ilSetupLanguageTest.php.

                                                                     : void
    {
        $manager = new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), new MainLanguageFileDirectory());
        $setup_language = new ilSetupLanguage('de', $manager);
 
        $this->assertFalse($setup_language->usesDefaultLanguageFileDirectories());
        $this->assertSame($manager, $setup_language->getLanguageFileDirectoryManager());
    }

◆ testCheckLanguageFailsOnInvalidComponentLanguageFile()

ilSetupLanguageTest::testCheckLanguageFailsOnInvalidComponentLanguageFile ( )

Definition at line 293 of file ilSetupLanguageTest.php.

                                                                          : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        if (!is_dir($fullPath)) {
            mkdir($fullPath, 0777, true);
        }
 
        try {
            file_put_contents($fullPath . '/ilias_en.lang', "invalid content without header\n");
 
            $mockDir = $this->createMockComponentDirectory($this->tempComponentDir, 'test');
            $manager = new LanguageFileDirectoryManager(
                new MainLanguageFileDirectory(),
                $mockDir
            );
            $setup_language = new ilSetupLanguage('en', $manager);
 
            $this->assertFalse($this->callCheckLanguage($setup_language, 'en'));
 
            file_put_contents(
                $fullPath . '/ilias_en.lang',
                "<!-- language file start -->\nonly_one_part\n"
            );
            $this->assertFalse($this->callCheckLanguage($setup_language, 'en'));
        } finally {
            $this->cleanupTempDir();
        }
    }

◆ testCheckLanguageFailsOnNonUtf8Value()

ilSetupLanguageTest::testCheckLanguageFailsOnNonUtf8Value ( )

Definition at line 322 of file ilSetupLanguageTest.php.

                                                          : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        if (!is_dir($fullPath)) {
            mkdir($fullPath, 0777, true);
        }
 
        try {
            file_put_contents(
                $fullPath . '/ilias_en.lang',
                "<!-- language file start -->\n" .
                "test_key#:#" . chr(0xFF) . chr(0xFE) . "\n"
            );
 
            $mockDir = $this->createMockComponentDirectory($this->tempComponentDir, 'test');
            $manager = new LanguageFileDirectoryManager(
                new CustomizingLanguageFileDirectory(),
                new MainLanguageFileDirectory(),
                $mockDir
            );
            $setup_language = new ilSetupLanguage('en', $manager);
 
            $this->assertFalse($this->callCheckLanguage($setup_language, 'en'));
        } finally {
            $this->cleanupTempDir();
        }
    }

◆ testCheckLanguageWithBothMainAndComponentFiles()

ilSetupLanguageTest::testCheckLanguageWithBothMainAndComponentFiles ( )

Definition at line 253 of file ilSetupLanguageTest.php.

                                                                    : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        if (!is_dir($fullPath)) {
            mkdir($fullPath, 0777, true);
        }
 
        try {
            file_put_contents(
                $fullPath . '/ilias_en.lang',
                "<!-- language file start -->\ntest_key#:#test_value\n"
            );
 
            $mockDir = $this->createMockComponentDirectory($this->tempComponentDir, 'test');
            $manager = new LanguageFileDirectoryManager(
                new CustomizingLanguageFileDirectory(),
                new MainLanguageFileDirectory(),
                $mockDir
            );
            $setup_language = new ilSetupLanguage('en', $manager);
 
            $this->assertTrue($this->callCheckLanguage($setup_language, 'en'));
        } finally {
            $this->cleanupTempDir();
        }
    }

◆ testCheckLanguageWithMissingMainFile()

ilSetupLanguageTest::testCheckLanguageWithMissingMainFile ( )

Definition at line 280 of file ilSetupLanguageTest.php.

                                                          : void
    {
        $mockDir = $this->createMockComponentDirectory();
        $manager = new LanguageFileDirectoryManager(
            new CustomizingLanguageFileDirectory(),
            new MainLanguageFileDirectory(),
            $mockDir
        );
        $setup_language = new ilSetupLanguage('xx', $manager);
 
        $this->assertFalse($this->callCheckLanguage($setup_language, 'xx'));
    }

◆ testCheckLanguageWithOnlyMainFile()

ilSetupLanguageTest::testCheckLanguageWithOnlyMainFile ( )

Definition at line 239 of file ilSetupLanguageTest.php.

                                                       : void
    {
        $mockDir = $this->createMockComponentDirectory();
        $manager = new LanguageFileDirectoryManager(
            new CustomizingLanguageFileDirectory(),
            new MainLanguageFileDirectory(),
            $mockDir
        );
        $setup_language = new ilSetupLanguage('en', $manager);
 
        $this->assertTrue($this->callCheckLanguage($setup_language, 'en'));
        $this->assertTrue($this->callCheckLanguage($setup_language, 'de'));
    }

◆ testDatabaseMethodsWithoutDatabaseThrowLogicException()

ilSetupLanguageTest::testDatabaseMethodsWithoutDatabaseThrowLogicException ( Closure $call )

Definition at line 226 of file ilSetupLanguageTest.php.

                                                                                        : void
    {
        $this->expectException(LogicException::class);
 
        $call(new ilSetupLanguage('en'));
    }

◆ testDatabaseSourcePrecedence()

ilSetupLanguageTest::testDatabaseSourcePrecedence	(	bool	$handler,
		bool	$constructor,
		bool	$global,
		string	$winner
	)

Definition at line 177 of file ilSetupLanguageTest.php.

                                                                                                                : void
    {
        $dbs = [];
        foreach (['handler' => $handler, 'constructor' => $constructor, 'global' => $global] as $name => $present) {
            if ($present) {
                $dbs[$name] = $this->emptyDatabase($name === $winner);
            }
        }
        if (isset($dbs['global'])) {
            $GLOBALS['ilDB'] = $dbs['global'];
        }
 
        $setup_language = new ilSetupLanguage('en', null, $dbs['constructor'] ?? null);
        if (isset($dbs['handler'])) {
            $setup_language->setDbHandler($dbs['handler']);
        }
 
        self::assertSame([], $setup_language->getInstalledLanguages());
    }

References $GLOBALS, and $handler.

◆ testFileBasedMethodsWorkWithoutAnyDatabase()

ilSetupLanguageTest::testFileBasedMethodsWorkWithoutAnyDatabase ( )

Definition at line 197 of file ilSetupLanguageTest.php.

                                                                : void
    {
        $setup_language = new ilSetupLanguage('en');
 
        self::assertContainsOnlyString($setup_language->getLocalLanguages());
        self::assertTrue($setup_language->checkLanguageForInstallation('en'));
    }

◆ testFindUnwritableOverlayDirectoriesChecksTheSetClientDataDir()

ilSetupLanguageTest::testFindUnwritableOverlayDirectoriesChecksTheSetClientDataDir ( )

Definition at line 565 of file ilSetupLanguageTest.php.

                                                                                   : void
    {
        $fixture = 'tmp-setup-unwritable-' . bin2hex(random_bytes(4));
        $client_data_dir = sys_get_temp_dir() . '/ilias_setup_unwritable_' . bin2hex(random_bytes(4));
        MigratedPoFixture::writePo(__DIR__ . '/' . $fixture . '/stest_de.po', MigratedPoFixture::catalog('stest', ['a' => 'b']));
        mkdir($client_data_dir);
        file_put_contents($client_data_dir . '/lang', 'not a directory');
 
        try {
            $setup_language = new ilSetupLanguage('de', new \ILIAS\Language\ComponentTranslation\LanguageFileDirectoryManager(
                new \ILIAS\Language\ComponentTranslation\CustomizingLanguageFileDirectory(),
                MigratedPoFixture::directory('stest', 'components/ILIAS/Language/tests/' . $fixture . '/')
            ));
            $setup_language->setClientDataDir($client_data_dir);
 
            $this->assertSame(
                [$client_data_dir . '/lang/stest/de'],
                $setup_language->findUnwritableOverlayDirectories(['de'])
            );
            $this->assertSame([], $setup_language->findUnwritableOverlayDirectories(['en']));
        } finally {
            MigratedPoFixture::removeDirectory(__DIR__ . '/' . $fixture);
            MigratedPoFixture::removeDirectory($client_data_dir);
        }
    }

References MigratedPoFixture\catalog(), MigratedPoFixture\directory(), MigratedPoFixture\removeDirectory(), and MigratedPoFixture\writePo().

Here is the call graph for this function:

◆ testGetClientDataDirReturnsTheSetDirectoryOrTheDefaultResolution()

ilSetupLanguageTest::testGetClientDataDirReturnsTheSetDirectoryOrTheDefaultResolution ( )

Definition at line 553 of file ilSetupLanguageTest.php.

                                                                                      : void
    {
        $setup_language = new ilSetupLanguage('de');
        $default = \ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths::resolveClientDataDir(
            (string) realpath(__DIR__ . '/../../../../')
        );
 
        $this->assertSame($default, $setup_language->getClientDataDir());
        $setup_language->setClientDataDir('/from/the/setup/environment');
        $this->assertSame('/from/the/setup/environment', $setup_language->getClientDataDir());
    }

References ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\resolveClientDataDir().

Here is the call graph for this function:

◆ testGetInvalidLocalLanguageFilesIgnoresMissingFile()

ilSetupLanguageTest::testGetInvalidLocalLanguageFilesIgnoresMissingFile ( )

Definition at line 365 of file ilSetupLanguageTest.php.

                                                                        : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        mkdir($fullPath, 0777, true);
 
        $manager = new LanguageFileDirectoryManager(
            $this->createMockCustomizingDirectory(),
            new MainLanguageFileDirectory()
        );
        $setup_language = new ilSetupLanguage('en', $manager);
 
        $this->assertSame([], $setup_language->getInvalidLocalLanguageFiles(['en']));
    }

◆ testGetInvalidLocalLanguageFilesReturnsEmptyForValidFile()

ilSetupLanguageTest::testGetInvalidLocalLanguageFilesReturnsEmptyForValidFile ( )

Definition at line 350 of file ilSetupLanguageTest.php.

                                                                              : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        mkdir($fullPath, 0777, true);
        file_put_contents($fullPath . '/ilias_en.lang.local', 'custom');
 
        $manager = new LanguageFileDirectoryManager(
            $this->createMockCustomizingDirectory(),
            new MainLanguageFileDirectory()
        );
        $setup_language = new ilSetupLanguage('en', $manager);
 
        $this->assertSame([], $setup_language->getInvalidLocalLanguageFiles(['en']));
    }

◆ testGetInvalidLocalLanguageFilesReturnsMalformedFileName()

ilSetupLanguageTest::testGetInvalidLocalLanguageFilesReturnsMalformedFileName ( )

Definition at line 379 of file ilSetupLanguageTest.php.

                                                                              : void
    {
        $fullPath = __DIR__ . '/../../../../' . $this->tempComponentDir;
        mkdir($fullPath, 0777, true);
        file_put_contents($fullPath . '/ilias_en.lang.locl', 'custom');
 
        $manager = new LanguageFileDirectoryManager(
            $this->createMockCustomizingDirectory(),
            new MainLanguageFileDirectory()
        );
        $setup_language = new ilSetupLanguage('en', $manager);
 
        $this->assertSame(
            ['ilias_en.lang.locl'],
            $setup_language->getInvalidLocalLanguageFiles(['en'])
        );
    }

◆ testInstallableLanguagesAreTheKeysWithAMainLanguageFile()

ilSetupLanguageTest::testInstallableLanguagesAreTheKeysWithAMainLanguageFile ( )

Definition at line 205 of file ilSetupLanguageTest.php.

                                                                             : void
    {
        $installable = (new ilSetupLanguage('en'))->getInstallableLanguagesForInstallation();
 
        $this->assertContains('en', $installable);
        $this->assertContains('de', $installable);
        $this->assertNotContains('qq', $installable);
    }

◆ testNothingIsReportedBeforeAManagerExists()

ilSetupLanguageTest::testNothingIsReportedBeforeAManagerExists ( )

Definition at line 502 of file ilSetupLanguageTest.php.

                                                               : void
    {
        $setup_language = new ilSetupLanguage('de', new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory()));
 
        $this->assertSame([], $setup_language->getOverlaysOfUnshippedModules());
        $this->assertSame([], $setup_language->getUnrecordedTakenOverModules());
    }

◆ testOverlaysOfUnshippedModulesAreOnlyReportedWithContributedDirectories()

ilSetupLanguageTest::testOverlaysOfUnshippedModulesAreOnlyReportedWithContributedDirectories ( )

Definition at line 489 of file ilSetupLanguageTest.php.

                                                                                             : void
    {
        $default = new ilSetupLanguage('de');
        $this->withManagerReporting($default);
        $injected = new ilSetupLanguage('de', new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), new MainLanguageFileDirectory()));
        $this->withManagerReporting($injected);
 
        $this->assertSame([], $default->getOverlaysOfUnshippedModules());
        $this->assertSame(['de' => ['ghost']], $injected->getOverlaysOfUnshippedModules());
        $this->assertSame(['de' => ['pilot']], $default->getUnrecordedTakenOverModules());
        $this->assertSame(['de' => ['pilot']], $injected->getUnrecordedTakenOverModules());
    }

◆ testRegisterInstalledLanguageInsertsAsInstalledLocalWhenLocalFileIsPresent()

ilSetupLanguageTest::testRegisterInstalledLanguageInsertsAsInstalledLocalWhenLocalFileIsPresent ( )

Definition at line 426 of file ilSetupLanguageTest.php.

                                                                                                : void
    {
        $db = $this->createDatabaseMock();
        $db->expects($this->once())
            ->method('manipulate')
            ->with($this->stringContains("'installed_local'"));
 
        $this->newLangSetupDe->setDbHandler($db);
        $this->newLangSetupDe->registerInstalledLanguage('de', [], ['de']);
    }

◆ testRegisterInstalledLanguageInsertsUnknownLanguage()

ilSetupLanguageTest::testRegisterInstalledLanguageInsertsUnknownLanguage ( )

@lang text

Definition at line 410 of file ilSetupLanguageTest.php.

                                                                         : void
    {
        $db = $this->createDatabaseMock();
        $db->expects($this->once())
            ->method('manipulate')
            ->with($this->logicalAnd(
                $this->stringContains( 'INSERT INTO object_data'),
                $this->stringContains("'de'"),
                $this->stringContains("'installed'")
            ))
            ->willReturn(1);
 
        $this->newLangSetupDe->setDbHandler($db);
        $this->newLangSetupDe->registerInstalledLanguage('de', [], []);
    }

◆ testRegisterInstalledLanguageUpdatesKnownLanguage()

ilSetupLanguageTest::testRegisterInstalledLanguageUpdatesKnownLanguage ( )

Definition at line 437 of file ilSetupLanguageTest.php.

                                                                       : void
    {
        $db = $this->createDatabaseMock();
        $db->expects($this->once())
            ->method('manipulate')
            ->with($this->logicalAnd(
                $this->stringContains('UPDATE object_data'),
                $this->stringContains("'installed'"),
                $this->stringContains('obj_id = ' . "'7'")
            ))
            ->willReturn(1);
 
        $this->newLangSetupDe->setDbHandler($db);
        $this->newLangSetupDe->registerInstalledLanguage(
            'de',
            ['de' => ['obj_id' => 7, 'status' => 'not_installed']],
            []
        );
    }

◆ testRetrieveInstalledLanguage()

ilSetupLanguageTest::testRetrieveInstalledLanguage ( )

Definition at line 138 of file ilSetupLanguageTest.php.

                                                   : void
    {
        $languagesAsKeys = [];
        foreach ($this->langInstalled as $languageAsKey) {
            $languagesAsKeys[] = $languageAsKey->getLangKey();
        }
 
        $this->assertContains('de', $languagesAsKeys);
        $this->assertContains('es', $languagesAsKeys);
    }

◆ testRetrieveLanguageKey()

ilSetupLanguageTest::testRetrieveLanguageKey ( )

Definition at line 132 of file ilSetupLanguageTest.php.

                                             : void
    {
        $this->assertEquals('de', $this->newLangSetupDe->getLangKey());
        $this->assertEquals('es', $this->newLangSetupEs->getLangKey());
    }

◆ testSetClientDataDirOverridesTheResolutionUntilResetWithNull()

ilSetupLanguageTest::testSetClientDataDirOverridesTheResolutionUntilResetWithNull ( )

setClientDataDir() overrides the resolution lazily, also after construction; null restores resolveClientDataDir().

Definition at line 527 of file ilSetupLanguageTest.php.

                                                                                  : void
    {
        $setup_language = new ilSetupLanguage('de');
        $default = \ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths::resolveClientDataDir(
            (string) realpath(__DIR__ . '/../../../../')
        );
 
        $setup_language->setClientDataDir('/from/the/setup/environment');
        $this->assertSame('/from/the/setup/environment', $this->resolvedClientDataDir($setup_language));
 
        $setup_language->setClientDataDir(null);
        $this->assertSame($default, $this->resolvedClientDataDir($setup_language));
    }

References ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\resolveClientDataDir().

Here is the call graph for this function:

◆ testTheTranslationCacheIsANoOpWithoutGlobalCache()

ilSetupLanguageTest::testTheTranslationCacheIsANoOpWithoutGlobalCache ( )

CLI Setup has no global cache: the translation cache must be a silent no-op.

Definition at line 542 of file ilSetupLanguageTest.php.

                                                                      : void
    {
        $setup_language = new ilSetupLanguage('de');
        $manager = $this->managerOf($setup_language);
        $translation_cache = (new ReflectionProperty(\ILIAS\Language\Setup\LanguageInstallationManager::class, 'translation_cache'))
            ->getValue($manager);
 
        $this->assertInstanceOf(\ILIAS\Language\Setup\NullTranslationCache::class, $translation_cache);
        $translation_cache->invalidate('de');
    }

References ILIAS\UI\Implementation\Component\Input\getValue().

Here is the call graph for this function:

◆ testWithoutInjectedDirectoriesOnlyTheDefaultDirectoriesAreUsed()

ilSetupLanguageTest::testWithoutInjectedDirectoriesOnlyTheDefaultDirectoriesAreUsed ( )

Definition at line 457 of file ilSetupLanguageTest.php.

                                                                                    : void
    {
        $setup_language = new ilSetupLanguage('de');
 
        $this->assertTrue($setup_language->usesDefaultLanguageFileDirectories());
        $this->assertSame(
            [MainLanguageFileDirectory::class, CustomizingLanguageFileDirectory::class],
            array_map(
                static fn(LanguageFileDirectory $d): string => $d::class,
                iterator_to_array($setup_language->getLanguageFileDirectoryManager()->getAllDirectories(), false)
            )
        );
    }

References Vendor\Package\$d.

◆ withManagerReporting()

ilSetupLanguageTest::withManagerReporting ( ilSetupLanguage $setup_language )

private

Definition at line 481 of file ilSetupLanguageTest.php.

                                                                          : void
    {
        $manager = $this->createStub(\ILIAS\Language\Setup\LanguageInstallationManager::class);
        $manager->method('getOverlaysOfUnshippedModules')->willReturn(['de' => ['ghost']]);
        $manager->method('getUnrecordedTakenOverModules')->willReturn(['de' => ['pilot']]);
        (new ReflectionProperty(ilSetupLanguage::class, 'manager'))->setValue($setup_language, $manager);
    }

Field Documentation

◆ $langInstalled

array ilSetupLanguageTest::$langInstalled

private

Definition at line 35 of file ilSetupLanguageTest.php.

◆ $newLangSetupDe

ilSetupLanguage ilSetupLanguageTest::$newLangSetupDe

private

Definition at line 33 of file ilSetupLanguageTest.php.

Referenced by setUp().

◆ $newLangSetupEs

ilSetupLanguage ilSetupLanguageTest::$newLangSetupEs

private

Definition at line 34 of file ilSetupLanguageTest.php.

Referenced by setUp().

◆ $tempComponentDir

string ilSetupLanguageTest::$tempComponentDir = 'artifacts/test_lang_component'

private

Definition at line 36 of file ilSetupLanguageTest.php.

Referenced by cleanupTempDir().

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

components/ILIAS/Language/tests/ilSetupLanguageTest.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ callCheckLanguage()

◆ cleanupTempDir()

◆ createDatabaseMock()

◆ createMockComponentDirectory()

◆ createMockCustomizingDirectory()

◆ databaseMethods()

◆ databaseSources()

◆ emptyDatabase()

◆ managerOf()

◆ resolvedClientDataDir()

◆ setUp()

◆ tearDown()

◆ testAnInjectedDirectoryManagerIsUsedAndReported()

◆ testCheckLanguageFailsOnInvalidComponentLanguageFile()

◆ testCheckLanguageFailsOnNonUtf8Value()

◆ testCheckLanguageWithBothMainAndComponentFiles()

◆ testCheckLanguageWithMissingMainFile()

◆ testCheckLanguageWithOnlyMainFile()

◆ testDatabaseMethodsWithoutDatabaseThrowLogicException()

◆ testDatabaseSourcePrecedence()

◆ testFileBasedMethodsWorkWithoutAnyDatabase()

◆ testFindUnwritableOverlayDirectoriesChecksTheSetClientDataDir()

◆ testGetClientDataDirReturnsTheSetDirectoryOrTheDefaultResolution()

◆ testGetInvalidLocalLanguageFilesIgnoresMissingFile()

◆ testGetInvalidLocalLanguageFilesReturnsEmptyForValidFile()

◆ testGetInvalidLocalLanguageFilesReturnsMalformedFileName()

◆ testInstallableLanguagesAreTheKeysWithAMainLanguageFile()

◆ testNothingIsReportedBeforeAManagerExists()

◆ testOverlaysOfUnshippedModulesAreOnlyReportedWithContributedDirectories()

◆ testRegisterInstalledLanguageInsertsAsInstalledLocalWhenLocalFileIsPresent()

◆ testRegisterInstalledLanguageInsertsUnknownLanguage()

◆ testRegisterInstalledLanguageUpdatesKnownLanguage()

◆ testRetrieveInstalledLanguage()

◆ testRetrieveLanguageKey()

◆ testSetClientDataDirOverridesTheResolutionUntilResetWithNull()

◆ testTheTranslationCacheIsANoOpWithoutGlobalCache()

◆ testWithoutInjectedDirectoriesOnlyTheDefaultDirectoriesAreUsed()

◆ withManagerReporting()

Field Documentation

◆ $langInstalled

◆ $newLangSetupDe

◆ $newLangSetupEs

◆ $tempComponentDir