Translator::getSimpleMessageFormatter() - Code Metrics - Inspection of "Fix #72: Use `SimpleMessageFormatter` to format me..." - yiisoft/translator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( bfa12e...cd3045 )

by Alexander

created 2022-10-16 11:12 UTC

Translator::getSimpleMessageFormatter() A

↳ Parent: Translator

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Translator;

use Psr\EventDispatcher\EventDispatcherInterface;
use RuntimeException;
use Yiisoft\I18n\Locale;
use Yiisoft\Translator\Event\MissingTranslationCategoryEvent;
use Yiisoft\Translator\Event\MissingTranslationEvent;

/**
 * Translator translates a message into the specified language.
 */
final class Translator implements TranslatorInterface
{
    private string $defaultCategory = 'app';
    private string $locale;
    private ?string $fallbackLocale;
    private ?EventDispatcherInterface $eventDispatcher;

    /**
     * @var CategorySource[][] Array of category message sources indexed by category names.
     */
    private array $categorySources = [];

    private ?SimpleMessageFormatter $simpleMessageFormatter = null;

    /**
     * @param string $locale Default locale to use if locale is not specified explicitly.
     * @param string|null $fallbackLocale Locale to use if message for the locale specified was not found. Null for none.
     * @param EventDispatcherInterface|null $eventDispatcher Event dispatcher for translation events. Null for none.
     */
    public function __construct(
        string $locale,
        ?string $fallbackLocale = null,
        ?EventDispatcherInterface $eventDispatcher = null
    ) {
        $this->locale = $locale;
        $this->fallbackLocale = $fallbackLocale;
        $this->eventDispatcher = $eventDispatcher;
    }

    public function addCategorySource(CategorySource $category): void
    {
        if (isset($this->categorySources[$category->getName()])) {
            $this->categorySources[$category->getName()][] = $category;
        } else {
            $this->categorySources[$category->getName()] = [$category];
        }
    }

    public function addCategorySources(array $categories): void
    {
        foreach ($categories as $category) {
            $this->addCategorySource($category);
        }
    }

    public function setLocale(string $locale): void
    {
        $this->locale = $locale;
    }

    public function getLocale(): string
    {
        return $this->locale;
    }

    public function translate(
        string $id,
        array $parameters = [],
        string $category = null,
        string $locale = null
    ): string {
        $locale = $locale ?? $this->locale;

        $category = $category ?? $this->defaultCategory;

        if (empty($this->categorySources[$category])) {
            if ($this->eventDispatcher !== null) {
                $this->eventDispatcher->dispatch(new MissingTranslationCategoryEvent($category));
            }
            return $this->getSimpleMessageFormatter()->format($id, $parameters);
        }

        return $this->translateUsingCategorySources($id, $parameters, $category, $locale);
    }

    /**
     * @psalm-immutable
     */
    public function withCategory(string $category): self
    {
        if (!isset($this->categorySources[$category])) {
            throw new RuntimeException('Category with name "' . $category . '" does not exist.');
        }

        $new = clone $this;
        $new->defaultCategory = $category;
        return $new;
    }

    public function withLocale(string $locale): self
    {
        $new = clone $this;
        $new->setLocale($locale);
        return $new;
    }

    private function translateUsingCategorySources(
        string $id,
        array $parameters,
        string $category,
        string $locale
    ): string {
        $sourceCategory = end($this->categorySources[$category]);
        do {
            $message = $sourceCategory->getMessage($id, $locale, $parameters);

            if ($message !== null) {
                return $sourceCategory->format($message, $parameters, $locale);
            }

            if ($this->eventDispatcher !== null) {
                $this->eventDispatcher->dispatch(new MissingTranslationEvent($sourceCategory->getName(), $locale, $id));
            }
        } while (($sourceCategory = prev($this->categorySources[$category])) !== false);

        $localeObject = new Locale($locale);
        $fallback = $localeObject->fallbackLocale();

        if ($fallback->asString() !== $localeObject->asString()) {
            return $this->translateUsingCategorySources($id, $parameters, $category, $fallback->asString());
        }

        if (!empty($this->fallbackLocale)) {
            $fallbackLocaleObject = (new Locale($this->fallbackLocale))->fallbackLocale();
            if ($fallbackLocaleObject->asString() !== $localeObject->asString()) {
                return $this->translateUsingCategorySources($id, $parameters, $category, $fallbackLocaleObject->asString());
            }
        }

        $categorySource = end($this->categorySources[$category]);
        return $categorySource->format($id, $parameters, $locale);
    }

    private function getSimpleMessageFormatter(): SimpleMessageFormatter
    {
        if ($this->simpleMessageFormatter === null) {
            $this->simpleMessageFormatter = new SimpleMessageFormatter();
        }
        return $this->simpleMessageFormatter;

    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Translator;
6
7		use Psr\EventDispatcher\EventDispatcherInterface;
8		use RuntimeException;
9		use Yiisoft\I18n\Locale;
10		use Yiisoft\Translator\Event\MissingTranslationCategoryEvent;
11		use Yiisoft\Translator\Event\MissingTranslationEvent;
12
13		/**
14		* Translator translates a message into the specified language.
15		*/
16		final class Translator implements TranslatorInterface
17		{
18		private string $defaultCategory = 'app';
19		private string $locale;
20		private ?string $fallbackLocale;
21		private ?EventDispatcherInterface $eventDispatcher;
22
23		/**
24		* @var CategorySource[][] Array of category message sources indexed by category names.
25		*/
26		private array $categorySources = [];
27
28		private ?SimpleMessageFormatter $simpleMessageFormatter = null;
29
30		/**
31		* @param string $locale Default locale to use if locale is not specified explicitly.
32		* @param string\|null $fallbackLocale Locale to use if message for the locale specified was not found. Null for none.
33		* @param EventDispatcherInterface\|null $eventDispatcher Event dispatcher for translation events. Null for none.
34		*/
35	54	public function __construct(
36		string $locale,
37		?string $fallbackLocale = null,
38		?EventDispatcherInterface $eventDispatcher = null
39		) {
40	54	$this->locale = $locale;
41	54	$this->fallbackLocale = $fallbackLocale;
42	54	$this->eventDispatcher = $eventDispatcher;
43		}
44
45	52	public function addCategorySource(CategorySource $category): void
46		{
47	52	if (isset($this->categorySources[$category->getName()])) {
48	14	$this->categorySources[$category->getName()][] = $category;
49		} else {
50	52	$this->categorySources[$category->getName()] = [$category];
51		}
52		}
53
54	15	public function addCategorySources(array $categories): void
55		{
56	15	foreach ($categories as $category) {
57	15	$this->addCategorySource($category);
58		}
59		}
60
61	3	public function setLocale(string $locale): void
62		{
63	3	$this->locale = $locale;
64		}
65
66	3	public function getLocale(): string
67		{
68	3	return $this->locale;
69		}
70
71	52	public function translate(
72		string $id,
73		array $parameters = [],
74		string $category = null,
75		string $locale = null
76		): string {
77	52	$locale = $locale ?? $this->locale;
78
79	52	$category = $category ?? $this->defaultCategory;
80
81	52	if (empty($this->categorySources[$category])) {
82	3	if ($this->eventDispatcher !== null) {
83	2	$this->eventDispatcher->dispatch(new MissingTranslationCategoryEvent($category));
84		}
85	3	return $this->getSimpleMessageFormatter()->format($id, $parameters);
86		}
87
88	49	return $this->translateUsingCategorySources($id, $parameters, $category, $locale);
89		}
90
91		/**
92		* @psalm-immutable
93		*/
94	2	public function withCategory(string $category): self
95		{
96	2	if (!isset($this->categorySources[$category])) {
97	1	throw new RuntimeException('Category with name "' . $category . '" does not exist.');
98		}
99
100	1	$new = clone $this;
101	1	$new->defaultCategory = $category;
102	1	return $new;
103		}
104
105	1	public function withLocale(string $locale): self
106		{
107	1	$new = clone $this;
108	1	$new->setLocale($locale);
109	1	return $new;
110		}
111
112	49	private function translateUsingCategorySources(
113		string $id,
114		array $parameters,
115		string $category,
116		string $locale
117		): string {
118	49	$sourceCategory = end($this->categorySources[$category]);
119		do {
120	49	$message = $sourceCategory->getMessage($id, $locale, $parameters);
121
122	49	if ($message !== null) {
123	36	return $sourceCategory->format($message, $parameters, $locale);
124		}
125
126	31	if ($this->eventDispatcher !== null) {
127	12	$this->eventDispatcher->dispatch(new MissingTranslationEvent($sourceCategory->getName(), $locale, $id));
128		}
129	31	} while (($sourceCategory = prev($this->categorySources[$category])) !== false);
130
131	26	$localeObject = new Locale($locale);
132	26	$fallback = $localeObject->fallbackLocale();
133
134	26	if ($fallback->asString() !== $localeObject->asString()) {
135	14	return $this->translateUsingCategorySources($id, $parameters, $category, $fallback->asString());
136		}
137
138	19	if (!empty($this->fallbackLocale)) {
139	10	$fallbackLocaleObject = (new Locale($this->fallbackLocale))->fallbackLocale();
140	10	if ($fallbackLocaleObject->asString() !== $localeObject->asString()) {
141	9	return $this->translateUsingCategorySources($id, $parameters, $category, $fallbackLocaleObject->asString());
142		}
143		}
144
145	13	$categorySource = end($this->categorySources[$category]);
146	13	return $categorySource->format($id, $parameters, $locale);
147		}
148
149	3	private function getSimpleMessageFormatter(): SimpleMessageFormatter
150		{
151	3	if ($this->simpleMessageFormatter === null) {
152	3	$this->simpleMessageFormatter = new SimpleMessageFormatter();
153		}
154	3	return $this->simpleMessageFormatter;
		0 ignored issues – show Bug Best Practice introduced 2022-10-15 11:49 UTC by Report Bug Copy Issue Report The expression `return $this->simpleMessageFormatter` could return the type `null` which is incompatible with the type-hinted return `Yiisoft\Translator\SimpleMessageFormatter`. Consider adding an additional type-check to rule them out. Loading history...
155		}
156		}
157

yiisoft / translator

Push — master ( bfa12e...cd3045 )

Translator::getSimpleMessageFormatter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like