Spatie\Translatable\HasTranslations

Complexity

Total Complexity

13

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getAttributeValue()	0	8	2
A	translate()	0	4	1
A	getTranslation()	0	6	1
A	guardAgainstUntranslatableFieldName()	0	6	2
A	getTranslations()	0	8	1
A	setTranslation()	0	12	1
A	setTranslations()	0	10	2
A	forgetTranslation()	0	10	1
A	getTranslatedLocales()	0	4	1
A	isTranslatableAttribute()	0	4	1

<?php

namespace Spatie\Translatable;

use Spatie\Translatable\Exceptions\Untranslatable;

trait HasTranslations
{
    /**
     * @param string $attributeName
     *
     * @return mixed
     */
    public function getAttributeValue($attributeName)
    {
        if (!$this->isTranslatableAttribute($attributeName)) {
            return parent::getAttributeValue($attributeName);
        }

        return $this->getTranslation($attributeName, config('app.locale'));
    }

    public function translate(string $attributeName, string $locale = '', string $default = '') : string
    {
        return $this->getTranslation($attributeName, $locale, $default);
    }

    public function getTranslation(string $attributeName, string $locale, string $default = '') : string
    {
        $translations = $this->getTranslations($attributeName);

        return $translations[$locale] ?? $default;
    }

    public function getTranslations(string $attributeName) : array
    {
        $this->guardAgainstUntranslatableFieldName($attributeName);

        $translations = json_decode($this->getAttributes()[$attributeName] ?? '{}', true);

It seems like getAttributes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $translations;
    }

    public function setTranslation(string $attributeName, string $locale, string $value)
    {
        $this->guardAgainstUntranslatableFieldName($attributeName);

        $translations = $this->getTranslations($attributeName);

        $translations[$locale] = $value;

        $this->setAttribute($attributeName, $translations);

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function setTranslations(string $attributeName, array $translations)
    {
        $this->guardAgainstUntranslatableFieldName($attributeName);

        foreach ($translations as $locale => $translation) {
            $this->setTranslation($attributeName, $locale, $translation);
        }

        return $this;
    }

    public function forgetTranslation(string $attributeName, string $locale)
    {
        $translations = $this->getTranslations($attributeName);

        unset($translations[$locale]);

        $this->setAttribute($attributeName, $translations);

It seems like setAttribute() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        return $this;
    }

    public function getTranslatedLocales(string $attributeName) : array
    {
        return array_keys($this->getTranslations($attributeName));
    }

    protected function isTranslatableAttribute(string $attributeName) : bool
    {
        return in_array($attributeName, $this->getTranslatableAttributes());

It seems like getTranslatableAttributes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    protected function guardAgainstUntranslatableFieldName(string $attributeName)
    {
        if (!$this->isTranslatableAttribute($attributeName)) {
            throw Untranslatable::attributeIsNotTranslatable($attributeName, $this);
        }
    }
}