Spiral\Translator\Config\TranslatorConfig

Complexity

Total Complexity

18

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getDirectories()	0	3	1
A	__construct()	0	4	1
A	getFallbackLocale()	0	3	1
A	resolveDomain()	0	15	4
A	getLocaleDirectory()	0	7	2
A	getDefaultLocale()	0	3	1
A	isAutoRegisterMessages()	0	3	2
A	hasLoader()	0	3	1
A	getLoader()	0	5	1
A	getLocalesDirectory()	0	3	1
A	getDumper()	0	5	1
A	hasDumper()	0	3	1
A	getDefaultDomain()	0	3	1

<?php

declare(strict_types=1);

namespace Spiral\Translator\Config;

use Spiral\Core\InjectableConfig;
use Spiral\Translator\Matcher;
use Symfony\Component\Translation\Dumper\DumperInterface;
use Symfony\Component\Translation\Loader\LoaderInterface;

final class TranslatorConfig extends InjectableConfig
{
    /**
     * Configuration section.
     */
    public const CONFIG = 'translator';

    /**
     * @var array{

The doc comment array{ at position 2 could not be parsed: the token is null at position 2.

     *     locale: string,
     *     fallbackLocale?: string,
     *     directory: non-empty-string,
     *     directories: array<array-key, non-empty-string>,
     *     localesDirectory?: non-empty-string,
     *     registerMessages?: bool,
     *     cacheLocales: bool,
     *     autoRegister: bool,
     *     domains: array<non-empty-string, array<string>>,
     *     loaders: class-string<LoaderInterface>[],
     *     dumpers: class-string<DumperInterface>[]
     * }
     */
    protected array $config = [
        'locale'         => '',
        'directory'      => '',
        'directories'    => [],
        'cacheLocales'   => true,
        'autoRegister'   => true,
        'domains'        => [],
        'loaders'        => [],
        'dumpers'        => [],
    ];

    private readonly Matcher $matcher;

    public function __construct(array $config = [])
    {
        parent::__construct($config);
        $this->matcher = new Matcher();

The property matcher is declared read-only in Spiral\Translator\Config\TranslatorConfig.

    }

    /**
     * Default translation domain.
     */
    public function getDefaultDomain(): string
    {
        return 'messages';
    }

    public function getDefaultLocale(): string
    {
        return $this->config['locale'] ?? '';
    }

    public function getFallbackLocale(): string
    {
        return $this->config['fallbackLocale'] ?? $this->getDefaultLocale();
    }

    public function isAutoRegisterMessages(): bool
    {
        return !empty($this->config['autoRegister']) || !empty($this->config['registerMessages']);
    }

    /**
     * Returns application locales directory.
     *
     * @return non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function getLocalesDirectory(): string
    {
        return $this->config['localesDirectory'] ?? $this->config['directory'] ?? '';
    }

    /**
     * Returns additional locales directories.
     *
     * @return array<array-key, non-empty-string>

The doc comment array<array-key, non-empty-string> at position 2 could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, non-empty-string>.

     */
    public function getDirectories(): array
    {
        return $this->config['directories'] ?? [];
    }

    /**
     * @param non-empty-string $locale

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     * @param non-empty-string|null $directory
     *
     * @return non-empty-string

The doc comment non-empty-string at position 0 could not be parsed: Unknown type name 'non-empty-string' at position 0 in non-empty-string.

     */
    public function getLocaleDirectory(string $locale, ?string $directory = null): string
    {
        if ($directory !== null) {
            return \rtrim($directory, '/') . '/' . $locale . '/';
        }

        return \trim($this->getLocalesDirectory(), '/') . '/' . $locale . '/';
    }

    /**
     * Get domain name associated with given bundle.
     */
    public function resolveDomain(string $bundle): string
    {
        $bundle = \strtolower(\str_replace(['/', '\\'], '-', $bundle));
        $domains = (array) ($this->config['domains'] ?? []);

        foreach ($domains as $domain => $patterns) {
            foreach ($patterns as $pattern) {
                if ($this->matcher->matches($bundle, $pattern)) {
                    return $domain;
                }
            }
        }

        //We can use bundle itself as domain
        return $bundle;
    }

    public function hasLoader(string $extension): bool
    {
        return isset($this->config['loaders'][$extension]);
    }

    public function getLoader(string $extension): LoaderInterface
    {
        $class = $this->config['loaders'][$extension];

        return new $class();
    }

    public function hasDumper(string $dumper): bool
    {
        return isset($this->config['dumpers'][$dumper]);
    }

    public function getDumper(string $dumper): DumperInterface
    {
        $class = $this->config['dumpers'][$dumper];

        return new $class();
    }
}