TwillModel::isTranslationModel() - Code Metrics - Inspection of "Created TwillModel trait and TwillModelInterface" - area17/twill - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 2.x (#1172)

unknown

created 2021-09-30 13:27 UTC

TwillModel::isTranslationModel() A

↳ Parent: TwillModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
rs	10

<?php

namespace A17\Twill\Models\Behaviors;

use A17\Twill\Models\Behaviors\HasPresenter;
use A17\Twill\Services\Capsules\HasCapsules;
use A17\Twill\Models\Behaviors\IsTranslatable;
use A17\Twill\Models\Tag;
use Carbon\Carbon;
use Cartalyst\Tags\TaggableTrait;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Relations\MorphToMany;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Support\Str;

trait TwillModel
{
    use SoftDeletes;
    use HasPresenter;
    use SoftDeletes;
    use TaggableTrait;
    use IsTranslatable;
    use HasCapsules;

    /**
     * @return bool
     */
    protected function isTranslationModel(): bool
    {
        return Str::endsWith(get_class($this), 'Translation');
    }

    /**
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopePublished(Builder $query): Builder
    {
        return $query->where("{$this->getTable()}.published", true);
        return $query->where("{$this->/** @scrutinizer ignore-call */ getTable()}.published", true);
    }

    /**
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopePublishedInListings(Builder $query): Builder
    {
        if ($this->isFillable('public')) {
        if ($this->/** @scrutinizer ignore-call */ isFillable('public')) {
            $query->where("{$this->getTable()}.public", true);
        }

        return $query->published()->visible();
    }

    /**
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopeVisible(Builder $query): Builder
    {
        if ($this->isFillable('publish_start_date')) {
            $query->where(function ($query) {
                $query->whereNull("{$this->getTable()}.publish_start_date")->orWhere("{$this->getTable()}.publish_start_date", '<=', Carbon::now());
            });

            if ($this->isFillable('publish_end_date')) {
                $query->where(function ($query) {
                    $query->whereNull("{$this->getTable()}.publish_end_date")->orWhere("{$this->getTable()}.publish_end_date", '>=', Carbon::now());
                });
            }
        }

        return $query;
    }

    /**
     * @param Carbon $value
     *
     * @return void
     */
    public function setPublishStartDateAttribute($value): void
    {
        $this->attributes['publish_start_date'] = $value ?? Carbon::now();

    }

    /**
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopeDraft(Builder $query): Builder
    {
        return $query->where("{$this->getTable()}.published", false);
    }

    /**
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopeOnlyTrashed(Builder $query): Builder
    {
        return $query->whereNotNull("{$this->getTable()}.deleted_at");
    }

    /**
     * @return array
     */
    public function getFillable(): array
    {
        // If the fillable attribute is filled, just use it
        $fillable = $this->fillable;

        // If fillable is empty
        // and it's a translation model
        // and the baseModel was defined
        // Use the list of translatable attributes on our base model
        if (blank($fillable) && $this->isTranslationModel() && property_exists($this, 'baseModuleModel')) {
            $baseModelClass = $this->baseModuleModel;
            $fillable = (new $baseModelClass())->getTranslatedAttributes();

            if (!collect($fillable)->contains('locale')) {
                $fillable[] = 'locale';
            }

            if (!collect($fillable)->contains('active')) {
                $fillable[] = 'active';
            }
        }

        return $fillable;
    }

    /**
     * @return array
     */
    public function getTranslatedAttributes(): array
    {
        return $this->translatedAttributes ?? [];
    }

    /**
     * @return void
     */
    protected static function bootTaggableTrait(): void
    {
        static::$tagsModel = Tag::class;
    }

    /**
     * @inheritDoc
     */
    public function tags(): MorphToMany
    {
        return $this->morphToMany(
        return $this->/** @scrutinizer ignore-call */ morphToMany(
            static::$tagsModel,
            'taggable',
            config('twill.tagged_table', 'tagged'),
            'taggable_id',
            'tag_id'
        );
    }
}


area17 / twill

Pull Request — 2.x (#1172)

TwillModel::isTranslationModel() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like