Spatie\ModelStatus\HasStatuses

Complexity

Total Complexity

14

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	statuses()	0	4	1
A	status()	0	4	1
A	setStatus()	0	13	2
A	isValidStatus()	0	4	1
A	latestStatus()	0	10	3
A	scopeCurrentStatus()	0	15	1
A	getStatusAttribute()	0	4	1
A	getStatusTableName()	0	6	1
A	getStatusModelClassName()	0	4	1
A	scopeOtherCurrentStatus()	0	17	2

<?php

namespace Spatie\ModelStatus;

use DB;
use Illuminate\Database\Eloquent\Builder;
use Spatie\ModelStatus\Exceptions\InvalidStatus;
use Illuminate\Database\Eloquent\Relations\MorphMany;
use Illuminate\Database\Query\Builder as QueryBuilder;

trait HasStatuses
{
    public function statuses(): MorphMany
    {
        return $this->morphMany($this->getStatusModelClassName(), 'model')->latest();

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

    }

    public function status(): ?Status
    {
        return $this->latestStatus();
    }

    public function setStatus(string $name, string $reason = ''): self
    {
        if (! $this->isValidStatus($name, $reason)) {
            throw InvalidStatus::create($name, $reason);

The call to InvalidStatus::create() has too many arguments starting with $reason.

        }

        $this->statuses()->create([
            'name' => $name,
            'reason' => $reason,
        ]);

        return $this;
    }

    public function isValidStatus(string $name, string $reason = ''): bool

The parameter $name is not used and could be removed.

The parameter $reason is not used and could be removed.

    {
        return true;
    }

    /**
     * @param string|array $names
     *
     * @return null|Status
     */
    public function latestStatus(...$names): ?Status
    {
        $names = is_array($names) ? array_flatten($names) : func_get_args();

        if (count($names) < 1) {
            return $this->statuses()->orderByDesc('id')->first();
        }

        return $this->statuses()->whereIn('name', $names)->orderByDesc('id')->first();
    }

    public function scopeCurrentStatus(Builder $builder, string $name)
    {
        $builder
            ->whereHas('statuses', function (Builder $query) use ($name) {
                $query
                    ->where('name', $name)
                    ->whereIn('id', function (QueryBuilder $query) use ($name) {
                        $query
                            ->select(DB::raw('max(id)'))
                            ->from($this->getStatusTableName())
                            ->where('model_type', static::class)
                            ->groupBy('model_id');
                    });
            });
    }

    /**
     * @param string|array $names
     *
     * @return void
     **/
    public function scopeOtherCurrentStatus(Builder $builder, ...$names)
    {
        $names = is_array($names) ? array_flatten($names) : func_get_args();
        $builder
            ->whereHas('statuses', function (Builder $query) use ($names) {
                $query
                    ->whereNotIn('name', $names)
                    ->whereIn('id', function (QueryBuilder $query) use ($names) {
                        $query
                            ->select(DB::raw('max(id)'))
                            ->from($this->getStatusTableName())
                            ->where('model_type', static::class)
                            ->groupBy('model_id');
                    });
            })
            ->orWhereDoesntHave('statuses');
    }

    public function getStatusAttribute(): string
    {
        return (string) $this->latestStatus();
    }

    protected function getStatusTableName(): string
    {
        $modelClass = $this->getStatusModelClassName();

        return (new $modelClass)->getTable();
    }

    protected function getStatusModelClassName(): string
    {
        return config('model-status.status_model');
    }
}