ilObjLanguageFolderGUITestFixture.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Language\Activities\InstallLanguage;
use ILIAS\Language\Activities\UpdateLanguage;
use ILIAS\Language\Activities\UninstallLanguage;
use ILIAS\Language\Activities\RemoveLocalLanguageChanges;
 
trait ilObjLanguageFolderGUITestFixture
{
    use ilObjLanguageGuiTestSupport;
 
    private function createGuiWithCollaborators(
        InstallLanguage $install_language,
        ilGlobalTemplateInterface $tpl,
        ilCtrl $ctrl,
        ilLanguage $lng
    ): ilObjLanguageFolderGUI {
        $gui = $this->newGuiWithoutConstructor(ilObjLanguageFolderGUI::class);
 
        $this->inject($gui, 'install_language', $install_language);
        $this->inject($gui, 'current_user_id', 6);
        $this->inject($gui, 'tpl', $tpl);
        $this->inject($gui, 'ctrl', $ctrl);
        $this->inject($gui, 'lng', $lng);
        $this->inject($gui, 'activity_error_logger', $this->activityErrorLoggerForGui());
        $this->inject($gui, 'ui_factory', $this->stubUiFactoryForMaybePerformAs());
 
        return $gui;
    }
 
    private function emptyPerformResult(): array
    {
        return [
            'installed_language_keys' => [],
            'installed_with_local_language_keys' => [],
            'already_installed_language_keys' => [],
            'not_installed_language_keys' => [],
            'invalid_local_language_files' => [],
        ];
    }
 
    private function createGuiWithUpdateLanguageCollaborators(
        UpdateLanguage $update_language,
        ilGlobalTemplateInterface $tpl,
        ilCtrl $ctrl,
        ilLanguage $lng
    ): ilObjLanguageFolderGUI {
        $gui = $this->newGuiWithoutConstructor(ilObjLanguageFolderGUI::class);
 
        $this->inject($gui, 'update_language', $update_language);
        $this->inject($gui, 'current_user_id', 6);
        $this->inject($gui, 'tpl', $tpl);
        $this->inject($gui, 'ctrl', $ctrl);
        $this->inject($gui, 'lng', $lng);
        $this->inject($gui, 'activity_error_logger', $this->activityErrorLoggerForGui());
        $this->inject($gui, 'ui_factory', $this->stubUiFactoryForMaybePerformAs());
 
        return $gui;
    }
 
    private function stubComponentRepositoryWithNoPlugins(): void
    {
        $repository = $this->createStub(ilComponentRepository::class);
        $repository->method('getPlugins')->willReturn(new ArrayIterator([]));
 
        $GLOBALS['DIC'] = new \ILIAS\DI\Container();
        $GLOBALS['DIC']['component.repository'] = $repository;
    }
 
    private function createGuiWithUninstallLanguageCollaborators(
        UninstallLanguage $uninstall_language,
        ilGlobalTemplateInterface $tpl,
        ilCtrl $ctrl,
        ilLanguage $lng
    ): ilObjLanguageFolderGUI {
        $gui = $this->newGuiWithoutConstructor(ilObjLanguageFolderGUI::class);
 
        $this->inject($gui, 'uninstall_language', $uninstall_language);
        $this->inject($gui, 'current_user_id', 6);
        $this->inject($gui, 'tpl', $tpl);
        $this->inject($gui, 'ctrl', $ctrl);
        $this->inject($gui, 'lng', $lng);
        $this->inject($gui, 'activity_error_logger', $this->activityErrorLoggerForGui());
        $this->inject($gui, 'ui_factory', $this->stubUiFactoryForMaybePerformAs());
 
        return $gui;
    }
 
    private function uninstallPerformResult(
        array $uninstalled,
        array $system,
        array $user,
        array $not_installed
    ): array {
        return [
            'uninstalled_language_keys' => $uninstalled,
            'system_language_keys' => $system,
            'user_language_keys' => $user,
            'not_installed_language_keys' => $not_installed,
        ];
    }
 
    private function createGuiWithRemoveLocalLanguageChangesCollaborators(
        RemoveLocalLanguageChanges $remove_local_language_changes,
        ilGlobalTemplateInterface $tpl,
        ilCtrl $ctrl,
        ilLanguage $lng
    ): ilObjLanguageFolderGUI {
        $gui = $this->newGuiWithoutConstructor(ilObjLanguageFolderGUI::class);
 
        $this->inject($gui, 'remove_local_language_changes', $remove_local_language_changes);
        $this->inject($gui, 'current_user_id', 6);
        $this->inject($gui, 'tpl', $tpl);
        $this->inject($gui, 'ctrl', $ctrl);
        $this->inject($gui, 'lng', $lng);
        $this->inject($gui, 'activity_error_logger', $this->activityErrorLoggerForGui());
        $this->inject($gui, 'ui_factory', $this->stubUiFactoryForMaybePerformAs());
 
        return $gui;
    }
 
    private function removeLocalChangesPerformResult(
        array $removed_local_changes,
        array $invalid_language_file,
        array $not_installed
    ): array {
        return [
            'removed_local_changes_language_keys' => $removed_local_changes,
            'invalid_language_file_keys' => $invalid_language_file,
            'not_installed_language_keys' => $not_installed,
        ];
    }
 
    private function stubObjDataCache(
        array $types_by_id,
        array $titles_by_id = [],
        bool $expect_no_title_lookup = false
    ): void {
        if ($expect_no_title_lookup) {
            $cache = $this->createMock(\ilObjectDataCache::class);
            $cache->method('lookupType')->willReturnCallback(
                static fn(int $id): string => $types_by_id[$id] ?? ''
            );
            $cache->expects($this->never())->method('lookupTitle');
        } else {
            $cache = $this->createStub(\ilObjectDataCache::class);
            $cache->method('lookupType')->willReturnCallback(
                static fn(int $id): string => $types_by_id[$id] ?? ''
            );
            $cache->method('lookupTitle')->willReturnCallback(
                static fn(int $id): string => $titles_by_id[$id] ?? ''
            );
        }
 
        if (!isset($GLOBALS['DIC'])) {
            $GLOBALS['DIC'] = new \ILIAS\DI\Container();
        }
        $GLOBALS['DIC']['ilObjDataCache'] = $cache;
    }
 
    private function createLanguageMockWithFormatStrings(): ilLanguage&\PHPUnit\Framework\MockObject\Stub
    {
        $lng = $this->createStub(ilLanguage::class);
        $lng->method('txt')->willReturnCallback(
            static fn(string $topic): string => str_starts_with($topic, 'lng_') ? $topic . ': %s' : $topic
        );
 
        return $lng;
    }
 
    private function messageCollectingTemplate(array &$messages): ilGlobalTemplateInterface&\PHPUnit\Framework\MockObject\Stub
    {
        $tpl = $this->createStub(ilGlobalTemplateInterface::class);
        $tpl->method('setOnScreenMessage')->willReturnCallback(
            static function (string $type, string $message) use (&$messages): void {
                $messages[] = [$type, $message];
            }
        );
 
        return $tpl;
    }
}