LanguageFileDirectoryManager.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Language\ComponentTranslation;
 
class LanguageFileDirectoryManager
{
    private array $directories;
 
    public function __construct(
        private readonly LanguageFileDirectory $local_directory,
        LanguageFileDirectory ...$global_directories
    ) {
        $this->directories = $global_directories;
        $this->check();
    }
 
    private function check(): void
    {
        if ($this->local_directory instanceof CustomizingLanguageFileDirectory) {
            if (!$this->local_directory->getPath()) {
                throw new \InvalidArgumentException(
                    "CustomizingLanguageFileDirectory must have a non-empty path"
                );
            }
            if ($this->local_directory->getPrefix() !== '') {
                throw new \InvalidArgumentException(
                    "CustomizingLanguageFileDirectory must have an empty prefix"
                );
            }
        }
        $main_files = 0;
        $prefixes = [];
        $shipped_files = [];
        foreach ($this->directories as $d) {
            switch (true) {
                case $d instanceof MainLanguageFileDirectory:
                    $main_files++;
                    if ($main_files > 1) {
                        throw new \InvalidArgumentException(
                            "There must not be more than one MainLanguageFileDirectory"
                        );
                    }
                    break;
                case $d instanceof ComponentLanguageFileDirectory:
                    if (empty($d->getPrefix())) {
                        throw new \InvalidArgumentException(
                            "ComponentLanguageFileDirectory must have a non-empty prefix"
                        );
                    }
                    if (isset($prefixes[$d->getPrefix()])) {
                        throw new \InvalidArgumentException(
                            "There must not be two ComponentLanguageFileDirectory with the same prefix"
                        );
                    }
                    $prefixes[$d->getPrefix()] = true;
                    break;
                default:
                    if (empty($d->getPrefix())) {
                        throw new \InvalidArgumentException("LanguageFileDirectory must have a non-empty prefix");
                    }
                    break;
            }
            // modules sharing a folder are told apart by their file names only
            if ($d->getPrefix() !== '') {
                try {
                    $files = rtrim($d->getPath(), '/') . '/' . MigratedLanguageFilePaths::shippedFileNamePattern($d);
                } catch (\InvalidArgumentException) {
                    // an invalid pattern only warns in the build, see ShippedTranslationsBuild
                    continue;
                }
                if (isset($shipped_files[$files])) {
                    throw new \InvalidArgumentException(
                        "There must not be two LanguageFileDirectory shipping the same files " . $files
                    );
                }
                $shipped_files[$files] = true;
            }
        }
    }
 
    public function getDirectories(): \Generator
    {
        yield from $this->directories;
    }
 
    public function getCustomizingDirectories(): \Generator
    {
        yield $this->local_directory;
    }
 
    public function getAllDirectories(): \Generator
    {
        yield from $this->getDirectories();
        yield from $this->getCustomizingDirectories();
    }
}