AddLanguageEntryTestFixture.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Language\Tests\Activities;
 
use ILIAS\Language\Activities\AddLanguageEntry;
use ILIAS\Language\Activities\RepositoryProvider;
use ILIAS\Language\Language;
use ILIAS\Language\Setup\InstalledLanguageRepository;
 
trait AddLanguageEntryTestFixture
{
    protected function spyReplaceLangEntry(array &$calls): \Closure
    {
        return static function (
            string $module,
            string $identifier,
            string $lang_key,
            string $value,
            string $local_change,
            string $remarks
        ) use (&$calls): bool {
            $calls['replace'][] = [$module, $identifier, $lang_key, $value, $local_change, $remarks];
            return true;
        };
    }
 
    protected function spyUpdateModuleCache(array &$calls): \Closure
    {
        return static function (
            string $lang_key,
            string $module,
            string $identifier,
            string $value,
            string $remarks = ''
        ) use (&$calls): void {
            $calls['cache'][] = [$lang_key, $module, $identifier, $value];
        };
    }
 
    protected function createActivity(
        array $installed_languages,
        ?\ilRbacSystem $rbac = null,
        ?Language $language = null,
        ?InstalledLanguageRepository $installed_language_repository = null,
        int $language_folder_ref_id = 0,
        ?\Closure $replace_lang_entry = null,
        ?\Closure $update_module_cache = null,
        ?\Closure $user_login = null,
        ?\Closure $languages_without_plural_form = null,
        ?\Closure $duplicates_of = null,
        ?\Closure $has_unreadable_content = null,
    ): AddLanguageEntry {
        // no-op defaults; tests proving a closure is never called pass a throwing one
        $replace_lang_entry ??= static fn(
            string $module,
            string $identifier,
            string $lang_key,
            string $value,
            string $local_change,
            string $remarks
        ): bool => true;
        $update_module_cache ??= static fn(
            string $lang_key,
            string $module,
            string $identifier,
            string $value,
            string $remarks = ''
        ): bool => true;
        $user_login ??= static fn(int $usr_id): string => 'default-login';
        $languages_without_plural_form ??= static fn(string $module, string $identifier, array $lang_keys): array => [];
        $duplicates_of ??= static fn(string $module, string $identifier): array => [];
        $has_unreadable_content ??= static fn(string $lang_key, string $module): bool => false;
        $installed_language_repository ??= new FakeInstalledLanguageRepository(static fn(): array => $installed_languages);
 
        $repository = $this->createStub(RepositoryProvider::class);
        $repository->method('getInstalledLanguages')->willReturnCallback(
            static fn(): array => $installed_language_repository->getInstalledLanguages()
        );
        $repository->method('replaceLangEntry')->willReturnCallback($replace_lang_entry);
        $repository->method('updateModuleCache')->willReturnCallback(
            static fn(
                string $lang_key,
                string $module,
                string $identifier,
                string $value,
                string $remarks = ''
            ): bool => $update_module_cache($lang_key, $module, $identifier, $value, $remarks) ?? true
        );
        $repository->method('lookupLogin')->willReturnCallback($user_login);
        $repository->method('hasUnreadableContent')->willReturnCallback($has_unreadable_content);
        $repository->method('languagesWithoutPluralForm')->willReturnCallback($languages_without_plural_form);
        $repository->method('findDuplicatesOf')->willReturnCallback($duplicates_of);
 
        return new AddLanguageEntry(
            $language ?? $this->createStub(Language::class),
            $this->rbacOf($rbac ?? $this->createStub(\ilRbacSystem::class)),
            $this->languageFolder($language_folder_ref_id),
            $repository,
        );
    }
}