1 | <?php |
||
8 | class StateConfig |
||
9 | { |
||
10 | public string $field; |
||
|
|||
11 | |||
12 | /** @var string|\Spatie\ModelStates\State */ |
||
13 | public $stateClass; |
||
14 | |||
15 | /** @var string[] */ |
||
16 | public array |
||
17 | |||
18 | $allowedTransitions = []; |
||
19 | |||
20 | public ?string $defaultStateClass = null; |
||
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 string $from |
||
102 | * @param string $to |
||
103 | * |
||
104 | * @return string|\Spatie\ModelStates\Transition|null |
||
105 | */ |
||
106 | public function resolveTransition(Model $model, string $from, string $to) |
||
107 | { |
||
108 | $transitionKey = $this->createTransitionKey($from, $to); |
||
109 | |||
110 | if (! array_key_exists($transitionKey, $this->allowedTransitions)) { |
||
111 | return; |
||
112 | } |
||
113 | |||
114 | return $this->allowedTransitions[$transitionKey] |
||
115 | ?? new DefaultTransition( |
||
116 | $model, |
||
117 | $this->field, |
||
118 | $this->stateClass::make($to, $model) |
||
119 | ); |
||
120 | } |
||
121 | |||
122 | private function createTransitionKey(string $from, string $to): string |
||
123 | { |
||
124 | return "{$from}-{$to}"; |
||
125 | } |
||
126 | } |
||
127 |