Backpack\CRUD\app\Models\Traits\SpatieTranslatable\HasTranslations

Complexity

Total Complexity

32

Size/Duplication

Total Lines	225
Duplicated Lines	0 %

Importance

Changes	1
Bugs	1	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getAttributeValue()	0	14	4
A	getTranslation()	0	13	2
A	translationEnabledForModel()	0	3	1
B	__call()	0	32	10
A	setLocale()	0	3	1
A	create()	0	19	3
A	getAvailableLocales()	0	3	1
A	getLocale()	0	7	2
A	getFallbackFromUrl()	0	8	3
A	update()	0	20	4
A	getFallbackLocale()	0	3	1

<?php

namespace Backpack\CRUD\app\Models\Traits\SpatieTranslatable;

use Illuminate\Support\Arr;
use Spatie\Translatable\HasTranslations as OriginalHasTranslations;
use Spatie\Translatable\Translatable;

trait HasTranslations
{
    use OriginalHasTranslations;

    /**
     * @var bool
     */
    public $locale = false;

    /**
     * @var bool
     */
    public $useFallbackLocale = true;

    /*
    |--------------------------------------------------------------------------
    |                 SPATIE/LARAVEL-TRANSLATABLE OVERWRITES
    |--------------------------------------------------------------------------
    */

    /**
     * Use the forced locale if present.
     *
     * @param  string  $key
     * @return mixed
     */
    public function getAttributeValue($key)
    {
        if (! $this->isTranslatableAttribute($key)) {
            return parent::getAttributeValue($key);
        }

        $translation = $this->getTranslation($key, $this->locale ?: config('app.locale'), $this->useFallbackLocale);

It seems like $this->locale ?: config('app.locale') can also be of type true; however, parameter $locale of Backpack\CRUD\app\Models\Traits\SpatieTranslatable\HasTranslations::getTranslation() does only seem to accept string, maybe add an additional type check?

        // if it's a fake field, json_encode it
        if (is_array($translation)) {
            return json_encode($translation, JSON_UNESCAPED_UNICODE);
        }

        return $translation;
    }

    public function getFallbackLocale()
    {
        return $this->getFallbackFromUrl() ?? app(Translatable::class)->fallbackLocale ?? config('app.fallback_locale');
    }

    public function getTranslation(string $key, string $locale, bool $useFallbackLocale = true)
    {
        $locale = $this->normalizeLocale($key, $locale, $useFallbackLocale);

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

        $translation = $translations[$locale] ?? '';

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

The method hasGetMutator() does not exist on Backpack\CRUD\app\Models\Traits\SpatieTranslatable\HasTranslations. Since you implemented __call, consider adding a @method annotation.

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

The method mutateAttribute() does not exist on Backpack\CRUD\app\Models\Traits\SpatieTranslatable\HasTranslations. Since you implemented __call, consider adding a @method annotation.

        }

        return $translation;
    }

    private function getFallbackFromUrl()
    {
        $fallback = app('crud')->getRequest()->get('_use_fallback');
        if (isset($fallback) && in_array($fallback, array_keys(app('crud')->getModel()->getAvailableLocales()))) {
            return $fallback;
        }

        return null;
    }

    /*
    |--------------------------------------------------------------------------
    |                            ELOQUENT OVERWRITES
    |--------------------------------------------------------------------------
    */

    /**
     * Create translated items as json.
     *
     * @param  array  $attributes
     * @return static
     */
    public static function create(array $attributes = [])
    {
        $locale = $attributes['locale'] ?? \App::getLocale();
        $attributes = Arr::except($attributes, ['locale']);
        $non_translatable = [];

        $model = new static();

        // do the actual saving
        foreach ($attributes as $attribute => $value) {
            if ($model->isTranslatableAttribute($attribute)) { // the attribute is translatable
                $model->setTranslation($attribute, $locale, $value);
            } else { // the attribute is NOT translatable
                $non_translatable[$attribute] = $value;
            }
        }
        $model->fill($non_translatable)->save();

The method fill() does not exist on Backpack\CRUD\app\Models\Traits\SpatieTranslatable\HasTranslations. Since you implemented __call, consider adding a @method annotation.

        return $model;
    }

    /**
     * Update translated items as json.
     *
     * @param  array  $attributes
     * @param  array  $options
     * @return bool
     */
    public function update(array $attributes = [], array $options = [])
    {
        if (! $this->exists) {
            return false;
        }

        $locale = $attributes['_locale'] ?? \App::getLocale();
        $attributes = Arr::except($attributes, ['_locale']);
        $non_translatable = [];

        // do the actual saving
        foreach ($attributes as $attribute => $value) {
            if ($this->isTranslatableAttribute($attribute)) { // the attribute is translatable
                $this->setTranslation($attribute, $locale, $value);
            } else { // the attribute is NOT translatable
                $non_translatable[$attribute] = $value;
            }
        }

        return $this->fill($non_translatable)->save($options);
    }

    /*
    |--------------------------------------------------------------------------
    |                            CUSTOM METHODS
    |--------------------------------------------------------------------------
    */

    /**
     * Check if a model is translatable, by the adapter's standards.
     *
     * @return bool
     */
    public function translationEnabledForModel()
    {
        return property_exists($this, 'translatable');
    }

    /**
     * Get all locales the admin is allowed to use.
     *
     * @return array
     */
    public function getAvailableLocales()
    {
        return config('backpack.crud.locales');
    }

    /**
     * Set the locale property. Used in normalizeLocale() to force the translation
     * to a different language that the one set in app()->getLocale();.
     *
     * @param string
     */
    public function setLocale($locale)
    {
        $this->locale = $locale;
    }

    /**
     * Get the locale property. Used in SpatieTranslatableSluggableService
     * to save the slug for the appropriate language.
     *
     * @param string
     */
    public function getLocale()
    {
        if ($this->locale) {
            return $this->locale;
        }

        return \Request::input('_locale', \App::getLocale());
    }

    /**
     * Magic method to get the db entries already translated in the wanted locale.
     *
     * @param  string  $method
     * @param  array  $parameters
     * @return
     */
    public function __call($method, $parameters)
    {
        switch ($method) {
            // translate all find methods
            case 'find':
            case 'findOrFail':
            case 'findMany':
            case 'findBySlug':
            case 'findBySlugOrFail':
                $translation_locale = \Request::input('_locale', \App::getLocale());

                if ($translation_locale) {
                    $item = parent::__call($method, $parameters);

                    if ($item instanceof \Traversable) {
                        foreach ($item as $instance) {
                            $instance->setLocale($translation_locale);
                        }
                    } elseif ($item) {
                        $item->setLocale($translation_locale);
                    }

                    return $item;
                }

                return parent::__call($method, $parameters);
                break;

break is not strictly necessary here and could be removed.

                // do not translate any other methods
            default:
                return parent::__call($method, $parameters);
                break;
        }
    }
}