ONGR\TranslationsBundle\Service\Import\Import

Complexity

Total Complexity

36

Size/Duplication

Total Lines	323
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	13	1
A	import()	0	8	1
A	getTranslations()	0	8	2
B	writeToStorage()	0	23	5
A	importAppTranslationFiles()	0	5	1
A	importBundlesTranslationFiles()	0	10	3
A	importBundleTranslationFiles()	0	5	1
A	importComponentTranslationFiles()	0	21	3
B	findTranslationsFiles()	0	21	5
A	getFileNamePattern()	0	19	2
A	importTranslationFiles()	0	8	3
A	getDomains()	0	4	1
A	setDomains()	0	4	1
A	getLocales()	0	4	1
A	setLocales()	0	4	1
A	getFormats()	0	4	1
A	setFormats()	0	4	1
A	getFinder()	0	4	1
A	getConfigBundles()	0	4	1
A	getBundles()	0	4	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <info@nfq.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\TranslationsBundle\Service\Import;

use Elasticsearch\Common\Exceptions\BadRequest400Exception;
use ONGR\ElasticsearchBundle\Service\Manager;
use ONGR\TranslationsBundle\Document\Message;
use ONGR\TranslationsBundle\Document\Translation;
use Symfony\Component\Finder\Finder;

/**
 * Collects translations.
 */
class Import
{
    /**
     * @var FileImport
     */
    private $fileImport;

    /**
     * @var array
     */
    private $locales;

    /**
     * @var array
     */
    private $domains;

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

    /**
     * @var array
     */
    private $bundles;

    /**
     * @var array
     */
    private $formats;

    /**
     * @var array
     */
    private $translations = [];

    /**
     * @var Manager
     */
    private $esManager;

    /**
     * @var array
     */
    private $configBundles;

    /**
     * @param FileImport $fileImport
     * @param Manager    $esManager
     * @param string     $kernelDir
     * @param array      $kernelBundles
     * @param array      $configBundles
     */
    public function __construct(
        FileImport $fileImport,
        Manager $esManager,
        $kernelDir,
        $kernelBundles,
        $configBundles
    ) {
        $this->fileImport = $fileImport;
        $this->esManager = $esManager;
        $this->kernelDir = $kernelDir;
        $this->bundles = $kernelBundles;
        $this->configBundles = $configBundles;
    }

    /**
     * Collects translations.
     */
    public function import()
    {
        $this->importAppTranslationFiles();

        $this->importBundlesTranslationFiles(array_merge($this->getConfigBundles(), $this->getBundles()));

        $this->importComponentTranslationFiles();
    }

    /**
     * Returns all translations as array.
     *
     * @return array
     */
    public function getTranslations()
    {
        if (empty($this->translations)) {
            $this->import();
        }

        return $this->translations;
    }

    /**
     * Write translations to storage.
     */
    public function writeToStorage()
    {
        foreach ($this->translations as $path => $domains) {
            foreach ($domains as $domain => $transMeta) {
                foreach ($transMeta['translations'] as $key => $keyTrans) {
                    $document = new Translation();
                    $document->setDomain($domain);
                    $document->setKey($key);
                    $document->setPath($path);
                    $document->setFormat($transMeta['format']);
                    foreach ($keyTrans as $locale => $trans) {
                        $message = new Message();
                        $message->setLocale($locale);
                        $message->setMessage($trans);
                        $document->addMessage($message);
                    }
                    $this->esManager->persist($document);
                }
            }
        }

        $this->esManager->commit();
    }

    /**
     * Imports application translation files.
     */
    public function importAppTranslationFiles()
    {
        $finder = $this->findTranslationsFiles($this->kernelDir);
        $this->importTranslationFiles($finder);

It seems like $finder defined by $this->findTranslationsFiles($this->kernelDir) on line 149 can be null; however, ONGR\TranslationsBundle\Service\Import\Import::importTranslationFiles() does not accept null, maybe add an additional type check?

    }

    /**
     * Imports translation files form all bundles.
     *
     * @param array $bundles
     * @param bool  $isBundle
     */
    public function importBundlesTranslationFiles($bundles, $isBundle = false)
    {
        foreach ($bundles as $bundle) {
            $dir = $isBundle?
                dir($bundle->getPath())->path :

The property path does not seem to exist in Directory.

                dirname((new \ReflectionClass($bundle))->getFilename());

            $this->importBundleTranslationFiles($dir);
        }
    }

    /**
     * Imports translation files form the specific bundles.
     *
     * @param string $bundle
     */
    public function importBundleTranslationFiles($bundle)
    {
        $finder = $this->findTranslationsFiles($bundle);
        $this->importTranslationFiles($finder);

It seems like $finder defined by $this->findTranslationsFiles($bundle) on line 177 can be null; however, ONGR\TranslationsBundle\Service\Import\Import::importTranslationFiles() does not accept null, maybe add an additional type check?

    }

    /**
     * Imports Symfony's components translation files.
     */
    public function importComponentTranslationFiles()
    {
        $classes = [
            'Symfony\Component\Validator\ValidatorBuilder' => '/Resources/translations',
            'Symfony\Component\Form\Form' => '/Resources/translations',
            'Symfony\Component\Security\Core\Exception\AuthenticationException' => '/../../Resources/translations',
        ];

        $dirs = [];
        foreach ($classes as $namespace => $translationDir) {
            $reflection = new \ReflectionClass($namespace);
            $dirs[] = dirname($reflection->getFilename()) . $translationDir;
        }

        $finder = $this->getFinder();
        $finder->files()
            ->name($this->getFileNamePattern())
            ->in($dirs);

        $this->importTranslationFiles($finder->count() > 0 ? $finder : null);

It seems like $finder->count() > 0 ? $finder : null can be null; however, importTranslationFiles() does not accept null, maybe add an additional type check?

    }

    /**
     * Return a Finder object if $path has a Resources/translations folder.
     *
     * @param string $path
     *
     * @return Finder
     */
    protected function findTranslationsFiles($path)
    {
        $finder = null;

        if (preg_match('#^win#i', PHP_OS)) {
            $path = preg_replace('#' . preg_quote(DIRECTORY_SEPARATOR, '#') . '#', '/', $path);
        } else {
            $path = str_replace('\\', '/', $path);
        }

        $dir = $path . '/Resources/translations';

        if (is_dir($dir)) {
            $finder = $this->getFinder();
            $finder->files()
                ->name($this->getFileNamePattern())
                ->in($dir);
        }

        return (null !== $finder && $finder->count() > 0) ? $finder : null;
    }

    /**
     * @return string
     */
    protected function getFileNamePattern()
    {
        if (count($this->getDomains())) {
            $regex = sprintf(
                '/((%s)\.(%s)\.(%s))/',
                implode('|', $this->getDomains()),
                implode('|', $this->getLocales()),
                implode('|', $this->getFormats())
            );
        } else {
            $regex = sprintf(
                '/(.*\.(%s)\.(%s))/',
                implode('|', $this->getLocales()),
                implode('|', $this->getFormats())
            );
        }

        return $regex;
    }

    /**
     * Imports some translations files.
     *
     * @param Finder $finder
     */
    protected function importTranslationFiles($finder)
    {
        if ($finder instanceof Finder) {
            foreach ($finder as $file) {
                $this->translations = array_replace_recursive($this->fileImport->import($file), $this->translations);
            }
        }
    }

    /**
     * @return mixed
     */
    public function getDomains()
    {
        return $this->domains;
    }

    /**
     * @param mixed $domains
     */
    public function setDomains($domains)
    {
        $this->domains = $domains;

It seems like $domains of type * is incompatible with the declared type array of property $domains.

    }

    /**
     * @return mixed
     */
    public function getLocales()
    {
        return $this->locales;
    }

    /**
     * @param mixed $locales
     */
    public function setLocales($locales)
    {
        $this->locales = $locales;

It seems like $locales of type * is incompatible with the declared type array of property $locales.

    }

    /**
     * @return mixed
     */
    public function getFormats()
    {
        return $this->formats;
    }

    /**
     * @param mixed $formats
     */
    public function setFormats($formats)
    {
        $this->formats = $formats;

It seems like $formats of type * is incompatible with the declared type array of property $formats.

    }

    /**
     * Returns Finder object.
     *
     * @return Finder
     */
    protected function getFinder()
    {
        return new Finder();
    }

    /**
     * @return array
     */
    public function getConfigBundles()
    {
        return $this->configBundles;
    }

    /**
     * @return array
     */
    public function getBundles()
    {
        return $this->bundles;
    }
}