Database-backed methods run against an ilDBInterface mock returning controlled rows; filesystem-backed methods use a real temporary installation root, like LanguageInstallationManagerTest. More...

Inheritance diagram for InstalledLanguageDatabaseRepositoryTest:

Collaboration diagram for InstalledLanguageDatabaseRepositoryTest:

Public Member Functions
	testGetAvailableLanguagesMapsObjIdAndStatusToTheCorrectLanguageNotSwapped ()

	testGetAvailableLanguagesReturnsEmptyArrayWhenNoLanguagesAreKnown ()

	testGetInstalledLanguagesQueriesForInstalledPrefixAndReturnsTitles ()

	testGetInstalledLocalLanguagesQueriesForExactlyInstalledLocalAndReturnsTitles ()

	testGetLocalChangesDefaultsMinAndMaxDateWhenEmptyStringsArePassed ()

	testGetLocalChangesKeepsExplicitlyGivenDatesInsteadOfDefaulting ()

	testGetLocalChangesStructuresResultAsModuleThenIdentifierThenValue ()

	testGetLocalChangesReturnsEmptyArrayWhenNothingMatches ()

	testGetLanguageEntriesStructuresResultAsModuleThenIdentifierThenValue ()

	testGetLanguageEntriesReturnsEmptyArrayWhenNothingMatches ()

	testGetLanguageEntriesQueryDoesNotFilterByLocalChange ()
	Unlike getLocalChanges(), getLanguageEntries() returns every stored entry of the language key, so its query must not filter on local_change. More...

	testGetLocalLanguagesExtractsKeysFromLocalFilesAndIgnoresUnrelatedFiles ()

	testGetLocalLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName ()
	The discovery regex must accept exactly ParsesLanguageKeyList::LANGUAGE_KEY_FORMAT ('/^[a-z]{2}$/'): other file names must be ignored, or they would fail later in the Activity's stricter validation. More...

	testGetInstallableLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName ()
	Same for getInstallableLanguages() (lang/) instead of getLocalLanguages() (lang/customizing/). More...

	testGetInstallableLanguagesIgnoresAFileNameWithATrailingNewline ()
	The regex ends in `\z`, not `$`, which in PCRE also matches before a trailing newline; file names may legally contain "\n". More...

	testGetLocalLanguagesReturnsEmptyArrayWhenCustomizingDirectoryIsEmpty ()

	testGetInstallableLanguagesExtractsKeysFromMainFilesAndIgnoresUnrelatedFiles ()

	testCheckLocalLanguageFileReturnsFalseWhenNoLocalFileExists ()

	testCheckLocalLanguageFileReturnsTrueForAValidLocalFile ()

	testCheckLocalLanguageFileReturnsFalseForAnInvalidLocalFile ()

	testCheckLocalLanguageFileReturnsFalseForMalformedLine ()

	testCheckLocalLanguageFileReturnsFalseWhenNoCustomizingDirectoryIsConfiguredAtAll ()
	getCustomizingDirectories() always yields one directory in production, so the "zero directories" branch (`return false`) is reachable only with a mocked manager, which this class otherwise avoids. More...

	testCheckLanguageAcceptsAParsableShippedPo ()

	testCheckLanguageRejectsAnUnparsableShippedPo (string $po_content)
	Everything gettext/gettext's StrictPoLoader rejects invalidates the language, including what the old parser tolerated (a duplicate, a message without msgstr). More...

	testCheckLanguageAcceptsAShippedPoWithBomAndCrLf ()
	A BOM and CRLF line endings are no reason to refuse the language. More...

	testCheckLanguageAcceptsAModuleWithoutShippedPoForTheLanguage ()

	testCheckLanguageDoesNotParsePoFilesOfTheLocalDirectory ()

	testCheckLanguageAcceptsAnEmptyShippedPo ()
	An empty `.po` is a valid, empty catalog. More...

	testCheckShippedLanguageIgnoresAnInvalidCustomizingFileThatMakesCheckLanguageFail ()
	checkShippedLanguage() is checkLanguage() without the customizing directory: an invalid "ilias_de.lang.local" must not block it. More...

	testCheckShippedLanguageRejectsAnInvalidGlobalLanguageFile ()
	An invalid global "ilias_de.lang" is part of getDirectories(), so checkShippedLanguage() fails like checkLanguage(). More...

	testCheckShippedLanguageRejectsAnUnparsableShippedPo ()
	An unparsable shipped `.po` of a PO-maintained module is part of getDirectories() too, so checkShippedLanguage() fails like checkLanguage(). More...

Static Public Member Functions
static	unparsableShippedPo ()

Private Member Functions
	createReadDatabaseMock ()

	configureDbToReturnObjectRows (Stub &ilDBInterface $db, array $rows)
	The read methods call fetchObject() on the database object, not on the statement, so the rows are stubbed on $db. More...

	createStatementReturningAssocRows (array $rows)

	createRepository (ilDBInterface $db, string $absolute_path='/does/not/matter/for/db-only/tests')

	checkLanguageWithShippedPo (?string $po_content, bool $local_directory=false)
	checkLanguage() for a migrated module: the shipped `.po` is the only source of its values, so an unparsable one invalidates the language. More...

	createTempInstallationRoot ()

	removeDirectory (string $dir)

Detailed Description

Database-backed methods run against an ilDBInterface mock returning controlled rows; filesystem-backed methods use a real temporary installation root, like LanguageInstallationManagerTest.

Definition at line 34 of file InstalledLanguageDatabaseRepositoryTest.php.

Member Function Documentation

◆ checkLanguageWithShippedPo()

InstalledLanguageDatabaseRepositoryTest::checkLanguageWithShippedPo	(	?string	$po_content,
		bool	$local_directory = `false`
	)

private

checkLanguage() for a migrated module: the shipped .po is the only source of its values, so an unparsable one invalidates the language.

Builds a root with a valid main lang file and a "pilot" component whose shipped de .po has $po_content (null = no .po).

Definition at line 481 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                                   : bool
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', "<!-- language file start -->\ncommon#:#yes#:#Ja\n");
        mkdir($root . '/components/pilot/lang', 0777, true);
        if ($po_content !== null) {
            file_put_contents($root . '/components/pilot/lang/pilot_de.po', $po_content);
        }
        $pilot = MigratedPoFixture::directory('pilot', 'components/pilot/lang/', $local_directory);
 
        try {
            $repository = new InstalledLanguageDatabaseRepository(
                $this->createReadDatabaseMock(),
                $local_directory
                    ? new LanguageFileDirectoryManager($pilot, new MainLanguageFileDirectory())
                    : new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), new MainLanguageFileDirectory(), $pilot),
                new FixedInstallationRoot($root)
            );
            return $repository->checkLanguage('de');
        } finally {
            $this->removeDirectory($root);
        }
    }

References MigratedPoFixture\directory().

Here is the call graph for this function:

◆ configureDbToReturnObjectRows()

InstalledLanguageDatabaseRepositoryTest::configureDbToReturnObjectRows	(	Stub &ilDBInterface	$db,
		array	$rows
	)

private

The read methods call fetchObject() on the database object, not on the statement, so the rows are stubbed on $db.

query() is left to each test, so no two stubs compete.

Parameters

list<array<string,mixed>> $rows each row as an associative array of column => value

Definition at line 56 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                       : void
    {
        $objects = array_map(static fn(array $row): \stdClass => (object) $row, $rows);
        $objects[] = null; // terminates the while ($row = ...) loop
        $db->method('fetchObject')->willReturn(...$objects);
    }

References ILIAS\Scripts\PHPStan\$rows.

◆ createReadDatabaseMock()

InstalledLanguageDatabaseRepositoryTest::createReadDatabaseMock ( )

private

Definition at line 36 of file InstalledLanguageDatabaseRepositoryTest.php.

                                             : Stub&ilDBInterface
    {
        $db = $this->createStub(ilDBInterface::class);
        $db->method('quote')->willReturnCallback(
            static fn(mixed $value, string $type): string => "'" . (string) $value . "'"
        );
        $db->method('like')->willReturnCallback(
            static fn(string $column, string $type, string $value = "?", bool $ci = true): string =>
                $column . " LIKE " . "'" . $value . "'"
        );
 
        return $db;
    }

◆ createRepository()

InstalledLanguageDatabaseRepositoryTest::createRepository	(	ilDBInterface	$db,
		string	$absolute_path = `'/does/not/matter/for/db-only/tests'`
	)

private

Definition at line 75 of file InstalledLanguageDatabaseRepositoryTest.php.

     : InstalledLanguageDatabaseRepository {
        return new InstalledLanguageDatabaseRepository(
            $db,
            new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), new MainLanguageFileDirectory()),
            new FixedInstallationRoot($absolute_path)
        );
    }

◆ createStatementReturningAssocRows()

InstalledLanguageDatabaseRepositoryTest::createStatementReturningAssocRows ( array $rows )

private

Parameters

list<array<string,mixed>> $rows each row as an associative array of column => value

Definition at line 66 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                   : Stub&ilDBStatement
    {
        $statement = $this->createStub(ilDBStatement::class);
        $rows[] = null; // terminates the while ($row = ...) loop
        $statement->method('fetchRow')->willReturn(...$rows);
 
        return $statement;
    }

References ILIAS\Scripts\PHPStan\$rows.

◆ createTempInstallationRoot()

InstalledLanguageDatabaseRepositoryTest::createTempInstallationRoot ( )

private

Definition at line 624 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                 : string
    {
        $dir = sys_get_temp_dir() . '/ilias_lang_repo_test_' . bin2hex(random_bytes(8));
        mkdir($dir . '/lang/customizing', 0777, true);
        return $dir;
    }

◆ removeDirectory()

InstalledLanguageDatabaseRepositoryTest::removeDirectory ( string $dir )

private

Definition at line 631 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                 : void
    {
        if (!is_dir($dir)) {
            return;
        }
        $items = scandir($dir);
        foreach ($items as $item) {
            if ($item === '.' || $item === '..') {
                continue;
            }
            $path = $dir . '/' . $item;
            if (is_dir($path) && !is_link($path)) {
                $this->removeDirectory($path);
            } else {
                unlink($path);
            }
        }
        rmdir($dir);
    }

◆ testCheckLanguageAcceptsAModuleWithoutShippedPoForTheLanguage()

InstalledLanguageDatabaseRepositoryTest::testCheckLanguageAcceptsAModuleWithoutShippedPoForTheLanguage ( )

Definition at line 544 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                   : void
    {
        $this->assertTrue($this->checkLanguageWithShippedPo(null));
    }

◆ testCheckLanguageAcceptsAnEmptyShippedPo()

InstalledLanguageDatabaseRepositoryTest::testCheckLanguageAcceptsAnEmptyShippedPo ( )

An empty .po is a valid, empty catalog.

Definition at line 557 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                              : void
    {
        $this->assertTrue($this->checkLanguageWithShippedPo(''));
    }

◆ testCheckLanguageAcceptsAParsableShippedPo()

InstalledLanguageDatabaseRepositoryTest::testCheckLanguageAcceptsAParsableShippedPo ( )

Definition at line 505 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                : void
    {
        $this->assertTrue($this->checkLanguageWithShippedPo("msgctxt \"pilot\"\nmsgid \"greeting\"\nmsgstr \"Hallo\"\n"));
    }

◆ testCheckLanguageAcceptsAShippedPoWithBomAndCrLf()

InstalledLanguageDatabaseRepositoryTest::testCheckLanguageAcceptsAShippedPoWithBomAndCrLf ( )

A BOM and CRLF line endings are no reason to refuse the language.

Definition at line 537 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                      : void
    {
        $this->assertTrue($this->checkLanguageWithShippedPo(
            "\xEF\xBB\xBFmsgid \"\"\r\nmsgstr \"\"\r\n\"Language: de\\n\"\r\n\r\nmsgctxt \"pilot\"\r\nmsgid \"greeting\"\r\nmsgstr \"Hallo\"\r\n"
        ));
    }

◆ testCheckLanguageDoesNotParsePoFilesOfTheLocalDirectory()

InstalledLanguageDatabaseRepositoryTest::testCheckLanguageDoesNotParsePoFilesOfTheLocalDirectory ( )

Definition at line 549 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                             : void
    {
        $this->assertTrue($this->checkLanguageWithShippedPo("msgid \"abc\n", true));
    }

◆ testCheckLanguageRejectsAnUnparsableShippedPo()

InstalledLanguageDatabaseRepositoryTest::testCheckLanguageRejectsAnUnparsableShippedPo ( string $po_content )

Everything gettext/gettext's StrictPoLoader rejects invalidates the language, including what the old parser tolerated (a duplicate, a message without msgstr).

Definition at line 515 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                     : void
    {
        $this->assertFalse($this->checkLanguageWithShippedPo($po_content));
    }

◆ testCheckLocalLanguageFileReturnsFalseForAnInvalidLocalFile()

InstalledLanguageDatabaseRepositoryTest::testCheckLocalLanguageFileReturnsFalseForAnInvalidLocalFile ( )

Definition at line 421 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                 : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents(
            $root . '/lang/customizing/ilias_de.lang.local',
            "common#:#test#:#Custom Value\n"
        );
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
            $this->assertFalse($repository->checkLocalLanguageFile('de'));
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testCheckLocalLanguageFileReturnsFalseForMalformedLine()

InstalledLanguageDatabaseRepositoryTest::testCheckLocalLanguageFileReturnsFalseForMalformedLine ( )

Definition at line 437 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                            : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents(
            $root . '/lang/customizing/ilias_de.lang.local',
            "<!-- language file start -->\nonly_one_field\n"
        );
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
            $this->assertFalse($repository->checkLocalLanguageFile('de'));
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testCheckLocalLanguageFileReturnsFalseWhenNoCustomizingDirectoryIsConfiguredAtAll()

InstalledLanguageDatabaseRepositoryTest::testCheckLocalLanguageFileReturnsFalseWhenNoCustomizingDirectoryIsConfiguredAtAll ( )

getCustomizingDirectories() always yields one directory in production, so the "zero directories" branch (return false) is reachable only with a mocked manager, which this class otherwise avoids.

Definition at line 457 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                                       : void
    {
        $manager = $this->createStub(LanguageFileDirectoryManager::class);
        $manager->method('getCustomizingDirectories')->willReturnCallback(
            static function (): \Generator {
                return;
                yield; // unreachable; makes this a generator that yields nothing
            }
        );
 
        $repository = new InstalledLanguageDatabaseRepository(
            $this->createReadDatabaseMock(),
            $manager,
            new FixedInstallationRoot('/does/not/matter/for/this/test')
        );
 
        $this->assertFalse($repository->checkLocalLanguageFile('de'));
    }

◆ testCheckLocalLanguageFileReturnsFalseWhenNoLocalFileExists()

InstalledLanguageDatabaseRepositoryTest::testCheckLocalLanguageFileReturnsFalseWhenNoLocalFileExists ( )

Definition at line 392 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                 : void
    {
        $root = $this->createTempInstallationRoot();
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
            // unlike checkLanguage(), a missing local file is not acceptable here
            $this->assertFalse($repository->checkLocalLanguageFile('de'));
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testCheckLocalLanguageFileReturnsTrueForAValidLocalFile()

InstalledLanguageDatabaseRepositoryTest::testCheckLocalLanguageFileReturnsTrueForAValidLocalFile ( )

Definition at line 405 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                             : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents(
            $root . '/lang/customizing/ilias_de.lang.local',
            "<!-- language file start -->\ncommon#:#test#:#Custom Value\n"
        );
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
            $this->assertTrue($repository->checkLocalLanguageFile('de'));
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testCheckShippedLanguageIgnoresAnInvalidCustomizingFileThatMakesCheckLanguageFail()

InstalledLanguageDatabaseRepositoryTest::testCheckShippedLanguageIgnoresAnInvalidCustomizingFileThatMakesCheckLanguageFail ( )

checkShippedLanguage() is checkLanguage() without the customizing directory: an invalid "ilias_de.lang.local" must not block it.

Definition at line 566 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                                       : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', "<!-- language file start -->\ncommon#:#yes#:#Ja\n");
        file_put_contents($root . '/lang/customizing/ilias_de.lang.local', "<!-- language file start -->\nonly_one_field\n");
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $this->assertTrue($repository->checkShippedLanguage('de'), 'the invalid customizing file is never consulted');
            $this->assertFalse($repository->checkLanguage('de'), 'precondition: the same file makes checkLanguage() fail');
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testCheckShippedLanguageRejectsAnInvalidGlobalLanguageFile()

InstalledLanguageDatabaseRepositoryTest::testCheckShippedLanguageRejectsAnInvalidGlobalLanguageFile ( )

An invalid global "ilias_de.lang" is part of getDirectories(), so checkShippedLanguage() fails like checkLanguage().

Definition at line 585 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', "common#:#yes#:#Ja\n");
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $this->assertFalse($repository->checkShippedLanguage('de'));
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testCheckShippedLanguageRejectsAnUnparsableShippedPo()

InstalledLanguageDatabaseRepositoryTest::testCheckShippedLanguageRejectsAnUnparsableShippedPo ( )

An unparsable shipped .po of a PO-maintained module is part of getDirectories() too, so checkShippedLanguage() fails like checkLanguage().

Definition at line 603 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                          : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', "<!-- language file start -->\ncommon#:#yes#:#Ja\n");
        mkdir($root . '/components/pilot/lang', 0777, true);
        file_put_contents($root . '/components/pilot/lang/pilot_de.po', "msgctxt \"pilot\"\nmsgid \"abc\nmsgstr \"Hallo\"\n");
        $pilot = MigratedPoFixture::directory('pilot', 'components/pilot/lang/');
 
        try {
            $repository = new InstalledLanguageDatabaseRepository(
                $this->createReadDatabaseMock(),
                new LanguageFileDirectoryManager(new CustomizingLanguageFileDirectory(), new MainLanguageFileDirectory(), $pilot),
                new FixedInstallationRoot($root)
            );
 
            $this->assertFalse($repository->checkShippedLanguage('de'));
        } finally {
            $this->removeDirectory($root);
        }
    }

References MigratedPoFixture\directory().

Here is the call graph for this function:

◆ testGetAvailableLanguagesMapsObjIdAndStatusToTheCorrectLanguageNotSwapped()

InstalledLanguageDatabaseRepositoryTest::testGetAvailableLanguagesMapsObjIdAndStatusToTheCorrectLanguageNotSwapped ( )

Definition at line 86 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                               : void
    {
        $db = $this->createReadDatabaseMock();
        $db->method('query')->willReturn($this->createStub(ilDBStatement::class));
        $this->configureDbToReturnObjectRows($db, [
            ['title' => 'de', 'description' => 'installed', 'obj_id' => 5],
            ['title' => 'en', 'description' => 'not_installed', 'obj_id' => 8],
        ]);
 
        $result = $this->createRepository($db)->getAvailableLanguages();
 
        $this->assertSame(
            [
                'de' => ['obj_id' => 5, 'status' => 'installed'],
                'en' => ['obj_id' => 8, 'status' => 'not_installed'],
            ],
            $result
        );
    }

◆ testGetAvailableLanguagesReturnsEmptyArrayWhenNoLanguagesAreKnown()

InstalledLanguageDatabaseRepositoryTest::testGetAvailableLanguagesReturnsEmptyArrayWhenNoLanguagesAreKnown ( )

Definition at line 106 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                       : void
    {
        $db = $this->createReadDatabaseMock();
        $db->method('query')->willReturn($this->createStub(ilDBStatement::class));
        $this->configureDbToReturnObjectRows($db, []);
 
        $this->assertSame([], $this->createRepository($db)->getAvailableLanguages());
    }

◆ testGetInstallableLanguagesExtractsKeysFromMainFilesAndIgnoresUnrelatedFiles()

InstalledLanguageDatabaseRepositoryTest::testGetInstallableLanguagesExtractsKeysFromMainFilesAndIgnoresUnrelatedFiles ( )

Definition at line 371 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                                  : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', 'irrelevant content');
        file_put_contents($root . '/lang/ilias_en.lang', 'irrelevant content');
        // a local file is not installable, nor is a name outside the "ilias_xx.lang" scheme
        file_put_contents($root . '/lang/ilias_fr.lang.local', 'irrelevant content');
        file_put_contents($root . '/lang/notes.txt', 'irrelevant content');
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $result = $repository->getInstallableLanguages();
 
            sort($result);
            $this->assertSame(['de', 'en'], $result);
        } finally {
            $this->removeDirectory($root);
        }
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ testGetInstallableLanguagesIgnoresAFileNameWithATrailingNewline()

InstalledLanguageDatabaseRepositoryTest::testGetInstallableLanguagesIgnoresAFileNameWithATrailingNewline ( )

The regex ends in \z, not $, which in PCRE also matches before a trailing newline; file names may legally contain "\n".

Definition at line 341 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                     : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', 'irrelevant content');
        // distinct key "zz": a wrongly accepted trailing "\n" would show up as an extra entry, not collapse into "de"
        file_put_contents($root . "/lang/ilias_zz.lang\n", 'irrelevant content');
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $result = $repository->getInstallableLanguages();
 
            $this->assertSame(['de'], $result);
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testGetInstallableLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName()

InstalledLanguageDatabaseRepositoryTest::testGetInstallableLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName ( )

Same for getInstallableLanguages() (lang/) instead of getLocalLanguages() (lang/customizing/).

Definition at line 319 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                                     : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/ilias_de.lang', 'irrelevant content');
        file_put_contents($root . '/lang/ilias_DE.lang', 'irrelevant content');
        file_put_contents($root . '/lang/ilias_12.lang', 'irrelevant content');
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $result = $repository->getInstallableLanguages();
 
            $this->assertSame(['de'], $result);
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testGetInstalledLanguagesQueriesForInstalledPrefixAndReturnsTitles()

InstalledLanguageDatabaseRepositoryTest::testGetInstalledLanguagesQueriesForInstalledPrefixAndReturnsTitles ( )

Definition at line 115 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                        : void
    {
        $db = $this->createReadDatabaseMock();
        $captured_query = null;
        $db->method('query')->willReturnCallback(
            function (string $query) use (&$captured_query): ilDBStatement {
                $captured_query = $query;
                return $this->createStub(ilDBStatement::class);
            }
        );
        $this->configureDbToReturnObjectRows($db, [
            ['title' => 'de'],
            ['title' => 'en'],
        ]);
 
        $result = $this->createRepository($db)->getInstalledLanguages();
 
        $this->assertSame(['de', 'en'], $result);
        $this->assertStringContainsString("type = 'lng'", $captured_query);
        $this->assertStringContainsString("description LIKE 'installed%'", $captured_query);
    }

◆ testGetInstalledLocalLanguagesQueriesForExactlyInstalledLocalAndReturnsTitles()

InstalledLanguageDatabaseRepositoryTest::testGetInstalledLocalLanguagesQueriesForExactlyInstalledLocalAndReturnsTitles ( )

Definition at line 137 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                                   : void
    {
        $db = $this->createReadDatabaseMock();
        $captured_query = null;
        $db->method('query')->willReturnCallback(
            function (string $query) use (&$captured_query): ilDBStatement {
                $captured_query = $query;
                return $this->createStub(ilDBStatement::class);
            }
        );
        $this->configureDbToReturnObjectRows($db, [
            ['title' => 'de'],
        ]);
 
        $result = $this->createRepository($db)->getInstalledLocalLanguages();
 
        $this->assertSame(['de'], $result);
        $this->assertStringContainsString("description = 'installed_local'", $captured_query);
    }

◆ testGetLanguageEntriesQueryDoesNotFilterByLocalChange()

InstalledLanguageDatabaseRepositoryTest::testGetLanguageEntriesQueryDoesNotFilterByLocalChange ( )

Unlike getLocalChanges(), getLanguageEntries() returns every stored entry of the language key, so its query must not filter on local_change.

Definition at line 253 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                           : void
    {
        $db = $this->createReadDatabaseMock();
        $captured_query = null;
        $db->method('query')->willReturnCallback(
            function (string $query) use (&$captured_query): ilDBStatement {
                $captured_query = $query;
                return $this->createStatementReturningAssocRows([]);
            }
        );
 
        $this->createRepository($db)->getLanguageEntries('de');
 
        $this->assertStringContainsString("lang_key = 'de'", $captured_query);
        $this->assertStringNotContainsString('local_change', $captured_query);
    }

◆ testGetLanguageEntriesReturnsEmptyArrayWhenNothingMatches()

InstalledLanguageDatabaseRepositoryTest::testGetLanguageEntriesReturnsEmptyArrayWhenNothingMatches ( )

Definition at line 241 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                               : void
    {
        $db = $this->createReadDatabaseMock();
        $db->method('query')->willReturn($this->createStatementReturningAssocRows([]));
 
        $this->assertSame([], $this->createRepository($db)->getLanguageEntries('de'));
    }

◆ testGetLanguageEntriesStructuresResultAsModuleThenIdentifierThenValue()

InstalledLanguageDatabaseRepositoryTest::testGetLanguageEntriesStructuresResultAsModuleThenIdentifierThenValue ( )

Definition at line 221 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                           : void
    {
        $db = $this->createReadDatabaseMock();
        $db->method('query')->willReturn($this->createStatementReturningAssocRows([
            ['module' => 'common', 'identifier' => 'foo', 'value' => 'Foo Value'],
            ['module' => 'common', 'identifier' => 'bar', 'value' => 'Bar Value'],
            ['module' => 'other', 'identifier' => 'baz', 'value' => 'Baz Value'],
        ]));
 
        $result = $this->createRepository($db)->getLanguageEntries('de');
 
        $this->assertSame(
            [
                'common' => ['foo' => 'Foo Value', 'bar' => 'Bar Value'],
                'other' => ['baz' => 'Baz Value'],
            ],
            $result
        );
    }

◆ testGetLocalChangesDefaultsMinAndMaxDateWhenEmptyStringsArePassed()

InstalledLanguageDatabaseRepositoryTest::testGetLocalChangesDefaultsMinAndMaxDateWhenEmptyStringsArePassed ( )

Definition at line 157 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                       : void
    {
        $db = $this->createReadDatabaseMock();
        $captured_query = null;
        $db->method('query')->willReturnCallback(
            function (string $query) use (&$captured_query): ilDBStatement {
                $captured_query = $query;
                return $this->createStatementReturningAssocRows([]);
            }
        );
 
        $this->createRepository($db)->getLocalChanges('de', '', '');
 
        $this->assertStringContainsString("'1980-01-01 00:00:00'", $captured_query);
        $this->assertStringContainsString("'2200-01-01 00:00:00'", $captured_query);
    }

◆ testGetLocalChangesKeepsExplicitlyGivenDatesInsteadOfDefaulting()

InstalledLanguageDatabaseRepositoryTest::testGetLocalChangesKeepsExplicitlyGivenDatesInsteadOfDefaulting ( )

Definition at line 174 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                     : void
    {
        $db = $this->createReadDatabaseMock();
        $captured_query = null;
        $db->method('query')->willReturnCallback(
            function (string $query) use (&$captured_query): ilDBStatement {
                $captured_query = $query;
                return $this->createStatementReturningAssocRows([]);
            }
        );
 
        $this->createRepository($db)->getLocalChanges('de', '2020-01-01 00:00:00', '2021-01-01 00:00:00');
 
        $this->assertStringContainsString("'2020-01-01 00:00:00'", $captured_query);
        $this->assertStringContainsString("'2021-01-01 00:00:00'", $captured_query);
        $this->assertStringNotContainsString('1980-01-01', $captured_query);
        $this->assertStringNotContainsString('2200-01-01', $captured_query);
    }

◆ testGetLocalChangesReturnsEmptyArrayWhenNothingMatches()

InstalledLanguageDatabaseRepositoryTest::testGetLocalChangesReturnsEmptyArrayWhenNothingMatches ( )

Definition at line 213 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                            : void
    {
        $db = $this->createReadDatabaseMock();
        $db->method('query')->willReturn($this->createStatementReturningAssocRows([]));
 
        $this->assertSame([], $this->createRepository($db)->getLocalChanges('de'));
    }

◆ testGetLocalChangesStructuresResultAsModuleThenIdentifierThenValue()

InstalledLanguageDatabaseRepositoryTest::testGetLocalChangesStructuresResultAsModuleThenIdentifierThenValue ( )

Definition at line 193 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                        : void
    {
        $db = $this->createReadDatabaseMock();
        $db->method('query')->willReturn($this->createStatementReturningAssocRows([
            ['module' => 'common', 'identifier' => 'foo', 'value' => 'Foo Value'],
            ['module' => 'common', 'identifier' => 'bar', 'value' => 'Bar Value'],
            ['module' => 'other', 'identifier' => 'baz', 'value' => 'Baz Value'],
        ]));
 
        $result = $this->createRepository($db)->getLocalChanges('de');
 
        $this->assertSame(
            [
                'common' => ['foo' => 'Foo Value', 'bar' => 'Bar Value'],
                'other' => ['baz' => 'Baz Value'],
            ],
            $result
        );
    }

◆ testGetLocalLanguagesExtractsKeysFromLocalFilesAndIgnoresUnrelatedFiles()

InstalledLanguageDatabaseRepositoryTest::testGetLocalLanguagesExtractsKeysFromLocalFilesAndIgnoresUnrelatedFiles ( )

Definition at line 270 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                             : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/customizing/ilias_de.lang.local', 'irrelevant content');
        file_put_contents($root . '/lang/customizing/ilias_en.lang.local', 'irrelevant content');
        // wrong naming scheme (missing .local suffix, a typo): ignored
        file_put_contents($root . '/lang/customizing/ilias_fr.lang', 'irrelevant content');
        file_put_contents($root . '/lang/customizing/README.md', 'irrelevant content');
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $result = $repository->getLocalLanguages();
 
            sort($result);
            $this->assertSame(['de', 'en'], $result);
            $this->assertSame(array_values(array_unique($result)), array_values($result));
        } finally {
            $this->removeDirectory($root);
        }
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Here is the call graph for this function:

◆ testGetLocalLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName()

InstalledLanguageDatabaseRepositoryTest::testGetLocalLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName ( )

The discovery regex must accept exactly ParsesLanguageKeyList::LANGUAGE_KEY_FORMAT ('/^[a-z]{2}$/'): other file names must be ignored, or they would fail later in the Activity's stricter validation.

Definition at line 296 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                               : void
    {
        $root = $this->createTempInstallationRoot();
        file_put_contents($root . '/lang/customizing/ilias_de.lang.local', 'irrelevant content');
        file_put_contents($root . '/lang/customizing/ilias_DE.lang.local', 'irrelevant content');
        file_put_contents($root . '/lang/customizing/ilias_12.lang.local', 'irrelevant content');
        file_put_contents($root . '/lang/customizing/ilias_Fr.lang.local', 'irrelevant content');
        file_put_contents($root . '/lang/customizing/ilias_deu.lang.local', 'irrelevant content');
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
 
            $result = $repository->getLocalLanguages();
 
            $this->assertSame(['de'], $result);
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ testGetLocalLanguagesReturnsEmptyArrayWhenCustomizingDirectoryIsEmpty()

InstalledLanguageDatabaseRepositoryTest::testGetLocalLanguagesReturnsEmptyArrayWhenCustomizingDirectoryIsEmpty ( )

Definition at line 359 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                                                           : void
    {
        $root = $this->createTempInstallationRoot();
 
        try {
            $repository = $this->createRepository($this->createReadDatabaseMock(), $root);
            $this->assertSame([], $repository->getLocalLanguages());
        } finally {
            $this->removeDirectory($root);
        }
    }

◆ unparsableShippedPo()

static InstalledLanguageDatabaseRepositoryTest::unparsableShippedPo ( )

static

Definition at line 520 of file InstalledLanguageDatabaseRepositoryTest.php.

                                                : array
    {
        $message = "msgctxt \"pilot\"\nmsgid \"greeting\"\nmsgstr \"Hallo\"\n";
 
        return [
            'unterminated string' => ["msgctxt \"pilot\"\nmsgid \"abc\nmsgstr \"Hallo\"\n"],
            'duplicate message' => [$message . "\n" . $message],
            'message without msgstr' => ["msgctxt \"pilot\"\nmsgid \"greeting\"\n"],
            'truncated inside a string' => [substr($message, 0, -4)],
            'binary data' => ["\xde\x12\x04\x95\x00\x00\x00\x00"],
            'header value with a line break' => ["msgid \"\"\nmsgstr \"\"\n\"X-A: a\\rb\\n\"\n\n" . $message],
        ];
    }

References $message.

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

components/ILIAS/Language/tests/Setup/InstalledLanguageDatabaseRepositoryTest.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation

◆ checkLanguageWithShippedPo()

◆ configureDbToReturnObjectRows()

◆ createReadDatabaseMock()

◆ createRepository()

◆ createStatementReturningAssocRows()

◆ createTempInstallationRoot()

◆ removeDirectory()

◆ testCheckLanguageAcceptsAModuleWithoutShippedPoForTheLanguage()

◆ testCheckLanguageAcceptsAnEmptyShippedPo()

◆ testCheckLanguageAcceptsAParsableShippedPo()

◆ testCheckLanguageAcceptsAShippedPoWithBomAndCrLf()

◆ testCheckLanguageDoesNotParsePoFilesOfTheLocalDirectory()

◆ testCheckLanguageRejectsAnUnparsableShippedPo()

◆ testCheckLocalLanguageFileReturnsFalseForAnInvalidLocalFile()

◆ testCheckLocalLanguageFileReturnsFalseForMalformedLine()

◆ testCheckLocalLanguageFileReturnsFalseWhenNoCustomizingDirectoryIsConfiguredAtAll()

◆ testCheckLocalLanguageFileReturnsFalseWhenNoLocalFileExists()

◆ testCheckLocalLanguageFileReturnsTrueForAValidLocalFile()

◆ testCheckShippedLanguageIgnoresAnInvalidCustomizingFileThatMakesCheckLanguageFail()

◆ testCheckShippedLanguageRejectsAnInvalidGlobalLanguageFile()

◆ testCheckShippedLanguageRejectsAnUnparsableShippedPo()

◆ testGetAvailableLanguagesMapsObjIdAndStatusToTheCorrectLanguageNotSwapped()

◆ testGetAvailableLanguagesReturnsEmptyArrayWhenNoLanguagesAreKnown()

◆ testGetInstallableLanguagesExtractsKeysFromMainFilesAndIgnoresUnrelatedFiles()

◆ testGetInstallableLanguagesIgnoresAFileNameWithATrailingNewline()

◆ testGetInstallableLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName()

◆ testGetInstalledLanguagesQueriesForInstalledPrefixAndReturnsTitles()

◆ testGetInstalledLocalLanguagesQueriesForExactlyInstalledLocalAndReturnsTitles()

◆ testGetLanguageEntriesQueryDoesNotFilterByLocalChange()

◆ testGetLanguageEntriesReturnsEmptyArrayWhenNothingMatches()

◆ testGetLanguageEntriesStructuresResultAsModuleThenIdentifierThenValue()

◆ testGetLocalChangesDefaultsMinAndMaxDateWhenEmptyStringsArePassed()

◆ testGetLocalChangesKeepsExplicitlyGivenDatesInsteadOfDefaulting()

◆ testGetLocalChangesReturnsEmptyArrayWhenNothingMatches()

◆ testGetLocalChangesStructuresResultAsModuleThenIdentifierThenValue()

◆ testGetLocalLanguagesExtractsKeysFromLocalFilesAndIgnoresUnrelatedFiles()

◆ testGetLocalLanguagesIgnoresFilesWithAnInvalidLanguageKeyShapeInTheirName()

◆ testGetLocalLanguagesReturnsEmptyArrayWhenCustomizingDirectoryIsEmpty()

◆ unparsableShippedPo()