Backpack\CRUD\ModelTraits\Translatable\SpatieTranslatableAdaptor

Complexity

Total Complexity

19

Size/Duplication

Total Lines	170
Duplicated Lines	16.47 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getAttributeValue()	0	10	4
A	create()	0	19	3
B	update()	0	21	5
A	findOrFail()	14	14	2
A	find()	14	14	2
A	translationEnabledForModel()	0	4	1
A	getAvailableLocales()	0	4	1
A	setLocale()	0	4	1

<?php

namespace Backpack\CRUD\ModelTraits\Translatable;

use Spatie\Translatable\HasTranslations;

trait SpatieTranslatableAdaptor
{
    use HasTranslations;

    public $locale = false;

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

    /**
     * Use the forced locale if present.
     *
     * @param  [type] $key [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     * @return [type]      [description]

The doc-type [type] could not be parsed: Unknown type name "" at position 0. [(view supported doc-types)

     */
    public function getAttributeValue($key)
    {
        if (! $this->isTranslatableAttribute($key)) {
            return parent::getAttributeValue($key);
        }

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

        return is_array($translation) ? array_first($translation) : $translation;
    }

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

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

        $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
                $model->{$attribute} = $value;
            }
        }
        $model->save();

        return $model;
    }

    /**
     * Update translated items as json.
     *
     * @param  array  $attributes
     * @param  array  $options
     * @return bool

Should the return type not be false|SpatieTranslatableAdaptor?

     */
    public function update(array $attributes = [], array $options = [])
    {
        if (! $this->exists) {
            return false;
        }

        $locale = $attributes['locale'] ? $attributes['locale'] : App::getLocale();
        $attributes = array_except($attributes, ['locale']);

        // 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
                $this->{$attribute} = $value;
            }
        }
        $this->save($options);

        return $this;
    }

    /**
     * Get the database entry in the wanted locale.
     *
     * @param  [int] The id of the row in the db to fetch.
     *
     * @return [Eloquent Collection] The row in the db.

The doc-type Eloquent">[Eloquent could not be parsed: Unknown type name "[" at position 0. [(view supported doc-types)

     */
    public function findOrFail($id)

The return type could not be reliably inferred; please add a @return annotation.

This method seems to be duplicated in your project.

    {
        $translation_locale = \Request::input('locale');
        $default_locale = \App::getLocale();

$default_locale is not used, you could remove the assignment.

        if ($translation_locale) {
            $item = parent::findOrFail($id);
            $item->setLocale($translation_locale);

            return $item;
        }

        return parent::findOrFail($id);
    }

    /**
     * Get the database entry in the wanted locale.
     *
     * @param  [int] The id of the row in the db to fetch.
     *
     * @return [Eloquent Collection] The row in the db.

The doc-type Eloquent">[Eloquent could not be parsed: Unknown type name "[" at position 0. [(view supported doc-types)

     */
    public function find($id)

The return type could not be reliably inferred; please add a @return annotation.

This method seems to be duplicated in your project.

    {
        $translation_locale = \Request::input('locale');
        $default_locale = \App::getLocale();

$default_locale is not used, you could remove the assignment.

        if ($translation_locale) {
            $item = parent::find($id);
            $item->setLocale($translation_locale);

            return $item;
        }

        return parent::find($id);
    }

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