|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
declare(strict_types=1); |
|
4
|
|
|
/** |
|
5
|
|
|
* @author SignpostMarv |
|
6
|
|
|
*/ |
|
7
|
|
|
|
|
8
|
|
|
namespace SignpostMarv\DaftInterfaceCollector; |
|
9
|
|
|
|
|
10
|
|
|
use Closure; |
|
11
|
|
|
use Generator; |
|
12
|
|
|
use ReflectionClass; |
|
13
|
|
|
use ReflectionMethod; |
|
14
|
|
|
use ReflectionType; |
|
15
|
|
|
use Traversable; |
|
16
|
|
|
|
|
17
|
|
|
class StaticMethodCollector |
|
18
|
|
|
{ |
|
19
|
|
|
/** |
|
20
|
|
|
* @var array<string, array<string, string[]>> |
|
21
|
|
|
*/ |
|
22
|
|
|
private $staticMethods = []; |
|
23
|
|
|
|
|
24
|
|
|
/** |
|
25
|
|
|
* @var string[] |
|
26
|
|
|
*/ |
|
27
|
|
|
private $interfaces = []; |
|
28
|
|
|
|
|
29
|
|
|
/** |
|
30
|
|
|
* @var array<int, string> |
|
31
|
|
|
*/ |
|
32
|
|
|
private $processedSources = []; |
|
33
|
|
|
|
|
34
|
|
|
/** |
|
35
|
|
|
* @var string[] |
|
36
|
|
|
*/ |
|
37
|
|
|
private $alreadyYielded = []; |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* @var bool |
|
41
|
|
|
*/ |
|
42
|
|
|
private $autoResetProcessedSources; |
|
43
|
|
|
|
|
44
|
4 |
|
public function __construct( |
|
45
|
|
|
array $staticMethods, |
|
46
|
|
|
array $interfaces, |
|
47
|
|
|
bool $autoResetProcessedSources = true |
|
48
|
|
|
) { |
|
49
|
|
|
/** |
|
50
|
|
|
* @var array<string, array> $filteredInterfaces |
|
51
|
|
|
*/ |
|
52
|
4 |
|
$filteredInterfaces = $this->FilterArrayOfInterfaces( |
|
53
|
4 |
|
array_filter($staticMethods, 'is_array'), |
|
54
|
4 |
|
ARRAY_FILTER_USE_KEY |
|
55
|
|
|
); |
|
56
|
|
|
|
|
57
|
4 |
|
foreach ($filteredInterfaces as $interface => $methods) { |
|
58
|
4 |
|
$filteredMethods = $this->FilterMethods(new ReflectionClass($interface), $methods); |
|
59
|
4 |
|
if (count($filteredMethods) > 0) { |
|
60
|
4 |
|
$this->staticMethods[$interface] = $filteredMethods; |
|
61
|
|
|
} |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* @var string[] $filteredInterfaces |
|
66
|
|
|
*/ |
|
67
|
4 |
|
$filteredInterfaces = $this->FilterArrayOfInterfaces($interfaces); |
|
68
|
|
|
|
|
69
|
4 |
|
$this->interfaces = $filteredInterfaces; |
|
70
|
|
|
|
|
71
|
4 |
|
$this->autoResetProcessedSources = $autoResetProcessedSources; |
|
72
|
4 |
|
} |
|
73
|
|
|
|
|
74
|
4 |
|
public function Collect(string ...$implementations) : Generator |
|
75
|
|
|
{ |
|
76
|
4 |
|
if ($this->autoResetProcessedSources) { |
|
77
|
2 |
|
$this->processedSources = []; |
|
78
|
2 |
|
$this->alreadyYielded = []; |
|
79
|
|
|
} |
|
80
|
|
|
|
|
81
|
4 |
|
yield from $this->CollectInterfaces(...$implementations); |
|
82
|
4 |
|
} |
|
83
|
|
|
|
|
84
|
4 |
|
protected function CollectInterfaces(string ...$implementations) : Generator |
|
85
|
|
|
{ |
|
86
|
|
|
/** |
|
87
|
|
|
* @var string[] $interfaces |
|
88
|
|
|
*/ |
|
89
|
4 |
|
$interfaces = array_keys($this->staticMethods); |
|
90
|
4 |
|
foreach (array_filter($implementations, 'class_exists') as $implementation) { |
|
91
|
|
|
if ( |
|
92
|
4 |
|
in_array($implementation, $this->processedSources, true) || |
|
93
|
4 |
|
in_array($implementation, $this->alreadyYielded, true) |
|
94
|
|
|
) { |
|
95
|
2 |
|
continue; |
|
96
|
|
|
} |
|
97
|
4 |
|
$this->processedSources[] = $implementation; |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* @var string $interface |
|
101
|
|
|
*/ |
|
102
|
4 |
|
foreach ($this->interfaces as $interface) { |
|
103
|
4 |
|
if (is_a($implementation, $interface, true)) { |
|
104
|
|
|
yield $implementation; |
|
105
|
|
|
$this->alreadyYielded[] = $implementation; |
|
106
|
4 |
|
break; |
|
107
|
|
|
} |
|
108
|
|
|
} |
|
109
|
|
|
|
|
110
|
4 |
|
foreach ($interfaces as $interface) { |
|
111
|
4 |
|
if (is_a($implementation, $interface, true)) { |
|
112
|
|
|
/** |
|
113
|
|
|
* @var array<int, string> $types |
|
114
|
|
|
*/ |
|
115
|
4 |
|
foreach ($this->staticMethods[$interface] as $method => $types) { |
|
116
|
|
|
/** |
|
117
|
|
|
* @var iterable<string> $methodResult |
|
118
|
|
|
*/ |
|
119
|
4 |
|
$methodResult = $implementation::$method(); |
|
120
|
|
|
|
|
121
|
|
|
/** |
|
122
|
|
|
* @var string $result |
|
123
|
|
|
*/ |
|
124
|
4 |
|
foreach ($methodResult as $result) { |
|
125
|
4 |
|
if (in_array($result, $this->alreadyYielded, true)) { |
|
126
|
|
|
continue; |
|
127
|
|
|
} |
|
128
|
4 |
|
foreach ($types as $type) { |
|
129
|
4 |
|
if (is_a($result, $type, true)) { |
|
130
|
4 |
|
yield $result; |
|
131
|
4 |
|
$this->alreadyYielded[] = $result; |
|
132
|
4 |
|
continue; |
|
133
|
|
|
} |
|
134
|
|
|
} |
|
135
|
4 |
|
foreach ($interfaces as $checkResultWithInterface) { |
|
136
|
4 |
|
if (is_a($result, $checkResultWithInterface, true)) { |
|
137
|
4 |
|
yield from $this->CollectInterfaces($result); |
|
138
|
|
|
} |
|
139
|
|
|
} |
|
140
|
|
|
} |
|
141
|
|
|
} |
|
142
|
|
|
} |
|
143
|
|
|
} |
|
144
|
|
|
} |
|
145
|
4 |
|
} |
|
146
|
|
|
|
|
147
|
|
|
/** |
|
148
|
|
|
* @return string[]|array<string, mixed> |
|
149
|
|
|
*/ |
|
150
|
4 |
|
private function FilterArrayOfInterfaces(array $interfaces, int $flag = 0) : array |
|
151
|
|
|
{ |
|
152
|
4 |
|
$strings = array_filter($interfaces, 'is_string', $flag); |
|
153
|
|
|
|
|
154
|
4 |
|
return array_filter($strings, 'interface_exists', $flag); |
|
155
|
|
|
} |
|
156
|
|
|
|
|
157
|
4 |
|
private function MakeMethodFilter(ReflectionClass $ref) : Closure |
|
158
|
|
|
{ |
|
159
|
|
|
return function (string $maybe) use ($ref) : bool { |
|
160
|
|
|
return |
|
161
|
4 |
|
$ref->hasMethod($maybe) && |
|
162
|
4 |
|
$this->FilterReflectionMethod($ref->getMethod($maybe)); |
|
163
|
4 |
|
}; |
|
164
|
|
|
} |
|
165
|
|
|
|
|
166
|
4 |
|
private function FilterReflectionMethod(ReflectionMethod $refMethod) : bool |
|
167
|
|
|
{ |
|
168
|
|
|
return |
|
169
|
4 |
|
$refMethod->isStatic() && |
|
170
|
4 |
|
$refMethod->isPublic() && |
|
171
|
4 |
|
0 === $refMethod->getNumberOfRequiredParameters() && |
|
172
|
4 |
|
$this->FilterReflectionReturnType($refMethod->getReturnType()); |
|
173
|
|
|
} |
|
174
|
|
|
|
|
175
|
4 |
|
private function FilterReflectionReturnType(? ReflectionType $refReturn) : bool |
|
176
|
|
|
{ |
|
177
|
4 |
|
$refReturnName = is_null($refReturn) ? '' : $refReturn->__toString(); |
|
|
|
|
|
|
178
|
|
|
|
|
179
|
4 |
|
return 'array' === $refReturnName || is_a($refReturnName, Traversable::class, true); |
|
180
|
|
|
} |
|
181
|
|
|
|
|
182
|
|
|
/** |
|
183
|
|
|
* @return array<string, string[]> |
|
184
|
|
|
*/ |
|
185
|
4 |
|
private function FilterMethods(ReflectionClass $ref, array $methods) : array |
|
186
|
|
|
{ |
|
187
|
|
|
/** |
|
188
|
|
|
* @var array<string, string[]> $filteredMethods |
|
189
|
|
|
*/ |
|
190
|
4 |
|
$filteredMethods = []; |
|
191
|
|
|
|
|
192
|
|
|
/** |
|
193
|
|
|
* @var string $method |
|
194
|
|
|
* @var string[] $interfaces |
|
195
|
|
|
*/ |
|
196
|
|
|
foreach ( |
|
197
|
4 |
|
array_filter( |
|
198
|
4 |
|
array_filter($methods, 'is_string', ARRAY_FILTER_USE_KEY), |
|
199
|
4 |
|
$this->MakeMethodFilter($ref), |
|
200
|
4 |
|
ARRAY_FILTER_USE_KEY |
|
201
|
|
|
) as $method => $interfaces |
|
202
|
|
|
) { |
|
203
|
|
|
/** |
|
204
|
|
|
* @var string[] $methodInterfaces |
|
205
|
|
|
*/ |
|
206
|
4 |
|
$methodInterfaces = $this->FilterArrayOfInterfaces($interfaces); |
|
207
|
|
|
|
|
208
|
4 |
|
if (count($methodInterfaces) > 0) { |
|
209
|
4 |
|
$filteredMethods[$method] = $interfaces; |
|
210
|
|
|
} |
|
211
|
|
|
} |
|
212
|
|
|
|
|
213
|
4 |
|
return $filteredMethods; |
|
214
|
|
|
} |
|
215
|
|
|
} |
|
216
|
|
|
|
SignpostMarv /
daft-interface-collector
This function has been deprecated. The supplier of the function has supplied an explanatory message.
The explanatory message should give you some clue as to whether and when the function will be removed and what other function to use instead.