Spatie\Translatable\HasTranslations

Complexity

Total Complexity

25

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getAttributeValue()	0	8	2
A	translate()	0	4	1
A	getTranslation()	0	14	3
A	getTranslations()	0	6	3
A	setTranslation()	0	21	3
A	setTranslations()	0	10	2
A	forgetTranslation()	0	10	1
A	getTranslatedLocales()	0	4	1
A	isTranslatableAttribute()	0	4	1
A	guardAgainstUntranslatableAttribute()	0	6	2
A	normalizeLocale()	0	12	3
A	getTranslatableAttributes()	0	6	2
A	getCasts()	0	7	1

<?php

namespace Spatie\Translatable;

use Illuminate\Support\Str;
use Spatie\Translatable\Events\TranslationHasBeenSet;
use Spatie\Translatable\Exceptions\AttributeIsNotTranslatable;

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

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

    /**
     * @param string $key
     * @param string $locale
     *
     * @return mixed
     */
    public function translate($key, $locale = null)
    {
        return $this->getTranslation($key, $locale);
    }

    /***
     * @param string $key
     * @param string $locale
     *
     * @return mixed
     */
    public function getTranslation($key, $locale)
    {
        $locale = $this->normalizeLocale($key, $locale);

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

        $translation = isset($translations[$locale]) ? $translations[$locale] : '';

        if ($this->hasGetMutator($key)) {

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

            return $this->mutateAttribute($key, $translation);

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

        }

        return $translation;
    }

    public function getTranslations($key)
    {
        $this->guardAgainstUntranslatableAttribute($key);

        return json_decode(isset($this->getAttributes()[$key]) ? $this->getAttributes()[$key] : '' ?: '{}', true);

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

    }

    /**
     * @param string $key
     * @param string $locale
     * @param $value
     *
     * @return $this
     */
    public function setTranslation($key, $locale, $value)
    {
        $this->guardAgainstUntranslatableAttribute($key);

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

        $oldValue = isset($translations[$locale]) ? $translations[$locale] : '';

        if ($this->hasSetMutator($key)) {

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

            $method = 'set'.Str::studly($key).'Attribute';
            $value = $this->{$method}($value);
        }

        $translations[$locale] = $value;

        $this->attributes[$key] = $this->asJson($translations);

The property attributes does not exist. Did you maybe forget to declare it?

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

        event(new TranslationHasBeenSet($this, $key, $locale, $oldValue, $value));

        return $this;
    }

    /**
     * @param string $key
     * @param array  $translations
     *
     * @return $this
     */
    public function setTranslations($key, array $translations)
    {
        $this->guardAgainstUntranslatableAttribute($key);

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

        return $this;
    }

    /**
     * @param string $key
     * @param string $locale
     *
     * @return $this
     */
    public function forgetTranslation($key, $locale)
    {
        $translations = $this->getTranslations($key);

        unset($translations[$locale]);

        $this->setAttribute($key, $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($key)
    {
        return array_keys($this->getTranslations($key));
    }

    public function isTranslatableAttribute($key)
    {
        return in_array($key, $this->getTranslatableAttributes());
    }

    protected function guardAgainstUntranslatableAttribute($key)
    {
        if (!$this->isTranslatableAttribute($key)) {
            throw AttributeIsNotTranslatable::make($key, $this);
        }
    }

    protected function normalizeLocale($key, $locale)
    {
        if (in_array($locale, $this->getTranslatedLocales($key))) {
            return $locale;
        }

        if (!is_null($fallbackLocale = config('laravel-translatable.fallback_locale'))) {
            return $fallbackLocale;
        }

        return $locale;
    }

    public function getTranslatableAttributes()
    {
        return is_array($this->translatable)

The property translatable does not exist. Did you maybe forget to declare it?

            ? $this->translatable
            : [];
    }

    public function getCasts()
    {
        return array_merge(
            parent::getCasts(),
            array_fill_keys($this->getTranslatableAttributes(), 'array')
        );
    }
}