|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Spatie\ModelStates; |
|
4
|
|
|
|
|
5
|
|
|
use Illuminate\Database\Eloquent\Model; |
|
6
|
|
|
use Spatie\ModelStates\Exceptions\InvalidConfig; |
|
7
|
|
|
|
|
8
|
|
|
class StateConfig |
|
9
|
|
|
{ |
|
10
|
|
|
/** @var string */ |
|
11
|
|
|
public $field; |
|
12
|
|
|
|
|
13
|
|
|
/** @var string|\Spatie\ModelStates\State */ |
|
14
|
|
|
public $stateClass; |
|
15
|
|
|
|
|
16
|
|
|
/** @var string[] */ |
|
17
|
|
|
public $allowedTransitions = []; |
|
18
|
|
|
|
|
19
|
|
|
/** @var string|null */ |
|
20
|
|
|
public $defaultStateClass; |
|
21
|
|
|
|
|
22
|
|
|
public function __construct(string $field, string $stateClass) |
|
23
|
|
|
{ |
|
24
|
|
|
if (! is_subclass_of($stateClass, State::class)) { |
|
25
|
|
|
throw InvalidConfig::doesNotExtendState($stateClass); |
|
26
|
|
|
} |
|
27
|
|
|
|
|
28
|
|
|
$this->field = $field; |
|
29
|
|
|
|
|
30
|
|
|
$this->stateClass = $stateClass; |
|
31
|
|
|
} |
|
32
|
|
|
|
|
33
|
|
|
public function default(string $defaultStateClass): StateConfig |
|
34
|
|
|
{ |
|
35
|
|
|
$this->defaultStateClass = $defaultStateClass; |
|
36
|
|
|
|
|
37
|
|
|
return $this; |
|
38
|
|
|
} |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* @param string|array $from |
|
42
|
|
|
* @param string $to |
|
43
|
|
|
* @param string|null $transition |
|
44
|
|
|
* |
|
45
|
|
|
* @return \Spatie\ModelStates\StateConfig |
|
46
|
|
|
*/ |
|
47
|
|
|
public function allowTransition($from, string $to, string $transition = null): StateConfig |
|
48
|
|
|
{ |
|
49
|
|
|
if (is_array($from)) { |
|
50
|
|
|
foreach ($from as $fromState) { |
|
51
|
|
|
$this->allowTransition($fromState, $to, $transition); |
|
52
|
|
|
} |
|
53
|
|
|
|
|
54
|
|
|
return $this; |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
|
|
if (! is_subclass_of($from, $this->stateClass)) { |
|
58
|
|
|
throw InvalidConfig::doesNotExtendBaseClass($from, $this->stateClass); |
|
59
|
|
|
} |
|
60
|
|
|
|
|
61
|
|
|
if (! is_subclass_of($to, $this->stateClass)) { |
|
62
|
|
|
throw InvalidConfig::doesNotExtendBaseClass($to, $this->stateClass); |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
if ($transition && ! is_subclass_of($transition, Transition::class)) { |
|
66
|
|
|
throw InvalidConfig::doesNotExtendTransition($transition); |
|
67
|
|
|
} |
|
68
|
|
|
|
|
69
|
|
|
$this->allowedTransitions[$this->createTransitionKey($from, $to)] = $transition; |
|
70
|
|
|
|
|
71
|
|
|
return $this; |
|
72
|
|
|
} |
|
73
|
|
|
|
|
74
|
|
|
public function allowTransitions(array $transitions): StateConfig |
|
75
|
|
|
{ |
|
76
|
|
|
foreach ($transitions as $transition) { |
|
77
|
|
|
$this->allowTransition($transition[0], $transition[1], $transition[2] ?? null); |
|
78
|
|
|
} |
|
79
|
|
|
|
|
80
|
|
|
return $this; |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
|
|
public function transitionableStates(string $fromClass): array |
|
84
|
|
|
{ |
|
85
|
|
|
$transitionableStates = []; |
|
86
|
|
|
|
|
87
|
|
|
foreach ($this->allowedTransitions as $allowedTransition => $value) { |
|
88
|
|
|
[$from, $to] = explode('-', $allowedTransition); |
|
89
|
|
|
|
|
90
|
|
|
if ($from !== $fromClass) { |
|
91
|
|
|
continue; |
|
92
|
|
|
} |
|
93
|
|
|
|
|
94
|
|
|
$transitionableStates[] = $to::getMorphClass(); |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
return $transitionableStates; |
|
98
|
|
|
} |
|
99
|
|
|
|
|
100
|
|
|
/** |
|
101
|
|
|
* @param \Illuminate\Database\Eloquent\Model $model |
|
102
|
|
|
* @param string $from |
|
103
|
|
|
* @param string $to |
|
104
|
|
|
* |
|
105
|
|
|
* @return string|\Spatie\ModelStates\Transition|null |
|
106
|
|
|
*/ |
|
107
|
|
|
public function resolveTransition(Model $model, string $from, string $to) |
|
108
|
|
|
{ |
|
109
|
|
|
$transitionKey = $this->createTransitionKey($from, $to); |
|
110
|
|
|
|
|
111
|
|
|
if (! array_key_exists($transitionKey, $this->allowedTransitions)) { |
|
112
|
|
|
return; |
|
113
|
|
|
} |
|
114
|
|
|
|
|
115
|
|
|
return $this->allowedTransitions[$transitionKey] |
|
116
|
|
|
?? new DefaultTransition( |
|
117
|
|
|
$model, |
|
118
|
|
|
$this->field, |
|
119
|
|
|
$this->stateClass::make($to, $model) |
|
120
|
|
|
); |
|
121
|
|
|
} |
|
122
|
|
|
|
|
123
|
|
|
private function createTransitionKey(string $from, string $to): string |
|
124
|
|
|
{ |
|
125
|
|
|
return "{$from}-{$to}"; |
|
126
|
|
|
} |
|
127
|
|
|
} |
|
128
|
|
|
|
spatie /
laravel-model-states
