TranslatorConfig::getDefaultLocale() - Code Metrics - Inspection of "Merge pull request #996 from spiral/feature/transl..." - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( fe8484...90b95a )

by butschster

created 2023-09-20 13:23 UTC

TranslatorConfig::getDefaultLocale() A

↳ Parent: TranslatorConfig

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?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{

     *     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();

    }

    /**
     * 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

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

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

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

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

     * @param non-empty-string|null $directory
     *
     * @return 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();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Spiral\Translator\Config;
6
7		use Spiral\Core\InjectableConfig;
8		use Spiral\Translator\Matcher;
9		use Symfony\Component\Translation\Dumper\DumperInterface;
10		use Symfony\Component\Translation\Loader\LoaderInterface;
11
12		final class TranslatorConfig extends InjectableConfig
13		{
14		/**
15		* Configuration section.
16		*/
17		public const CONFIG = 'translator';
18
19		/**
20		* @var array{
		0 ignored issues – show Documentation Bug introduced 2023-03-23 13:16 UTC by Report Bug Copy Issue Report The doc comment `array{` at position `2` could not be parsed: the token is null at position 2. Loading history...
21		* locale: string,
22		* fallbackLocale?: string,
23		* directory: non-empty-string,
24		* directories: array<array-key, non-empty-string>,
25		* localesDirectory?: non-empty-string,
26		* registerMessages?: bool,
27		* cacheLocales: bool,
28		* autoRegister: bool,
29		* domains: array<non-empty-string, array<string>>,
30		* loaders: class-string<LoaderInterface>[],
31		* dumpers: class-string<DumperInterface>[]
32		* }
33		*/
34		protected array $config = [
35		'locale' => '',
36		'directory' => '',
37		'directories' => [],
38		'cacheLocales' => true,
39		'autoRegister' => true,
40		'domains' => [],
41		'loaders' => [],
42		'dumpers' => [],
43		];
44
45		private readonly Matcher $matcher;
46
47	78	public function __construct(array $config = [])
48		{
49	78	parent::__construct($config);
50	78	$this->matcher = new Matcher();
		0 ignored issues – show Bug introduced 2022-09-13 07:04 UTC by Report Bug Copy Issue Report The property `matcher` is declared read-only in `Spiral\Translator\Config\TranslatorConfig`. Loading history...
51		}
52
53		/**
54		* Default translation domain.
55		*/
56	23	public function getDefaultDomain(): string
57		{
58	23	return 'messages';
59		}
60
61	47	public function getDefaultLocale(): string
62		{
63	47	return $this->config['locale'] ?? '';
64		}
65
66	19	public function getFallbackLocale(): string
67		{
68	19	return $this->config['fallbackLocale'] ?? $this->getDefaultLocale();
69		}
70
71	17	public function isAutoRegisterMessages(): bool
72		{
73	17	return !empty($this->config['autoRegister']) \|\| !empty($this->config['registerMessages']);
74		}
75
76		/**
77		* Returns application locales directory.
78		*
79		* @return non-empty-string
		0 ignored issues – show Documentation Bug introduced 2023-09-19 11:14 UTC by Report Bug Copy Issue Report 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. Loading history...
80		*/
81	51	public function getLocalesDirectory(): string
82		{
83	51	return $this->config['localesDirectory'] ?? $this->config['directory'] ?? '';
84		}
85
86		/**
87		* Returns additional locales directories.
88		*
89		* @return array<array-key, non-empty-string>
		0 ignored issues – show Documentation Bug introduced 2023-09-19 11:14 UTC by Report Bug Copy Issue Report 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>. Loading history...
90		*/
91	48	public function getDirectories(): array
92		{
93	48	return $this->config['directories'] ?? [];
94		}
95
96		/**
97		* @param non-empty-string $locale
		0 ignored issues – show Documentation Bug introduced 2022-10-18 09:11 UTC by Report Bug Copy Issue Report 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. Loading history...
98		* @param non-empty-string\|null $directory
99		*
100		* @return non-empty-string
		0 ignored issues – show Documentation Bug introduced 2023-09-19 11:14 UTC by Report Bug Copy Issue Report 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. Loading history...
101		*/
102	48	public function getLocaleDirectory(string $locale, ?string $directory = null): string
103		{
104	48	if ($directory !== null) {
105	45	return \rtrim($directory, '/') . '/' . $locale . '/';
106		}
107
108	14	return \trim($this->getLocalesDirectory(), '/') . '/' . $locale . '/';
109		}
110
111		/**
112		* Get domain name associated with given bundle.
113		*/
114	30	public function resolveDomain(string $bundle): string
115		{
116	30	$bundle = \strtolower(\str_replace(['/', '\\'], '-', $bundle));
117	30	$domains = (array) ($this->config['domains'] ?? []);
118
119	30	foreach ($domains as $domain => $patterns) {
120	30	foreach ($patterns as $pattern) {
121	30	if ($this->matcher->matches($bundle, $pattern)) {
122	29	return $domain;
123		}
124		}
125		}
126
127		//We can use bundle itself as domain
128	1	return $bundle;
129		}
130
131	41	public function hasLoader(string $extension): bool
132		{
133	41	return isset($this->config['loaders'][$extension]);
134		}
135
136	41	public function getLoader(string $extension): LoaderInterface
137		{
138	41	$class = $this->config['loaders'][$extension];
139
140	41	return new $class();
141		}
142
143	2	public function hasDumper(string $dumper): bool
144		{
145	2	return isset($this->config['dumpers'][$dumper]);
146		}
147
148	2	public function getDumper(string $dumper): DumperInterface
149		{
150	2	$class = $this->config['dumpers'][$dumper];
151
152	2	return new $class();
153		}
154		}
155

spiral / framework

Push — master ( fe8484...90b95a )

TranslatorConfig::getDefaultLocale() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like