AbstractMacro.php
6.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
<?php
declare(strict_types=1);
/**
* This file is part of the Carbon package.
*
* (c) Brian Nesbitt <brian@nesbot.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Carbon\PHPStan;
use Closure;
use InvalidArgumentException;
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionParameter as AdapterReflectionParameter;
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionType as AdapterReflectionType;
use PHPStan\BetterReflection\Reflection\ReflectionClass as BetterReflectionClass;
use PHPStan\BetterReflection\Reflection\ReflectionFunction as BetterReflectionFunction;
use PHPStan\BetterReflection\Reflection\ReflectionParameter as BetterReflectionParameter;
use PHPStan\Reflection\Php\BuiltinMethodReflection;
use PHPStan\TrinaryLogic;
use ReflectionClass;
use ReflectionFunction;
use ReflectionMethod;
use ReflectionParameter;
use ReflectionType;
use stdClass;
use Throwable;
abstract class AbstractMacro implements BuiltinMethodReflection
{
/**
* The reflection function/method.
*
* @var ReflectionFunction|ReflectionMethod
*/
protected $reflectionFunction;
/**
* The class name.
*
* @var class-string
*/
private $className;
/**
* The method name.
*
* @var string
*/
private $methodName;
/**
* The parameters.
*
* @var ReflectionParameter[]
*/
private $parameters;
/**
* The is static.
*
* @var bool
*/
private $static = false;
/**
* Macro constructor.
*
* @param class-string $className
* @param string $methodName
* @param callable $macro
*/
public function __construct(string $className, string $methodName, $macro)
{
$this->className = $className;
$this->methodName = $methodName;
$rawReflectionFunction = \is_array($macro)
? new ReflectionMethod($macro[0], $macro[1])
: new ReflectionFunction($macro);
$this->reflectionFunction = self::hasModernParser()
? $this->getReflectionFunction($macro)
: $rawReflectionFunction; // @codeCoverageIgnore
$this->parameters = array_map(
function ($parameter) {
if ($parameter instanceof BetterReflectionParameter) {
return new AdapterReflectionParameter($parameter);
}
return $parameter; // @codeCoverageIgnore
},
$this->reflectionFunction->getParameters()
);
if ($rawReflectionFunction->isClosure()) {
try {
$closure = $rawReflectionFunction->getClosure();
$boundClosure = Closure::bind($closure, new stdClass());
$this->static = (!$boundClosure || (new ReflectionFunction($boundClosure))->getClosureThis() === null);
} catch (Throwable $e) {
$this->static = true;
}
}
}
private function getReflectionFunction($spec)
{
if (\is_array($spec) && \count($spec) === 2 && \is_string($spec[1])) {
\assert($spec[1] !== '');
if (\is_object($spec[0])) {
return BetterReflectionClass::createFromInstance($spec[0])
->getMethod($spec[1]);
}
return BetterReflectionClass::createFromName($spec[0])
->getMethod($spec[1]);
}
if (\is_string($spec)) {
return BetterReflectionFunction::createFromName($spec);
}
if ($spec instanceof Closure) {
return BetterReflectionFunction::createFromClosure($spec);
}
throw new InvalidArgumentException('Could not create reflection from the spec given'); // @codeCoverageIgnore
}
/**
* {@inheritdoc}
*/
public function getDeclaringClass(): ReflectionClass
{
return new ReflectionClass($this->className);
}
/**
* {@inheritdoc}
*/
public function isPrivate(): bool
{
return false;
}
/**
* {@inheritdoc}
*/
public function isPublic(): bool
{
return true;
}
/**
* {@inheritdoc}
*/
public function isFinal(): bool
{
return false;
}
/**
* {@inheritdoc}
*/
public function isInternal(): bool
{
return false;
}
/**
* {@inheritdoc}
*/
public function isAbstract(): bool
{
return false;
}
/**
* {@inheritdoc}
*/
public function isStatic(): bool
{
return $this->static;
}
/**
* {@inheritdoc}
*/
public function getDocComment(): ?string
{
return $this->reflectionFunction->getDocComment() ?: null;
}
/**
* {@inheritdoc}
*/
public function getName(): string
{
return $this->methodName;
}
/**
* {@inheritdoc}
*/
public function getParameters(): array
{
return $this->parameters;
}
/**
* {@inheritdoc}
*/
public function getReturnType(): ?ReflectionType
{
$type = $this->reflectionFunction->getReturnType();
if ($type instanceof ReflectionType) {
return $type; // @codeCoverageIgnore
}
return self::adaptType($type);
}
/**
* {@inheritdoc}
*/
public function isDeprecated(): TrinaryLogic
{
return TrinaryLogic::createFromBoolean(
$this->reflectionFunction->isDeprecated() ||
preg_match('/@deprecated/i', $this->getDocComment() ?: '')
);
}
/**
* {@inheritdoc}
*/
public function isVariadic(): bool
{
return $this->reflectionFunction->isVariadic();
}
/**
* {@inheritdoc}
*/
public function getPrototype(): BuiltinMethodReflection
{
return $this;
}
public function getTentativeReturnType(): ?ReflectionType
{
return null;
}
public function returnsByReference(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
private static function adaptType($type)
{
$method = method_exists(AdapterReflectionType::class, 'fromTypeOrNull')
? 'fromTypeOrNull'
: 'fromReturnTypeOrNull'; // @codeCoverageIgnore
return AdapterReflectionType::$method($type);
}
private static function hasModernParser(): bool
{
static $modernParser = null;
if ($modernParser !== null) {
return $modernParser;
}
$modernParser = method_exists(AdapterReflectionType::class, 'fromTypeOrNull');
return $modernParser;
}
}