Lug\Component\Translation\Model\TranslatableTrait

Complexity

Total Complexity

27

Size/Duplication

Total Lines	176
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getLocale()	0	7	2
A	getLocales()	0	4	1
A	setLocales()	0	4	1
A	hasFallbackLocale()	0	4	1
A	getFallbackLocale()	0	4	1
A	setFallbackLocale()	0	4	1
A	getTranslationFactory()	0	4	1
A	setTranslationFactory()	0	4	1
A	getTranslations()	0	4	1
D	getTranslation()	0	35	10
A	setTranslations()	0	8	2
A	addTranslation()	0	7	2
A	removeTranslation()	0	6	2
A	initTranslatable()	0	4	1

<?php

/*
 * This file is part of the Lug package.
 *
 * (c) Eric GELOEN <geloen.eric@gmail.com>
 *
 * 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 <geloen.eric@gmail.com>
 */
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) {

Consider adding a comment why this CATCH block is empty.

        }
    }

    /**
     * @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();
    }
}