Anomaly\Streams\Platform\Model\EloquentModel

Complexity

Total Complexity

119

Size/Duplication

Total Lines	873
Duplicated Lines	5.27 %

Coupling/Cohesion

Components	2
Dependencies	8

Importance

Changes

0

63 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	4	1
A	etag()	0	4	1
A	cache()	0	13	2
A	fireEvent()	0	4	1
A	getPresenter()	10	10	2
A	newCollection()	10	10	2
A	isTranslatable()	0	4	1
A	setTranslatable()	0	6	1
A	setTtl()	0	6	1
A	getTtl()	0	4	1
A	getCacheCollectionKey()	0	4	1
A	getTitle()	0	4	1
A	getTitleName()	0	4	2
A	isDeletable()	0	4	1
A	isRestorable()	0	4	1
A	isForceDeleting()	0	4	2
A	flushCache()	0	8	1
A	newEloquentBuilder()	10	10	2
A	translate()	0	4	1
A	translateOrDefault()	0	4	2
A	translateOrNew()	0	4	1
A	getTranslations()	0	8	2
D	getTranslation()	0	36	9
A	hasTranslation()	8	14	4
A	getTranslationModel()	0	4	1
A	getTranslationModelName()	0	4	1
A	getTranslationTableName()	0	6	1
A	getTranslationModelNameDefault()	0	4	1
A	getTranslatedAttributes()	0	4	1
A	getRelationKey()	0	4	2
A	getLocaleKey()	0	4	2
A	translations()	0	4	1
A	getAttribute()	0	15	3
A	setAttribute()	0	10	2
B	save()	0	30	6
B	saveModel()	0	31	5
B	saveTranslations()	0	25	5
A	getTranslationOrNew()	0	8	2
B	fill()	0	15	7
A	getTranslationByLocaleKey()	8	12	3
A	isTranslatedAttribute()	0	4	1
A	isTranslationAttribute()	0	4	1
A	isKeyALocale()	0	4	1
A	isTranslationDirty()	0	7	1
A	getNewTranslation()	0	16	1
A	scopeTranslatedIn()	0	9	1
A	scopeTranslated()	0	4	1
A	getUnguardedAttributes()	0	8	2
A	getDefaultLocale()	0	8	2
A	getFallbackLocale()	0	8	2
A	getTableName()	0	4	1
A	trashed()	0	4	1
A	toArray()	0	12	3
A	toRoutableArray()	0	4	1
A	alwaysFillable()	0	4	1
A	offsetExists()	0	4	2
A	getCriteriaName()	0	6	2
A	getCascades()	0	4	1
A	__get()	0	8	2
A	__call()	0	8	2
A	__isset()	0	4	2
A	__toString()	0	4	1
A	__sleep()	0	4	1

<?php namespace Anomaly\Streams\Platform\Model;

use Anomaly\Streams\Platform\Collection\CacheCollection;
use Anomaly\Streams\Platform\Traits\Hookable;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Robbo\Presenter\PresentableInterface;

/**
 * Class EloquentModel
 *
 * @link   http://pyrocms.com/
 * @author PyroCMS, Inc. <support@pyrocms.com>
 * @author Ryan Thompson <ryan@pyrocms.com>
 */
class EloquentModel extends Model implements Arrayable, PresentableInterface
{

    use Hookable;
    use DispatchesJobs;

    /**
     * Disable timestamps for this model.
     *
     * @var bool
     */
    public $timestamps = false;

    /**
     * Translatable attributes.
     *
     * @var array
     */
    protected $translatedAttributes = [];

    /**
     * The number of minutes to cache query results.
     *
     * @var null|false|int
     */
    protected $ttl = false;

    /**
     * The attributes that are
     * not mass assignable. Let upper
     * models handle this themselves.
     *
     * @var array
     */
    protected $guarded = [];

    /**
     * The title key.
     *
     * @var string
     */
    protected $titleKey = 'id';

    /**
     * Observable model events.
     *
     * @var array
     */
    protected $observables = [
        'updatingMultiple',
        'updatedMultiple',
        'deletingMultiple',
        'deletedMultiple',
    ];

    /**
     * The cascading delete-able relations.
     *
     * @var array
     */
    protected $cascades = [];

    /**
     * Runtime cache.
     *
     * @var array
     */
    protected $cache = [];

    /**
     * Get the ID.
     *
     * @return integer
     */
    public function getId()
    {
        return $this->id;

The property id does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Return the object's ETag fingerprint.
     *
     * @return string
     */
    public function etag()
    {
        return md5(get_class($this) . json_encode($this->toArray()));
    }

    /**
     * Cache a value in the
     * model's cache collection.
     *
     * @param $key
     * @param $ttl
     * @param $value
     * @return mixed
     */
    public function cache($key, $ttl, $value)
    {
        (new CacheCollection())
            ->make([$key])
            ->setKey($this->getCacheCollectionKey())
            ->index();

        return app('cache')->remember(
            $key,
            $ttl ?: $this->getTtl(),
            $value
        );
    }

    /**
     * Fire a model event.
     *
     * @param $event
     * @return mixed
     */
    public function fireEvent($event)
    {
        return $this->fireModelEvent($event);
    }

    /**
     * Return the entry presenter.
     *
     * This is against standards but required
     * by the presentable interface.
     *
     * @return EloquentPresenter
     */
    public function getPresenter()

This method seems to be duplicated in your project.

    {
        $presenter = substr(get_class($this), 0, -5) . 'Presenter';

        if (class_exists($presenter)) {
            return app()->make($presenter, ['object' => $this]);
        }

        return new EloquentPresenter($this);

The return type of return new \Anomaly\Streams\Platform\Model\EloquentPresenter($this); (Anomaly\Streams\Platform\Model\EloquentPresenter) is incompatible with the return type declared by the interface Robbo\Presenter\PresentableInterface::getPresenter of type Robbo\Presenter\Robbo\Presenter\Presenter.

    }

    /**
     * Return a new collection class with our models.
     *
     * @param  array $items
     * @return Collection
     */
    public function newCollection(array $items = [])

This method seems to be duplicated in your project.

    {
        $collection = substr(get_class($this), 0, -5) . 'Collection';

        if (class_exists($collection)) {
            return new $collection($items);
        }

        return new EloquentCollection($items);
    }

    /**
     * Return the translatable flag.
     *
     * @return bool
     */
    public function isTranslatable()
    {
        return isset($this->translationModel);
    }

    /**
     * Set the translatable flag.
     *
     * @param $translatable
     * @return $this
     */
    public function setTranslatable($translatable)
    {
        $this->translatable = $translatable;

The property translatable does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __set, maybe consider adding a @property annotation.

        return $this;
    }

    /**
     * Set the ttl.
     *
     * @param  $ttl
     * @return $this
     */
    public function setTtl($ttl)
    {
        $this->ttl = $ttl;

        return $this;
    }

    /**
     * Get the ttl.
     *
     * @return int|mixed
     */
    public function getTtl()
    {
        return $this->ttl;
    }

    /**
     * Get cache collection key.
     *
     * @return string
     */
    public function getCacheCollectionKey()
    {
        return get_called_class();
    }

    /**
     * Get the model title.
     *
     * @return mixed
     */
    public function getTitle()
    {
        return $this->{$this->getTitleName()};
    }

    /**
     * Get the title key.
     *
     * @return string
     */
    public function getTitleName()
    {
        return $this->titleName ?: 'id';

The property titleName does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Return if a row is deletable or not.
     *
     * @return bool
     */
    public function isDeletable()
    {
        return true;
    }

    /**
     * Return if the model is restorable or not.
     *
     * @return bool
     */
    public function isRestorable()
    {
        return true;
    }

    /**
     * Return whether the model is being
     * force deleted or not.
     *
     * @return bool
     */
    public function isForceDeleting()
    {
        return isset($this->forceDeleting) && $this->forceDeleting === true;

The property forceDeleting does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Flush the model's cache.
     *
     * @return $this
     */
    public function flushCache()
    {
        (new CacheCollection())->setKey($key = $this->getCacheCollectionKey())->flush();

        EloquentQueryBuilder::dropRuntimeCache($key);

        return $this;
    }

    /**
     * Create a new Eloquent query builder for the model.
     *
     * @param  \Illuminate\Database\Query\Builder $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function newEloquentBuilder($query)

This method seems to be duplicated in your project.

    {
        $builder = substr(get_class($this), 0, -5) . 'QueryBuilder';

        if (class_exists($builder)) {
            return new $builder($query);
        }

        return new EloquentQueryBuilder($query);
    }

    /*
     * Alias for getTranslation()
     */
    public function translate($locale = null, $withFallback = false)
    {
        return $this->getTranslation($locale, $withFallback);
    }

    /*
     * Alias for getTranslation()
     */
    public function translateOrDefault($locale)
    {
        return $this->getTranslation($locale, true) ?: $this;
    }

    /*
     * Alias for getTranslationOrNew()
     */
    public function translateOrNew($locale)
    {
        return $this->getTranslationOrNew($locale);
    }

    /**
     * Get related translations.
     *
     * @return EloquentCollection
     */
    public function getTranslations()
    {
        foreach ($translations = $this->translations()->get() as $translation) {
            $translation->setRelation('parent', $this);
        }

        return $translations;
    }

    /**
     * @param  null      $locale
     * @param  bool|null $withFallback
     * @return Model|null
     */
    public function getTranslation($locale = null, $withFallback = true)
    {

        /**
         * If we have a desired locale and
         * it exists then just use that locale.
         */
        if ($locale && $translation = $this->getTranslationByLocaleKey($locale)) {
            return $translation;
        }

        /**
         * If we don't have a locale or it doesn't exist
         * then go ahead and try using a fallback in using
         * the system's designated DEFAULT (not active) locale.
         */
        if ($withFallback
            && $translation = $this->getTranslationByLocaleKey($this->getDefaultLocale())
        ) {
            return $translation;
        }

        /**
         * If we still don't have a translation then
         * try looking up the FALLBACK translation.
         */
        if ($withFallback
            && $this->getFallbackLocale()
            && $this->getTranslationByLocaleKey($this->getFallbackLocale())
            && $translation = $this->getTranslationByLocaleKey($this->getFallbackLocale())
        ) {
            return $translation;
        }

        return null;
    }

    public function hasTranslation($locale = null)
    {
        $locale = $locale ?: $this->getFallbackLocale();

        foreach ($this->translations as $translation) {

The property translations does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

This code seems to be duplicated across your project.

            $translation->setRelation('parent', $this);

            if ($translation->getAttribute($this->getLocaleKey()) == $locale) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get the translation model.
     *
     * @return EloquentModel
     */
    public function getTranslationModel()
    {
        return new $this->translationModel;

The property translationModel does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get the translation model name.
     *
     * @return string
     */
    public function getTranslationModelName()
    {
        return $this->translationModel;

The property translationModel does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    /**
     * Get the translation table name.
     *
     * @return string
     */
    public function getTranslationTableName()
    {
        $model = $this->getTranslationModel();

        return $model->getTableName();
    }

    public function getTranslationModelNameDefault()
    {
        return get_class($this) . 'Translation';
    }

    /**
     * Return translated attributes.
     *
     * @return array
     */
    public function getTranslatedAttributes()
    {
        return $this->translatedAttributes;
    }

    public function getRelationKey()
    {
        return $this->translationForeignKey ?: $this->getForeignKey();

The property translationForeignKey does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function getLocaleKey()
    {
        return $this->localeKey ?: 'locale';

The property localeKey does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

    }

    public function translations()
    {
        return $this->hasMany($this->getTranslationModelName(), $this->getRelationKey());
    }

    public function getAttribute($key)
    {
        if ($this->isTranslatedAttribute($key)) {

            if (($translation = $this->getTranslation()) === null) {
                return null;
            }

            $translation->setRelation('parent', $this);

            return $translation->$key;
        }

        return parent::getAttribute($key);
    }

    /**
     * Set an attribute.
     *
     * @param  string $key
     * @param  mixed  $value
     * @return $this
     */
    public function setAttribute($key, $value)
    {
        if (in_array($key, $this->translatedAttributes)) {
            $this->getTranslationOrNew(config('app.locale'))->$key = $value;
        } else {
            parent::setAttribute($key, $value);
        }

        return $this;
    }

    /**
     * Save the model.
     *
     * We have some customization here to
     * accommodate translations. First sa
     * then save translations is translatable.
     *
     * @param  array $options
     * @return bool
     */
    public function save(array $options = [])
    {
        if (!$this->getTranslationModelName()) {
            return $this->saveModel($options);
        }

        if ($this->exists) {
            if (count($this->getDirty()) > 0) {

                // If $this->exists and dirty, $this->saveModel() has to return true. If not,

42% of this comment could be valid code. Did you maybe forget this after debugging?

                // an error has occurred. Therefore we shouldn't save the translations.
                if ($this->saveModel($options)) {
                    return $this->saveTranslations();
                }

                return false;
            } else {

                // If $this->exists and not dirty, $this->saveModel() skips saving and returns

38% of this comment could be valid code. Did you maybe forget this after debugging?

                // false. So we have to save the translations
                return $this->saveTranslations();
            }
        } elseif ($this->saveModel($options)) {

            // We save the translations only if the instance is saved in the database.
            return $this->saveTranslations();
        }

        return false;
    }

    /**
     * Save the model to the database.
     *
     * This is a direct port from Eloquent
     * with the only exception being that if
     * the model is translatable it will NOT
     * fire the saved event. The saveTranslations
     * method will do that instead.
     *
     * @param  array $options
     * @return bool
     */
    public function saveModel(array $options = [])
    {
        $query = $this->newQueryWithoutScopes();

        // If the "saving" event returns false we'll bail out of the save and return
        // false, indicating that the save failed. This provides a chance for any
        // listeners to cancel save operations if validations fail or whatever.
        if ($this->fireModelEvent('saving') === false) {
            return false;
        }

        // If the model already exists in the database we can just update our record
        // that is already in this database using the current IDs in this "where"
        // clause to only update this model. Otherwise, we'll just insert them.
        if ($this->exists) {
            $saved = $this->performUpdate($query, $options);

It seems like $query defined by $this->newQueryWithoutScopes() on line 562 can also be of type object<Illuminate\Database\Eloquent\Model>; however, Illuminate\Database\Eloquent\Model::performUpdate() does only seem to accept object<Illuminate\Database\Eloquent\Builder>, maybe add an additional type check?

The call to EloquentModel::performUpdate() has too many arguments starting with $options.

        }

        // If the model is brand new, we'll insert it into our database and set the
        // ID attribute on the model to the value of the newly inserted row's ID
        // which is typically an auto-increment value managed by the database.
        else {
            $saved = $this->performInsert($query, $options);

It seems like $query defined by $this->newQueryWithoutScopes() on line 562 can also be of type object<Illuminate\Database\Eloquent\Model>; however, Illuminate\Database\Eloquent\Model::performInsert() does only seem to accept object<Illuminate\Database\Eloquent\Builder>, maybe add an additional type check?

The call to EloquentModel::performInsert() has too many arguments starting with $options.

        }

        if ($saved && !$this->isTranslatable()) {
            $this->finishSave($options);
        }

        return $saved;
    }

    /**
     * Save translations to the database.
     *
     * @return bool
     */
    protected function saveTranslations()
    {
        $saved = true;

        foreach ($this->translations as $translation) {

The property translations does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

            $translation->setRelation('parent', $this);

            /* @var EloquentModel $translation */
            if ($saved && $this->isTranslationDirty($translation)) {
                $translation->setAttribute($this->getRelationKey(), $this->getKey());

                $saved = $translation->save();
            }
        }

        if ($this->translations->isEmpty()) {

The property translations does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

            $translation = $this->translateOrNew(config('streams::locales.default'));

            $translation->save();
        }

        $this->finishSave([]);

        return $saved;
    }

    protected function getTranslationOrNew($locale)
    {
        if (($translation = $this->getTranslation($locale, false)) === null) {
            $translation = $this->getNewTranslation($locale);
        }

        return $translation;
    }

    public function fill(array $attributes)
    {
        foreach ($attributes as $key => $values) {
            if (is_array($values) && $this->isKeyALocale($key)) {
                foreach ($values as $translationAttribute => $translationValue) {
                    if ($this->alwaysFillable() || $this->isFillable($translationAttribute)) {
                        $this->getTranslationOrNew($key)->$translationAttribute = $translationValue;
                    }
                }
                unset($attributes[$key]);
            }
        }

        return parent::fill($attributes);
    }

    private function getTranslationByLocaleKey($key)
    {
        foreach ($this->translations as $translation) {

The property translations does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

This code seems to be duplicated across your project.

            $translation->setRelation('parent', $this);

            if ($translation->getAttribute($this->getLocaleKey()) == $key) {
                return $translation;
            }
        }

        return null;
    }

    public function isTranslatedAttribute($key)
    {
        return in_array($key, $this->translatedAttributes);
    }

    protected function isTranslationAttribute($key)
    {
        return in_array($key, $this->translatedAttributes);
    }

    protected function isKeyALocale($key)
    {
        return config('streams::locales.supported.' . $key) !== null;
    }

    protected function isTranslationDirty(Model $translation)
    {
        $dirtyAttributes = $translation->getDirty();
        unset($dirtyAttributes[$this->getLocaleKey()]);

        return count($dirtyAttributes) > 0;
    }

    public function getNewTranslation($locale)
    {
        $modelName = $this->getTranslationModelName();

        /* @var EloquentModel $translation */
        $translation = new $modelName;

        $translation->setRelation('parent', $this);

        $translation->setAttribute($this->getLocaleKey(), $locale);
        $translation->setAttribute($this->getRelationKey(), $this->getKey());

        $this->translations->add($translation);

The property translations does not exist on object<Anomaly\Streams\Platform\Model\EloquentModel>. Since you implemented __get, maybe consider adding a @property annotation.

        return $translation;
    }

    public function scopeTranslatedIn(Builder $query, $locale)
    {
        return $query->whereHas(
            'translations',
            function (Builder $q) use ($locale) {
                $q->where($this->getLocaleKey(), '=', $locale);
            }
        );
    }

    public function scopeTranslated(Builder $query)
    {
        return $query->has('translations');
    }

    /**
     * Return unguarded attributes.
     *
     * @return array
     */
    public function getUnguardedAttributes()
    {
        foreach ($attributes = $this->getAttributes() as $attribute => $value) {
            $attributes[$attribute] = $value;
        }

        return array_diff_key($attributes, array_flip($this->getGuarded()));
    }

    /**
     * Get the default locale.
     *
     * @return string
     */
    protected function getDefaultLocale()
    {
        if (isset($this->cache['default_locale'])) {
            return $this->cache['default_locale'];
        }

        return $this->cache['default_locale'] = config('streams::locales.default');
    }

    /**
     * Get the fallback locale.
     *
     * @return string
     */
    protected function getFallbackLocale()
    {
        if (isset($this->cache['fallback_locale'])) {
            return $this->cache['fallback_locale'];
        }

        return $this->cache['fallback_locale'] = config('app.fallback_locale');
    }

    /**
     * This is to keep consistency with the
     * entry interface above us.
     *
     * @return string
     */
    public function getTableName()
    {
        return $this->getTable();
    }

    /**
     * Return if the entry is trashed or not.
     *
     * @return bool
     */
    public function trashed()
    {
        return parent::trashed();
    }

    public function toArray()
    {
        $attributes = $this->attributesToArray();

        foreach ($this->translatedAttributes as $field) {
            if ($translation = $this->getTranslation()) {

Are you sure the assignment to $translation is correct as $this->getTranslation() (which targets Anomaly\Streams\Platform\Model\EloquentModel::getTranslation()) seems to always return null.

                $attributes[$field] = $translation->$field;
            }
        }

        return $attributes;
    }

    /**
     * Return the routable array information.
     *
     * @return array
     */
    public function toRoutableArray()
    {
        return $this->toArray();
    }

    private function alwaysFillable()
    {
        return false;
    }

    /**
     * Determine if the given attribute exists.
     * Make sure to skip where there could be an
     * issue with relational "looking" properties.
     *
     * @param  mixed $offset
     * @return bool
     */
    public function offsetExists($offset)
    {
        return !method_exists($this, $offset) && isset($this->$offset);
    }

    /**
     * Get the criteria class.
     *
     * @return string
     */
    public function getCriteriaName()
    {
        $criteria = substr(get_class($this), 0, -5) . 'Criteria';

        return class_exists($criteria) ? $criteria : EloquentCriteria::class;
    }

    /**
     * Get the cascading actions.
     *
     * @return array
     */
    public function getCascades()
    {
        return $this->cascades;
    }

    public function __get($key)
    {
        if ($this->hasHook($hook = 'get_' . $key)) {
            return $this->call($hook, []);
        }

        return parent::__get($key);
    }

    public function __call($method, $parameters)
    {
        if ($this->hasHook($hook = snake_case($method))) {
            return $this->call($hook, $parameters);
        }

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

    /**
     * Check if an attribute exists.
     *
     * @param  string $key
     * @return bool
     */
    public function __isset($key)
    {
        return (in_array($key, $this->translatedAttributes) || parent::__isset($key));
    }

    /**
     * Return the string form of the model.
     *
     * @return string
     */
    public function __toString()
    {
        return json_encode($this->toArray());
    }

    /**
     * Remove volatile cache from
     * objects before serialization.
     *
     * @return array
     */
    public function __sleep()
    {
        return array_diff(array_keys(get_object_vars($this)), ['cache']);
    }
}