TranslatableTrait::getTranslationFactory() - Code Metrics - Inspection of "[Resource] Add action to REST events" - php-lug/lug - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#60)

by Eric

created 2016-07-17 10:05 UTC

TranslatableTrait::getTranslationFactory() A

↳ Parent: TranslatableTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

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

namespace Lug\Component\Translation\Model;

use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Lug\Component\Resource\Factory\FactoryInterface;
use Lug\Component\Translation\Exception\LocaleNotFoundException;
use Lug\Component\Translation\Exception\TranslationNotFoundException;

/**
 * @author GeLo <[email protected]>
 */
trait TranslatableTrait
{
    /**
     * @var string[]
     */
    private $locales;

    /**
     * @var string|null
     */
    private $fallbackLocale;

    /**
     * @var FactoryInterface
     */
    private $translationFactory;

    /**
     * @var TranslationInterface[]|Collection
     */
    protected $translations;

    /**
     * @return string|null
     */
    public function getLocale()
    {
        try {
            return $this->getTranslation()->getLocale();
        } catch (TranslationNotFoundException $e) {

        }
    }

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

    /**
     * @param string[] $locales
     */
    public function setLocales($locales)
    {
        $this->locales = $locales;
    }

    /**
     * @return bool
     */
    public function hasFallbackLocale()
    {
        return $this->fallbackLocale !== null;
    }

    /**
     * @return string|null
     */
    public function getFallbackLocale()
    {
        return $this->fallbackLocale;
    }

    /**
     * @param string|null $fallbackLocale
     */
    public function setFallbackLocale($fallbackLocale)
    {
        $this->fallbackLocale = $fallbackLocale;
    }

    /**
     * @return FactoryInterface
     */
    public function getTranslationFactory()
    {
        return $this->translationFactory;
    }

    /**
     * @param FactoryInterface $translationFactory
     */
    public function setTranslationFactory(FactoryInterface $translationFactory)
    {
        $this->translationFactory = $translationFactory;
    }

    /**
     * @return TranslationInterface[]|Collection
     */
    public function getTranslations()
    {
        return $this->translations;
    }

    /**
     * @param bool $allowCreate
     *
     * @return TranslationInterface
     */
    public function getTranslation($allowCreate = false)
    {
        $locales = $this->getLocales();

        if (empty($locales)) {
            throw new LocaleNotFoundException();
        }

        $translation = null;

        foreach ($locales as $locale) {
            if (($translation = $this->translations->get($locale)) !== null) {
                break;
            }
        }

        if ($translation === null && $allowCreate) {
            $translation = $this->getTranslationFactory()->create(['locale' => reset($locales)]);
            $this->addTranslation($translation);
        }

        if ($translation === null && $this->hasFallbackLocale()) {
            $translation = $this->translations->get($this->getFallbackLocale());
        }

        if ($translation === null) {
            if ($this->hasFallbackLocale()) {
                $locales[] = $this->getFallbackLocale();
            }

            throw new TranslationNotFoundException();
        }

        return $translation;
    }

    /**
     * @param TranslationInterface[]|Collection $translations
     */
    public function setTranslations($translations)
    {
        $this->translations->clear();

        foreach ($translations as $translation) {
            $this->addTranslation($translation);
        }
    }

    /**
     * @param TranslationInterface $translation
     */
    public function addTranslation(TranslationInterface $translation)
    {
        if (!$this->translations->containsKey($translation->getLocale())) {
            $this->translations->set($translation->getLocale(), $translation);
            $translation->setTranslatable($this);
        }
    }

    /**
     * @param TranslationInterface $translation
     */
    public function removeTranslation(TranslationInterface $translation)
    {
        if ($this->translations->removeElement($translation)) {
            $translation->setTranslatable(null);
        }
    }

    private function initTranslatable()
    {
        $this->translations = new ArrayCollection();
    }
}


1		<?php
2
3		/*
4		* This file is part of the Lug package.
5		*
6		* (c) Eric GELOEN <[email protected]>
7		*
8		* For the full copyright and license information, please read the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Lug\Component\Translation\Model;
13
14		use Doctrine\Common\Collections\ArrayCollection;
15		use Doctrine\Common\Collections\Collection;
16		use Lug\Component\Resource\Factory\FactoryInterface;
17		use Lug\Component\Translation\Exception\LocaleNotFoundException;
18		use Lug\Component\Translation\Exception\TranslationNotFoundException;
19
20		/**
21		* @author GeLo <[email protected]>
22		*/
23		trait TranslatableTrait
24		{
25		/**
26		* @var string[]
27		*/
28		private $locales;
29
30		/**
31		* @var string\|null
32		*/
33		private $fallbackLocale;
34
35		/**
36		* @var FactoryInterface
37		*/
38		private $translationFactory;
39
40		/**
41		* @var TranslationInterface[]\|Collection
42		*/
43		protected $translations;
44
45		/**
46		* @return string\|null
47	3	*/
48		public function getLocale()
49		{
50	3	try {
51	2	return $this->getTranslation()->getLocale();
52		} catch (TranslationNotFoundException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-19 20:19 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
53	2	}
54		}
55
56		/**
57		* @return string[]
58	13	*/
59		public function getLocales()
60	13	{
61		return $this->locales;
62		}
63
64		/**
65		* @param string[] $locales
66	11	*/
67		public function setLocales($locales)
68	11	{
69	11	$this->locales = $locales;
70		}
71
72		/**
73		* @return bool
74	7	*/
75		public function hasFallbackLocale()
76	7	{
77		return $this->fallbackLocale !== null;
78		}
79
80		/**
81		* @return string\|null
82	7	*/
83		public function getFallbackLocale()
84	7	{
85		return $this->fallbackLocale;
86		}
87
88		/**
89		* @param string\|null $fallbackLocale
90	8	*/
91		public function setFallbackLocale($fallbackLocale)
92	8	{
93	8	$this->fallbackLocale = $fallbackLocale;
94		}
95
96		/**
97		* @return FactoryInterface
98	6	*/
99		public function getTranslationFactory()
100	6	{
101		return $this->translationFactory;
102		}
103
104		/**
105		* @param FactoryInterface $translationFactory
106	5	*/
107		public function setTranslationFactory(FactoryInterface $translationFactory)
108	5	{
109	5	$this->translationFactory = $translationFactory;
110		}
111
112		/**
113		* @return TranslationInterface[]\|Collection
114	6	*/
115		public function getTranslations()
116	6	{
117		return $this->translations;
118		}
119
120		/**
121		* @param bool $allowCreate
122		*
123		* @return TranslationInterface
124	10	*/
125		public function getTranslation($allowCreate = false)
126	10	{
127		$locales = $this->getLocales();
128	10
129	1	if (empty($locales)) {
130		throw new LocaleNotFoundException();
131		}
132	9
133		$translation = null;
134	9
135	9	foreach ($locales as $locale) {
136	3	if (($translation = $this->translations->get($locale)) !== null) {
137		break;
138	9	}
139		}
140	9
141	2	if ($translation === null && $allowCreate) {
142		$translation = $this->getTranslationFactory()->create(['locale' => reset($locales)]);
143	2	$this->addTranslation($translation);
144	2	}
145
146	2	if ($translation === null && $this->hasFallbackLocale()) {
147	2	$translation = $this->translations->get($this->getFallbackLocale());
148		}
149	9
150	3	if ($translation === null) {
151	3	if ($this->hasFallbackLocale()) {
152		$locales[] = $this->getFallbackLocale();
153	9	}
154	4
155	2	throw new TranslationNotFoundException();
156	2	}
157
158	4	return $translation;
159		}
160
161	5	/**
162		* @param TranslationInterface[]\|Collection $translations
163		*/
164		public function setTranslations($translations)
165		{
166		$this->translations->clear();
167	9
168		foreach ($translations as $translation) {
169	9	$this->addTranslation($translation);
170	9	}
171	9	}
172	9
173	9	/**
174		* @param TranslationInterface $translation
175		*/
176		public function addTranslation(TranslationInterface $translation)
177		{
178	2	if (!$this->translations->containsKey($translation->getLocale())) {
179		$this->translations->set($translation->getLocale(), $translation);
180	2	$translation->setTranslatable($this);
181	1	}
182	1	}
183	2
184		/**
185	19	* @param TranslationInterface $translation
186		*/
187	19	public function removeTranslation(TranslationInterface $translation)
188	19	{
189		if ($this->translations->removeElement($translation)) {
190		$translation->setTranslatable(null);
191		}
192		}
193
194		private function initTranslatable()
195		{
196		$this->translations = new ArrayCollection();
197		}
198		}
199

php-lug / lug

Pull Request — master (#60)

TranslatableTrait::getTranslationFactory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like