BBSLab\NovaTranslation\Models\Traits\Translatable

Complexity

Total Complexity

17

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	bootTranslatable()	0	9	1
A	initializeTranslatable()	0	9	3
A	getNonTranslatable()	0	4	1
A	getOnCreateTranslatable()	0	4	2
A	translation()	0	4	1
A	translations()	0	9	1
A	upsertTranslationEntry()	0	16	3
A	freshTranslationId()	0	11	2
A	scopeLocale()	0	19	3

<?php

namespace BBSLab\NovaTranslation\Models\Traits;

use BBSLab\NovaTranslation\Models\Locale;
use BBSLab\NovaTranslation\Models\Translation;
use Exception;
use Illuminate\Database\Eloquent\Builder;

/**
 * @property \BBSLab\NovaTranslation\Models\Translation $translation
 */
trait Translatable
{
    /**
     * {@inheritdoc}
     */
    public static function bootTranslatable()
    {
        static::deleted(function ($model) {
            Translation::query()
                ->where('translatable_id', '=', $model->getKey())
                ->where('translatable_type', '=', get_class($model))
                ->delete();
        });
    }

    /**
     * Initialize a translatable model.
     *
     * @return void
     */
    public function initializeTranslatable()
    {
        if (! isset($this->nonTranslatable)) {
            $this->nonTranslatable = [];

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

        }
        if (! isset($this->onCreateTranslatable)) {
            $this->onCreateTranslatable = [];

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

        }
    }

    /**
     * Get the list of non translatable fields.
     *
     * @return array
     */
    public function getNonTranslatable()
    {
        return $this->nonTranslatable;
    }

    /**
     * Get the list of fields to duplicate on create.
     * (Other fields MUST BE nullable in database)
     *
     * @return array
     */
    public function getOnCreateTranslatable()
    {
        return ! empty($this->onCreateTranslatable) ? $this->onCreateTranslatable : $this->nonTranslatable;
    }

    /**
     * Translation relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphOne
     */
    public function translation()
    {
        return $this->morphOne(Translation::class, 'translatable');

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

    }

    /**
     * Return current item translations.
     *
     * @return \Illuminate\Database\Eloquent\Collection
     */
    public function translations()
    {
        return static::query()
            ->select($this->getTable().'.*', 'translations.locale_id', 'translations.translation_id')

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

            ->join('translations', $this->getTable().'.'.$this->getKeyName(), '=', 'translations.translatable_id')

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

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

            ->where('translations.translatable_type', '=', get_class($this))
            ->where('translations.translation_id', '=', $this->translation->translation_id)
            ->get();
    }

    /**
     * Create and return a translation entry for given locale ID.
     *
     * @param  int  $localeId
     * @return \BBS\Nova\Translation\Models\Translation
     */
    public function upsertTranslationEntry(int $localeId, int $translationId = 0)
    {
        $data = [
            'locale_id' => $localeId,
            'translation_id' => ! empty($translationId) ? $translationId : $this->freshTranslationId(),
            'translatable_id' => $this->getKey(),

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

            'translatable_type' => get_class($this),
        ];

        $translation = Translation::query()->where($data)->first();
        if (empty($translation)) {
            $translation = Translation::query()->create($data);
        }

        return $translation;
    }

    /**
     * Return next fresh translation ID.
     *
     * @return int
     */
    public function freshTranslationId()
    {
        /** @var \BBSLab\NovaTranslation\Models\Translation $lastTranslation */
        $lastTranslation = Translation::query()

The method select() does not exist on Illuminate\Database\Eloquent\Builder. Did you maybe mean createSelectWithConstraint()?

            ->select('translation_id')
            ->where('translatable_type', '=', get_class($this))
            ->orderBy('translation_id', 'desc')
            ->first();

        return ! empty($lastTranslation) ? ($lastTranslation->translation_id + 1) : 1;
    }

    /**
     * Scope a query to only retrieve items from given locale.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $builder
     * @param  string  $iso
     * @return \Illuminate\Database\Eloquent\Builder
     * @throws \Exception
     */
    public function scopeLocale(Builder $builder, string $iso = '')
    {
        $iso = ! empty($iso) ? $iso : app()->getLocale();

        /** @var \BBSLab\NovaTranslation\Models\Locale $locale */
        $locale = Locale::query()->select('id')->where('iso', '=', $iso)->first();

The method select() does not exist on Illuminate\Database\Eloquent\Builder. Did you maybe mean createSelectWithConstraint()?

        if (empty($locale)) {
            throw new Exception('Invalid locale provided in locale() scope "'.$iso.'"');
        }

        return $builder->join('translations', function ($join) use ($locale) {
            $model = new static;

            $join
                ->on($model->getTable().'.'.$model->getKeyName(), '=', 'translations.translatable_id')

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

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

                ->where('translations.translatable_type', '=', get_class($model))
                ->where('translations.locale_id', '=', $locale->id);
        });
    }
}