BBSLab\NovaTranslation\Models\Traits\Translatable

Complexity

Total Complexity

12

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getNonTranslatable()	0	4	2
A	getOnCreateTranslatable()	0	4	2
A	translation()	0	4	1
A	bootTranslatable()	0	4	1
A	translations()	0	11	1
A	upsertTranslationEntry()	0	13	2
A	freshTranslationId()	0	8	1
A	scopeLocale()	0	12	1
A	translate()	0	19	1

<?php

namespace BBSLab\NovaTranslation\Models\Traits;

use BBSLab\NovaTranslation\Models\Contracts\IsTranslatable;
use BBSLab\NovaTranslation\Models\Locale;
use BBSLab\NovaTranslation\Models\Observers\TranslatableObserver;
use BBSLab\NovaTranslation\Models\Translation;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Relations\MorphOne;
use Illuminate\Database\Query\JoinClause;

/**
 * @property \BBSLab\NovaTranslation\Models\Translation $translation
 * @method static \Illuminate\Database\Eloquent\Builder locale(?string $iso = null)
 */
trait Translatable
{
    /**
     * {@inheritdoc}
     */
    public static function bootTranslatable()
    {
        static::observe(TranslatableObserver::class);
    }

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

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

    }

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

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

    }

    /**
     * Translation relationship.
     *
     * @return \Illuminate\Database\Eloquent\Relations\MorphOne
     */
    public function translation(): MorphOne
    {
        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|self[]
     */
    public function translations(): Collection
    {
        return static::query()
            ->select($this->qualifyColumn('*'), 'translations.locale_id', 'translations.translation_id')

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

            ->with('translation')
            ->join('translations', $this->getQualifiedKeyName(), '=', 'translations.translatable_id')

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

            ->where('translations.translation_id', '=', optional($this->translation)->translation_id)
            ->where('translations.translatable_type', '=', static::class)
            ->where($this->getQualifiedKeyName(), '<>', $this->getKey())

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

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

            ->get();
    }

    /**
     * Create and return a translation entry for given locale ID.
     *
     * @param  int  $localeId
     * @param  int  $translationId
     * @return \BBSLab\NovaTranslation\Models\Translation
     */
    public function upsertTranslationEntry(int $localeId, int $translationId = 0): Translation
    {
        /** @var \BBSLab\NovaTranslation\Models\Translation $translation */
        $translation = Translation::query()
            ->firstOrCreate([
                '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' => static::class,
            ]);

        return $translation;
    }

    /**
     * Return next fresh translation ID.
     *
     * @return int
     */
    public function freshTranslationId(): int
    {
        $lastTranslation = Translation::query()
            ->where('translatable_type', '=', static::class)
            ->max('translation_id') ?? 0;

        return $lastTranslation + 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
     */
    public function scopeLocale(EloquentBuilder $builder, string $iso = null)
    {
        return $builder->join('translations', function (JoinClause $join) {
            $join->on($this->getQualifiedKeyName(), '=', 'translations.translatable_id')

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

                ->where('translations.translatable_type', '=', static::class);
        })
            ->join('locales', function (JoinClause $join) use ($iso) {
                $join->on('locales.id', '=', 'translations.locale_id')
                    ->where('locales.iso', '=', $iso ?? app()->getLocale());
            })
            ->select($this->qualifyColumn('*'));

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

    }

    /**
     * Translate model to given locale and return translated model.
     *
     * @param  \BBSLab\NovaTranslation\Models\Locale  $locale
     * @return \BBSLab\NovaTranslation\Models\Contracts\IsTranslatable
     */
    public function translate(Locale $locale)
    {
        /** @var \BBSLab\NovaTranslation\Models\Contracts\IsTranslatable $translated */
        $translated = $this->translations()->first(function (IsTranslatable $translatable) use ($locale) {
            return $translatable->translation->locale_id === $locale->getKey();

Accessing translation on the interface BBSLab\NovaTranslation\Models\Contracts\IsTranslatable suggest that you code against a concrete implementation. How about adding an instanceof check?

        });

        return $translated ?? static::withoutEvents(function () use ($locale) {
            /** @var self $translated */
            $translated = $this->newQuery()->create(

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

                $this->only(

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

                    $this->getOnCreateTranslatable()
                )
            );
            $translated->upsertTranslationEntry($locale->getKey(), $this->translation->translation_id);

            return $translated;
        });
    }
}