App\Translation\TranslatableTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

94.44%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	updateTranslations()	0	18	5
A	addTranslation()	0	6	1
A	getTranslations()	0	10	2
A	getTranslation()	0	14	4
A	getFallbackTranslation()	0	8	2
A	mapTranslationsByLocale()	0	11	2

<?php

namespace App\Translation;

use Doctrine\Common\Collections\ArrayCollection;

/**
 * Trait TranslatableTrait.
 *
 * @property ArrayCollection $translations
 * @property int|null        $id
 */
trait TranslatableTrait
{
    private $isTranslationsMappedByLocale = false;

    /**
     * @param array         $translations
     * @param callable      $add
     * @param callable|null $update
     *
     * @throws \ErrorException
     */
    public function updateTranslations(array $translations, callable $add, callable $update = null)
    {
        foreach ($translations as $translation) {
            $locale = is_object($translation) ? $translation->getLocale() : $translation['locale'];
            if (null === $oldTranslation = $this->getTranslation($locale, false)) {
                $add($translation);
                continue;
            }

            if ($update === null) {
                // This will called only when there's update action and $update function not defined
                // But you still can keep it as null if you creating entity
                throw new \InvalidArgumentException('Unexpected behavior: founded old translation but $update function not defined');
            }

            $update($translation, $oldTranslation);
        }
    }

    public function addTranslation(EntityTranslationInterface $translation): self
    {
        $this->translations->set($translation->getLocale(), $translation);

        return $this;
    }

    /**
     * @return array
     */
    public function getTranslations(): array
    {
        if ($this->isTranslationsMappedByLocale === true) {
            return $this->translations->toArray();
        }

        $this->mapTranslationsByLocale();

        return $this->translations->toArray();
    }

    /**
     * @param string $locale
     * @param bool   $useFallbackLocale
     *
     * @throws \ErrorException
     *
     * @return EntityTranslationInterface|null
     */
    public function getTranslation(string $locale, bool $useFallbackLocale = true): ?EntityTranslationInterface
    {
        if ($this->isTranslationsMappedByLocale === false) {
            $this->mapTranslationsByLocale();
        }

        $translation = $this->translations->get($locale);

        if ($translation === null && $useFallbackLocale === true) {
            return $this->getFallbackTranslation();
        }

        return $translation;
    }

    /**
     * @throws \ErrorException
     *
     * @return mixed
     */
    private function getFallbackTranslation(): EntityTranslationInterface
    {
        if (null === $translation = $this->translations->first()) {
            throw new \ErrorException(sprintf('You are trying to get translation for %s with ID %s but there\'s no translations found.', self::class, $this->id));
        }

        return $translation;
    }

    private function mapTranslationsByLocale(): void
    {
        $mappedTranslations = new ArrayCollection();

        foreach ($this->translations as $translation) {
            $mappedTranslations->set($translation->getLocale(), $translation);
        }

        $this->isTranslationsMappedByLocale = true;
        $this->translations = $mappedTranslations;
    }
}