Locale\Traits\Localizable

Complexity

Total Complexity

36

Size/Duplication

Total Lines	279
Duplicated Lines	0 %

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	needsRefreshLocaleRelation()	0	3	1
A	removeLocaleRelation()	0	5	1
B	setRelation()	0	25	5
A	getAttributeFromArray()	0	10	4
B	save()	0	28	6
A	getAttribute()	0	8	2
A	joiningLocaleTable()	0	10	2
A	usesLocaleTimestamps()	0	3	1
A	getLocaleForeignKey()	0	5	1
A	getModelForeignKey()	0	9	2
A	locale()	0	11	2
A	usesFallbackLocale()	0	3	1
A	locales()	0	18	3
A	getLocaleIdAttribute()	0	3	2
A	getRelationshipFromMethod()	0	11	2
A	isLocalizableAttribute()	0	3	1

<?php

namespace Locale\Traits;

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Foundation\Events\LocaleUpdated;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\Str;
use Locale\Models\Locale;

/**
 * Trait Localizable
 *
 * @since 1.0.0
 * @package Locale\Traits
 *
 * @method BelongsToMany belongsToMany($modelClass, $joiningTable = null, $modelForeignKey = null, $localeForeignKey = null)
 *
 * @property array localize
 * @property Locale locale
 * @property Collection locales
 */
trait Localizable
{
    /**
     * Save the model to the database.
     *
     * @param  array  $options
     * @return bool
     */
    public function save(array $options = [])
    {
        $localeForeignKey = "locale_id";
        $keys = array_merge($this->localize, [$localeForeignKey]);
        $localizeAttributes = array_only($this->attributes, $keys);
        $this->attributes = array_except($this->attributes, $keys);

The property attributes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        /** @noinspection PhpUndefinedMethodInspection */
        $result = parent::save($options);

        if ($result && !empty($localizeAttributes)) {
            if (isset($localizeAttributes[$localeForeignKey])) {
                $locale = Locale::find($localizeAttributes[$localeForeignKey]);
                unset($localizeAttributes[$localeForeignKey]);
            } else {
                $locale = Locale::find(app()->getLocale());
            }

            if ($locale) {
                if (!$this->locales()->updateExistingPivot($locale->id, $localizeAttributes)) {
                    $this->locales()->save($locale, $localizeAttributes);
                }
            } else {
                // TODO - Throw exception?
            }
        }

        return $result;
    }

    //////////////
    // !Attributes

    /**
     * @since 1.0.0
     * @return string
     */
    public function getLocaleIdAttribute()
    {
        return $this->locale ? $this->locale->id : null;
    }

    /**
     * @since 1.0.0
     * @param string $key
     * @return bool
     */
    public function isLocalizableAttribute($key)
    {
        return array_search($key, $this->localize) !== false;
    }

    /**
     * Get an attribute from the model.
     *
     * @since 1.0.0
     * @param string $key
     * @return mixed
     */
    public function getAttribute($key)
    {
        if ($this->isLocalizableAttribute($key)) {
            return $this->getAttributeValue($key);

The method getAttributeValue() does not exist on Locale\Traits\Localizable. Did you maybe mean getAttribute()?

        }

        /** @noinspection PhpUndefinedMethodInspection */
        return parent::getAttribute($key);
    }

    /**
     * Get an attribute from the $attributes array.
     *
     * @param string $key
     * @return mixed
     */
    protected function getAttributeFromArray($key)
    {
        /** @noinspection PhpUndefinedMethodInspection */
        $attribute = parent::getAttributeFromArray($key);

        if (!$attribute && $this->isLocalizableAttribute($key) && $this->locale) {
            return $this->locale->translation->getAttribute($key);
        }

        return $attribute;
    }

    /**
     * Determine if the model uses locale timestamps.
     *
     * @return bool
     */
    public function usesLocaleTimestamps()
    {
        return $this->locale_timestamps ?? false;

The property locale_timestamps does not exist on Locale\Traits\Localizable. Did you mean locale?

    }

    /**
     * Determine if the model uses fallback locale.
     *
     * @return bool
     */
    public function usesFallbackLocale()
    {
        return $this->fallback_locale ?? false;

The property fallback_locale does not exist on Locale\Traits\Localizable. Did you mean locale?

    }

    /////////////////
    // !Relationships

    /**
     * @since 1.0.0
     */
    public function locale()
    {
        $locales = $this->locales();
        $canBe = [app()->getLocale()];

        if ($this->usesFallbackLocale()) {
            $canBe[] = config("app.fallback_locale");
        }

        /** @noinspection PhpUndefinedMethodInspection */
        return $locales->whereIn("id", $canBe);
    }

    /**
     * @since 1.0.0
     * @return BelongsToMany
     */
    public function locales()
    {
        $localeTable = config("locale.model");
        $modelTable = isset($this->table) ? $this->table : null;

The property table does not exist on Locale\Traits\Localizable. Did you maybe forget to declare it?

        $joiningTable = $this->joiningLocaleTable($localeTable, $modelTable);
        $modelForeignKey = $this->getModelForeignKey();
        $localeForeignKey = $this->getLocaleForeignKey();

        $locales = $this->belongsToMany($localeTable, $joiningTable, $modelForeignKey, $localeForeignKey)
                        ->withPivot($this->localize)
                        ->as("translation");

        if ($this->usesLocaleTimestamps()) {
            /** @noinspection PhpUndefinedMethodInspection */
            $locales = $locales->withTimestamps();
        }

        return $locales;
    }

    /**
     * Get a relationship value from a method.
     *
     * @param  string  $method
     * @return mixed
     *
     * @throws \LogicException
     */
    protected function getRelationshipFromMethod($method)
    {
        /** @noinspection PhpUndefinedMethodInspection */
        $results = parent::getRelationshipFromMethod($method);

        if ($method == "locale") {
            /** @noinspection PhpUndefinedMethodInspection */
            return $results->first();
        }

        return $results;
    }

    /**
     * Set the specific relationship in the model.
     *
     * @param  string  $relation
     * @param  mixed  $value
     * @return $this
     */
    public function setRelation($relation, $value)
    {
        if ($relation == "locale") {
            /** @var Collection $value */
            if ($value->count() > 1) {
                $value = $value->where("id", app()->getLocale());
            }

            $value = $value->first();

            /** @var Locale $value */
            if (!$value) {
                return $this;
            } else {
                Event::listen(LocaleUpdated::class, function ($event) use ($value) {
                    /** @var LocaleUpdated $event */
                    if ($this->needsRefreshLocaleRelation($value, $event->locale)) {
                        $this->removeLocaleRelation();
                    }
                });
            }
        }

        /** @noinspection PhpUndefinedMethodInspection */
        return parent::setRelation($relation, $value);
    }

    /**
     * Get the joining locale table name.
     *
     * @param string $locale
     * @param string $modelTable
     * @return string
     */
    public function joiningLocaleTable($locale, $modelTable = null)
    {
        $models = [
            Str::snake(class_basename($locale)),
            $modelTable ? Str::singular($modelTable) : Str::snake(class_basename($this)),
        ];

        sort($models);

        return strtolower(implode('_', $models));
    }

    /**
     * Get the foreign key name for the model.
     *
     * @return string
     */
    public function getModelForeignKey()
    {
        if (!isset($this->table)) {
            $model = Str::snake(class_basename($this));
        } else {
            $model = Str::singular($this->getTable());

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

        }

        return "{$model}_{$this->primaryKey}";

The property primaryKey does not exist on Locale\Traits\Localizable. Did you maybe forget to declare it?

    }

    /**
     * Get the foreign key name for the locale model.
     *
     * @return string
     */
    public function getLocaleForeignKey()
    {
        /** @var Model $instance */
        $instance = $this->newRelatedInstance(config("locale.model"));

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

        return Str::singular($instance->getTable()) . "_" . $instance->primaryKey;
    }

    /**
     * @since 1.0.0
     */
    public function removeLocaleRelation()
    {
        $relations = $this->getRelations();

The method getRelations() does not exist on Locale\Traits\Localizable. Did you maybe mean getRelationshipFromMethod()?

        unset($relations["locale"]);
        $this->setRelations($relations);

The method setRelations() does not exist on Locale\Traits\Localizable. Did you maybe mean setRelation()?

    }

    /**
     * @since 1.0.0
     * @param Locale $currentLocale
     * @param string $newLocaleId
     * @return bool
     */
    public function needsRefreshLocaleRelation($currentLocale, $newLocaleId)
    {
        return $currentLocale->id !== $newLocaleId;
    }
}