1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Spatie\ModelStatus; |
4
|
|
|
|
5
|
|
|
use DB; |
6
|
|
|
use Illuminate\Database\Eloquent\Builder; |
7
|
|
|
use Spatie\ModelStatus\Exceptions\InvalidStatus; |
8
|
|
|
use Illuminate\Database\Eloquent\Relations\MorphMany; |
9
|
|
|
use Illuminate\Database\Query\Builder as QueryBuilder; |
10
|
|
|
|
11
|
|
|
trait HasStatuses |
12
|
|
|
{ |
13
|
|
|
public function statuses(): MorphMany |
14
|
|
|
{ |
15
|
|
|
return $this->morphMany($this->getStatusModelClassName(), 'model')->latest(); |
|
|
|
|
16
|
|
|
} |
17
|
|
|
|
18
|
|
|
public function status(): ?Status |
19
|
|
|
{ |
20
|
|
|
return $this->latestStatus(); |
21
|
|
|
} |
22
|
|
|
|
23
|
|
|
public function setStatus(string $name, string $reason = ''): self |
24
|
|
|
{ |
25
|
|
|
if (! $this->isValidStatus($name, $reason)) { |
26
|
|
|
throw InvalidStatus::create($name, $reason); |
|
|
|
|
27
|
|
|
} |
28
|
|
|
|
29
|
|
|
$this->statuses()->create([ |
30
|
|
|
'name' => $name, |
31
|
|
|
'reason' => $reason, |
32
|
|
|
]); |
33
|
|
|
|
34
|
|
|
return $this; |
35
|
|
|
} |
36
|
|
|
|
37
|
|
|
public function isValidStatus(string $name, string $reason = ''): bool |
|
|
|
|
38
|
|
|
{ |
39
|
|
|
return true; |
40
|
|
|
} |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* @param string|array $names |
44
|
|
|
* |
45
|
|
|
* @return null|Status |
46
|
|
|
*/ |
47
|
|
|
public function latestStatus(...$names): ?Status |
48
|
|
|
{ |
49
|
|
|
$names = is_array($names) ? array_flatten($names) : func_get_args(); |
50
|
|
|
|
51
|
|
|
if (count($names) < 1) { |
52
|
|
|
return $this->statuses()->orderByDesc('id')->first(); |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
return $this->statuses()->whereIn('name', $names)->orderByDesc('id')->first(); |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
public function scopeCurrentStatus(Builder $builder, string $name) |
59
|
|
|
{ |
60
|
|
|
$builder |
61
|
|
|
->whereHas('statuses', function (Builder $query) use ($name) { |
62
|
|
|
$query |
63
|
|
|
->where('name', $name) |
64
|
|
|
->whereIn('id', function (QueryBuilder $query) use ($name) { |
65
|
|
|
$query |
66
|
|
|
->select(DB::raw('max(id)')) |
67
|
|
|
->from($this->getStatusTableName()) |
68
|
|
|
->where('model_type', static::class) |
69
|
|
|
->groupBy('model_id'); |
70
|
|
|
}); |
71
|
|
|
}); |
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
/** |
75
|
|
|
* @param string|array $names |
76
|
|
|
* |
77
|
|
|
* @return void |
78
|
|
|
**/ |
79
|
|
|
public function scopeOtherCurrentStatus(Builder $builder, ...$names) |
80
|
|
|
{ |
81
|
|
|
$names = is_array($names) ? array_flatten($names) : func_get_args(); |
82
|
|
|
$builder |
83
|
|
|
->whereHas('statuses', function (Builder $query) use ($names) { |
84
|
|
|
$query |
85
|
|
|
->whereNotIn('name', $names) |
86
|
|
|
->whereIn('id', function (QueryBuilder $query) use ($names) { |
87
|
|
|
$query |
88
|
|
|
->select(DB::raw('max(id)')) |
89
|
|
|
->from($this->getStatusTableName()) |
90
|
|
|
->where('model_type', static::class) |
91
|
|
|
->groupBy('model_id'); |
92
|
|
|
}); |
93
|
|
|
}) |
94
|
|
|
->orWhereDoesntHave('statuses'); |
95
|
|
|
} |
96
|
|
|
|
97
|
|
|
public function getStatusAttribute(): string |
98
|
|
|
{ |
99
|
|
|
return (string) $this->latestStatus(); |
100
|
|
|
} |
101
|
|
|
|
102
|
|
|
protected function getStatusTableName(): string |
103
|
|
|
{ |
104
|
|
|
$modelClass = $this->getStatusModelClassName(); |
105
|
|
|
|
106
|
|
|
return (new $modelClass)->getTable(); |
107
|
|
|
} |
108
|
|
|
|
109
|
|
|
protected function getStatusModelClassName(): string |
110
|
|
|
{ |
111
|
|
|
return config('model-status.status_model'); |
112
|
|
|
} |
113
|
|
|
} |
114
|
|
|
|
This check looks for methods that are used by a trait but not required by it.
To illustrate, let’s look at the following code example
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. If this method does not exist on a class mixing in this trait, the method will fail.Adding the
getId()
as an abstract method to the trait will make sure it is available.