TranslationLoader::getTranslationFilePatterns() - Code Metrics - Inspection of "Update JMS format converter (#8)" - php-translation/converter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 34d733...90b7c0 )

by Tobias

created 2019-05-16 02:52 UTC

TranslationLoader::getTranslationFilePatterns() A

↳ Parent: TranslationLoader

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	13
ccs	0
cts	0
cp	0
rs	9.8333
c	0
b	0
f	0
cc	4
nc	4
nop	1
crap	20

<?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\Converter\Loader;

use Symfony\Component\Finder\Finder;
use Symfony\Component\Translation\Loader\LoaderInterface;
use Symfony\Component\Translation\MessageCatalogue;
use Translation\SymfonyStorage\TranslationLoader as TranslationLoaderInterface;

class TranslationLoader implements TranslationLoaderInterface

{
    /**
     * @var LoaderInterface
     */
    private $loader;

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

    /**
     * @param LoaderInterface $loader
     * @param string|string[] $format
     */
    public function __construct(LoaderInterface $loader, $format)
    {
        $this->loader = $loader;
        $this->format = $format;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Loads translation messages from a directory to the catalogue.
     *
     * @param string           $directory the directory to look into
     * @param MessageCatalogue $catalogue the catalogue
     *
     * @deprecated Use read instead.
     */
    public function loadMessages($directory, MessageCatalogue $catalogue)
    {
        return $this->read($directory, $catalogue);
    }

    /**
     * Loads translation messages from a directory to the catalogue.
     *
     * @param string           $directory the directory to look into
     * @param MessageCatalogue $catalogue the catalogue
     */
    public function read($directory, MessageCatalogue $catalogue)
    {
        if (!is_dir($directory)) {
            return;
        }

        // load any existing translation files
        $patterns = $this->getTranslationFilePatterns($catalogue);
        $files = $this->getTranslationFiles($directory, $patterns);
        foreach ($files as $file) {
            $domain = $this->getDomainFromFilename($file->getFilename(), $patterns);
            $catalogue->addCatalogue($this->loader->load($file->getPathname(), $catalogue->getLocale(), $domain));
        }
    }

    protected function getTranslationFiles($directory, $patterns)
    {
        $finder = new Finder();
        foreach ($patterns as $pattern) {
            $finder->name($pattern);
        }

        return $finder
            ->files()
            ->in($directory);
    }

    protected function getDomainFromFilename($filename, $patterns)
    {
        foreach ($patterns as $pattern) {
            $extension = str_replace('*.', '', $pattern);
            $length = strlen($extension);
            if (substr($filename, -$length) === $extension) {
                return substr($filename, 0, -1 * $length - 1);
            }
        }

        return $filename;
    }

    protected function getTranslationFilePatterns(MessageCatalogue $catalogue)
    {
        if ($this->format && !is_array($this->format)) {
            $this->format = [$this->format];

        }

        $patterns = [];
        foreach ($this->format as $ext) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $patterns[] = sprintf('*.%s.%s', $catalogue->getLocale(), $ext);
        }

        return $patterns;
    }
}


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\Converter\Loader;
13
14		use Symfony\Component\Finder\Finder;
15		use Symfony\Component\Translation\Loader\LoaderInterface;
16		use Symfony\Component\Translation\MessageCatalogue;
17		use Translation\SymfonyStorage\TranslationLoader as TranslationLoaderInterface;
18
19		class TranslationLoader implements TranslationLoaderInterface
		0 ignored issues – show Deprecated Code introduced 2018-07-11 06:14 UTC by Report Bug Copy Issue Report The interface `Translation\SymfonyStorage\TranslationLoader` has been deprecated with message: Will be removed in 2.0. Please use Symfony\Component\Translation\Reader\TranslationReaderInterface. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
20		{
21		/**
22		* @var LoaderInterface
23		*/
24		private $loader;
25
26		/**
27		* @var string
28		*/
29		private $format;
30
31		/**
32		* @param LoaderInterface $loader
33		* @param string\|string[] $format
34		*/
35	2	public function __construct(LoaderInterface $loader, $format)
36		{
37	2	$this->loader = $loader;
38	2	$this->format = $format;
		0 ignored issues – show Documentation Bug introduced 2019-05-16 03:02 UTC by Report Bug Copy Issue Report It seems like `$format` can also be of type `array<integer,string>`. However, the property `$format` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
39	2	}
40
41		/**
42		* Loads translation messages from a directory to the catalogue.
43		*
44		* @param string $directory the directory to look into
45		* @param MessageCatalogue $catalogue the catalogue
46		*
47	2	* @deprecated Use read instead.
48		*/
49	2	public function loadMessages($directory, MessageCatalogue $catalogue)
50		{
51		return $this->read($directory, $catalogue);
52		}
53
54	2	/**
55	2	* Loads translation messages from a directory to the catalogue.
56	2	*
57	2	* @param string $directory the directory to look into
58	2	* @param MessageCatalogue $catalogue the catalogue
59	2	*/
60	2	public function read($directory, MessageCatalogue $catalogue)
61	2	{
62		if (!is_dir($directory)) {
63		return;
64		}
65
66		// load any existing translation files
67		$patterns = $this->getTranslationFilePatterns($catalogue);
68		$files = $this->getTranslationFiles($directory, $patterns);
69		foreach ($files as $file) {
70		$domain = $this->getDomainFromFilename($file->getFilename(), $patterns);
71		$catalogue->addCatalogue($this->loader->load($file->getPathname(), $catalogue->getLocale(), $domain));
72		}
73		}
74
75		protected function getTranslationFiles($directory, $patterns)
76		{
77		$finder = new Finder();
78		foreach ($patterns as $pattern) {
79		$finder->name($pattern);
80		}
81
82		return $finder
83		->files()
84		->in($directory);
85		}
86
87		protected function getDomainFromFilename($filename, $patterns)
88		{
89		foreach ($patterns as $pattern) {
90		$extension = str_replace('*.', '', $pattern);
91		$length = strlen($extension);
92		if (substr($filename, -$length) === $extension) {
93		return substr($filename, 0, -1 * $length - 1);
94		}
95		}
96
97		return $filename;
98		}
99
100		protected function getTranslationFilePatterns(MessageCatalogue $catalogue)
101		{
102		if ($this->format && !is_array($this->format)) {
103		$this->format = [$this->format];
		0 ignored issues – show Documentation Bug introduced 2019-05-16 03:02 UTC by Report Bug Copy Issue Report It seems like `array($this->format)` of type `array<integer,string,{"0":"string"}>` is incompatible with the declared type `string` of property `$format`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
104		}
105
106		$patterns = [];
107		foreach ($this->format as $ext) {
		0 ignored issues – show Bug introduced 2019-05-16 03:02 UTC by Report Bug Copy Issue Report The expression `$this->format` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
108		$patterns[] = sprintf('*.%s.%s', $catalogue->getLocale(), $ext);
109		}
110
111		return $patterns;
112		}
113		}
114

php-translation / converter

Push — master ( 34d733...90b7c0 )

TranslationLoader::getTranslationFilePatterns() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like