FallbackTranslator::getLocale() - Code Metrics - Inspection of "Merge pull request #353 from odolbeau/deal-with-tr..." - php-translation/symfony-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8bad7f...f84ff2 )

by Olivier

created 2019-12-01 16:16 UTC

FallbackTranslator::getLocale() A

↳ Parent: FallbackTranslator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Translator;

use Symfony\Component\Translation\MessageCatalogueInterface;
use Symfony\Component\Translation\TranslatorBagInterface;
use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;
use Symfony\Contracts\Translation\LocaleAwareInterface;
use Symfony\Contracts\Translation\TranslatorInterface as NewTranslatorInterface;
use Translation\Translator\Translator;

/**
 * This is a bridge between Symfony's translator service and Translation\Translator\Translator.
 *
 * @author Tobias Nyholm <[email protected]>
 */
final class FallbackTranslator implements TranslatorInterface
{
    /**
     * @var LegacyTranslatorInterface|NewTranslatorInterface
     */
    private $symfonyTranslator;

    /**
     * @var Translator
     */
    private $externalTranslator;

    /**
     * @var string
     */
    private $defaultLocale;

    /**
     * $symfonyTranslator param can't be type hinted as we have to deal with both LegacyTranslatorInterface & NewTranslatorInterface.
     * Once we won't support sf ^3.4 anymore, we will be able to type hint $symfonyTranslator with NewTranslatorInterface.
     *
     * @param LegacyTranslatorInterface|NewTranslatorInterface $symfonyTranslator
     */
    public function __construct(string $defaultLocale, $symfonyTranslator, Translator $externalTranslator)
    {
        if (!$symfonyTranslator instanceof LegacyTranslatorInterface && !$symfonyTranslator instanceof LocaleAwareInterface) {
            throw new \InvalidArgumentException('The given translator must implements LocaleAwareInterface.');
        }

        if (!$symfonyTranslator instanceof TranslatorBagInterface) {
            throw new \InvalidArgumentException('The given translator must implements TranslatorBagInterface.');
        }

        $this->symfonyTranslator = $symfonyTranslator;
        $this->externalTranslator = $externalTranslator;
        $this->defaultLocale = $defaultLocale;
    }

    /**
     * {@inheritdoc}
     */
    public function trans($id, array $parameters = [], $domain = null, $locale = null): string

    {
        $id = (string) $id;
        if (empty($domain)) {
            $domain = 'messages';
        }

        $catalogue = $this->getCatalogue($locale);
        if ($catalogue->defines($id, $domain)) {
            return $this->symfonyTranslator->trans($id, $parameters, $domain, $locale);
        }

        $locale = $catalogue->getLocale();
        if (empty($locale) || $locale === $this->defaultLocale) {
            // we cant do anything...
            return $id;
        }

        $orgString = $this->symfonyTranslator->trans($id, $parameters, $domain, $this->defaultLocale);

        return $this->translateWithSubstitutedParameters($orgString, $locale, $parameters);
    }

    /**
     * {@inheritdoc}
     */
    public function transChoice($id, $number, array $parameters = [], $domain = null, $locale = null): string

    {
        $id = (string) $id;
        if (empty($domain)) {
            $domain = 'messages';
        }

        $catalogue = $this->getCatalogue($locale);
        if ($catalogue->defines($id, $domain)) {
            return $this->symfonyTranslator->transChoice($id, $number, $parameters, $domain, $locale);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
        }

        $locale = $catalogue->getLocale();
        if ($locale === $this->defaultLocale) {
            // we cant do anything...
            return $id;
        }

        $orgString = $this->symfonyTranslator->transChoice($id, $number, $parameters, $domain, $this->defaultLocale);

        return $this->translateWithSubstitutedParameters($orgString, $locale, $parameters);
    }

    /**
     * {@inheritdoc}
     */
    public function setLocale($locale): void
    {
        $this->symfonyTranslator->setLocale($locale);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * {@inheritdoc}
     */
    public function getLocale(): string
    {
        return $this->symfonyTranslator->getLocale();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * {@inheritdoc}
     */
    public function getCatalogue($locale = null): MessageCatalogueInterface
    {
        return $this->symfonyTranslator->getCatalogue($locale);
    }

    /**
     * Passes through all unknown calls onto the translator object.
     */
    public function __call(string $method, array $args)
    {
        return \call_user_func_array([$this->symfonyTranslator, $method], $args);
    }

    /**
     * @param string $orgString This is the string in the default locale. It has the values of $parameters in the string already.
     * @param string $locale    you wan to translate to
     */
    private function translateWithSubstitutedParameters(string $orgString, string $locale, array $parameters): string
    {
        // Replace parameters
        $replacements = [];
        foreach ($parameters as $placeholder => $nonTranslatableValue) {
            $replacements[(string) $nonTranslatableValue] = \sha1($placeholder);
        }

        $replacedString = \str_replace(\array_keys($replacements), \array_values($replacements), $orgString);
        $translatedString = $this->externalTranslator->translate($replacedString, $this->defaultLocale, $locale);

        if (null === $translatedString) {
            // Could not be translated
            return $orgString;
        }

        return \str_replace(\array_values($replacements), \array_keys($replacements), $translatedString);
    }
}


1			<?php
2
3			/*
4			* This file is part of the PHP Translation package.
5			*
6			* (c) PHP Translation team <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Translation\Bundle\Translator;
13
14			use Symfony\Component\Translation\MessageCatalogueInterface;
15			use Symfony\Component\Translation\TranslatorBagInterface;
16			use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;
17			use Symfony\Contracts\Translation\LocaleAwareInterface;
18			use Symfony\Contracts\Translation\TranslatorInterface as NewTranslatorInterface;
19			use Translation\Translator\Translator;
20
21			/**
22			* This is a bridge between Symfony's translator service and Translation\Translator\Translator.
23			*
24			* @author Tobias Nyholm <[email protected]>
25			*/
26			final class FallbackTranslator implements TranslatorInterface
27			{
28			/**
29			* @var LegacyTranslatorInterface\|NewTranslatorInterface
30			*/
31			private $symfonyTranslator;
32
33			/**
34			* @var Translator
35			*/
36			private $externalTranslator;
37
38			/**
39			* @var string
40			*/
41			private $defaultLocale;
42
43			/**
44			* $symfonyTranslator param can't be type hinted as we have to deal with both LegacyTranslatorInterface & NewTranslatorInterface.
45			* Once we won't support sf ^3.4 anymore, we will be able to type hint $symfonyTranslator with NewTranslatorInterface.
46			*
47			* @param LegacyTranslatorInterface\|NewTranslatorInterface $symfonyTranslator
48			*/
49	2		public function __construct(string $defaultLocale, $symfonyTranslator, Translator $externalTranslator)
50			{
51	2		if (!$symfonyTranslator instanceof LegacyTranslatorInterface && !$symfonyTranslator instanceof LocaleAwareInterface) {
52	1		throw new \InvalidArgumentException('The given translator must implements LocaleAwareInterface.');
53			}
54
55	1		if (!$symfonyTranslator instanceof TranslatorBagInterface) {
56			throw new \InvalidArgumentException('The given translator must implements TranslatorBagInterface.');
57			}
58
59	1		$this->symfonyTranslator = $symfonyTranslator;
60	1		$this->externalTranslator = $externalTranslator;
61	1		$this->defaultLocale = $defaultLocale;
62	1		}
63
64			/**
65			* {@inheritdoc}
66			*/
67		View Code Duplication	public function trans($id, array $parameters = [], $domain = null, $locale = null): string
			0 ignored issues – show Duplication introduced 2017-08-17 05:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
68			{
69			$id = (string) $id;
70			if (empty($domain)) {
71			$domain = 'messages';
72			}
73
74			$catalogue = $this->getCatalogue($locale);
75			if ($catalogue->defines($id, $domain)) {
76			return $this->symfonyTranslator->trans($id, $parameters, $domain, $locale);
77			}
78
79			$locale = $catalogue->getLocale();
80			if (empty($locale) \|\| $locale === $this->defaultLocale) {
81			// we cant do anything...
82			return $id;
83			}
84
85			$orgString = $this->symfonyTranslator->trans($id, $parameters, $domain, $this->defaultLocale);
86
87			return $this->translateWithSubstitutedParameters($orgString, $locale, $parameters);
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93		View Code Duplication	public function transChoice($id, $number, array $parameters = [], $domain = null, $locale = null): string
			0 ignored issues – show Duplication introduced 2017-08-17 05:33 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94			{
95			$id = (string) $id;
96			if (empty($domain)) {
97			$domain = 'messages';
98			}
99
100			$catalogue = $this->getCatalogue($locale);
101			if ($catalogue->defines($id, $domain)) {
102			return $this->symfonyTranslator->transChoice($id, $number, $parameters, $domain, $locale);
			0 ignored issues – show Bug introduced 2019-12-01 16:18 UTC by Report Bug Copy Issue Report The method `transChoice` does only exist in `Symfony\Component\Translation\TranslatorInterface`, but not in `Symfony\Contracts\Translation\TranslatorInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
103			}
104
105			$locale = $catalogue->getLocale();
106			if ($locale === $this->defaultLocale) {
107			// we cant do anything...
108			return $id;
109			}
110
111			$orgString = $this->symfonyTranslator->transChoice($id, $number, $parameters, $domain, $this->defaultLocale);
112
113			return $this->translateWithSubstitutedParameters($orgString, $locale, $parameters);
114			}
115
116			/**
117			* {@inheritdoc}
118			*/
119			public function setLocale($locale): void
120			{
121			$this->symfonyTranslator->setLocale($locale);
			0 ignored issues – show Bug introduced 2019-12-01 16:18 UTC by Report Bug Copy Issue Report The method `setLocale` does only exist in `Symfony\Component\Translation\TranslatorInterface`, but not in `Symfony\Contracts\Translation\TranslatorInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
122			}
123
124			/**
125			* {@inheritdoc}
126			*/
127			public function getLocale(): string
128			{
129			return $this->symfonyTranslator->getLocale();
			0 ignored issues – show Bug introduced 2019-12-01 16:18 UTC by Report Bug Copy Issue Report The method `getLocale` does only exist in `Symfony\Component\Translation\TranslatorInterface`, but not in `Symfony\Contracts\Translation\TranslatorInterface`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
130			}
131
132			/**
133			* {@inheritdoc}
134			*/
135			public function getCatalogue($locale = null): MessageCatalogueInterface
136			{
137			return $this->symfonyTranslator->getCatalogue($locale);
138			}
139
140			/**
141			* Passes through all unknown calls onto the translator object.
142			*/
143			public function __call(string $method, array $args)
144			{
145			return \call_user_func_array([$this->symfonyTranslator, $method], $args);
146			}
147
148			/**
149			* @param string $orgString This is the string in the default locale. It has the values of $parameters in the string already.
150			* @param string $locale you wan to translate to
151			*/
152	1		private function translateWithSubstitutedParameters(string $orgString, string $locale, array $parameters): string
153			{
154			// Replace parameters
155	1		$replacements = [];
156	1		foreach ($parameters as $placeholder => $nonTranslatableValue) {
157	1		$replacements[(string) $nonTranslatableValue] = \sha1($placeholder);
158			}
159
160	1		$replacedString = \str_replace(\array_keys($replacements), \array_values($replacements), $orgString);
161	1		$translatedString = $this->externalTranslator->translate($replacedString, $this->defaultLocale, $locale);
162
163	1		if (null === $translatedString) {
164			// Could not be translated
165			return $orgString;
166			}
167
168	1		return \str_replace(\array_values($replacements), \array_keys($replacements), $translatedString);
169			}
170			}
171

php-translation / symfony-bundle

Push — master ( 8bad7f...f84ff2 )

FallbackTranslator::getLocale() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like