Translation\Bundle\Catalogue\CatalogueManager

Complexity

Total Complexity

40

Size/Duplication

Total Lines	238
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	load()	0	7	2
A	getDomains()	0	7	1
A	getMessages()	0	13	3
F	findMessages()	0	47	16
A	getTranslations()	0	11	3
A	getSourceLocations()	0	13	3
A	isNew()	0	6	1
A	isObsolete()	0	6	1
A	getNotes()	0	14	3
A	hasNoteObsolete()	0	10	3
A	hasNoteNew()	0	10	3

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <tobias.nyholm@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Bundle\Catalogue;

use Symfony\Component\Translation\MessageCatalogue;
use Translation\Bundle\Model\CatalogueMessage;

/**
 * A manager that handle loaded catalogues.
 *
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
class CatalogueManager
{
    /**
     * @var MessageCatalogue[]
     */
    private $catalogues;

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

    /**
     * @param string $projectRoot
     */
    public function __construct($projectRoot)
    {
        $this->projectRoot = $projectRoot;
    }

    /**
     * @param MessageCatalogue[] $catalogues
     */
    public function load(array $catalogues)
    {
        $this->catalogues = [];
        foreach ($catalogues as $c) {
            $this->catalogues[$c->getLocale()] = $c;
        }
    }

    /**
     * @return array
     */
    public function getDomains()
    {
        /** @var MessageCatalogue $c */
        $c = reset($this->catalogues);

        return $c->getDomains();
    }

    /**
     * @param string $locale
     * @param string $domain
     *
     * @return CatalogueMessage[]
     */
    public function getMessages($locale, $domain)
    {
        $messages = [];
        if (!isset($this->catalogues[$locale])) {
            return $messages;
        }

        foreach ($this->catalogues[$locale]->all($domain) as $key => $text) {
            $messages[] = new CatalogueMessage($this, $locale, $domain, $key, $text);
        }

        return $messages;
    }

    /**
     * @param array $config {
     *
     *      @var string $domain
     *      @var string $locale
     *      @var bool $isNew
     *      @var bool $isObsolete
     * }
     *
     * @return CatalogueMessage[]
     */
    public function findMessages(array $config = [])
    {
        $inputDomain = isset($config['domain']) ? $config['domain'] : null;
        $isNew = isset($config['isNew']) ? $config['isNew'] : null;
        $isObsolete = isset($config['isObsolete']) ? $config['isObsolete'] : null;

        $messages = [];
        $catalogues = [];
        if (isset($config['locale'])) {
            $locale = $config['locale'];
            if (isset($this->catalogues[$locale])) {
                $catalogues = [$locale => $this->catalogues[$locale]];
            }
        } else {
            $catalogues = $this->catalogues;
        }

        foreach ($catalogues as $locale => $catalogue) {
            $domains = $catalogue->getDomains();
            if (null !== $inputDomain) {
                $domains = [$inputDomain];
            }
            foreach ($domains as $domain) {
                foreach ($catalogue->all($domain) as $key => $text) {
                    // Filter on new and obsolete
                    if (null !== $isNew || null !== $isObsolete) {
                        $notes = $this->getNotes($domain, $key, $catalogue);

                        if (null !== $isNew) {
                            if ($isNew !== $this->hasNoteNew($notes)) {
                                continue;
                            }
                        }
                        if (null !== $isObsolete) {
                            if ($isObsolete !== $this->hasNoteObsolete($notes)) {
                                continue;
                            }
                        }
                    }

                    $messages[] = new CatalogueMessage($this, $locale, $domain, $key, $text);
                }
            }
        }

        return $messages;
    }

    /**
     * @param string $domain
     * @param string $key
     *
     * @return array
     */
    public function getTranslations($domain, $key)
    {
        $translations = [];
        foreach ($this->catalogues as $locale => $catalogue) {
            if ($catalogue->has($key, $domain)) {
                $translations[$locale] = $catalogue->get($key, $domain);
            }
        }

        return $translations;
    }

    /**
     * @param string $domain
     * @param string $key
     *
     * @return array
     */
    public function getSourceLocations($domain, $key)
    {
        $notes = $this->getNotes($domain, $key);
        $sources = [];
        foreach ($notes as $note) {
            if ($note['content'] === 'file-source') {
                list($path, $line) = explode(':', $note['from'], 2);
                $sources[] = ['full_path' => $this->projectRoot.$path, 'path' => $path, 'line' => $line];
            }
        }

        return $sources;
    }

    /**
     * @param string $domain
     * @param string $key
     *
     * @return bool
     */
    public function isNew($domain, $key)
    {
        $notes = $this->getNotes($domain, $key);

        return $this->hasNoteNew($notes);
    }

    /**
     * @param string $domain
     * @param string $key
     *
     * @return bool
     */
    public function isObsolete($domain, $key)
    {
        $notes = $this->getNotes($domain, $key);

        return $this->hasNoteObsolete($notes);
    }

    /**
     * @param $domain
     * @param $key
     *
     * @return array
     */
    private function getNotes($domain, $key, MessageCatalogue $catalogue = null)
    {
        if (null === $catalogue) {
            /** @var MessageCatalogue $c */
            $catalogue = reset($this->catalogues);
        }
        $meta = $catalogue->getMetadata($key, $domain);

It seems like $catalogue is not always an object, but can also be of type false. Maybe add an additional type check?

        if (!isset($meta['notes'])) {
            return [];
        }

        return $meta['notes'];
    }

    /**
     * @param array $notes
     *
     * @return bool
     */
    private function hasNoteObsolete(array $notes)
    {
        foreach ($notes as $note) {
            if ($note['content'] === 'status:obsolete') {
                return true;
            }
        }

        return false;
    }

    /**
     * @param array $notes
     *
     * @return bool
     */
    private function hasNoteNew(array $notes)
    {
        foreach ($notes as $note) {
            if ($note['content'] === 'status:new') {
                return true;
            }
        }

        return false;
    }
}