-
Notifications
You must be signed in to change notification settings - Fork 2
/
facade.php
executable file
·871 lines (741 loc) · 25.3 KB
/
facade.php
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
<?php
require_once $_composer_autoload_path ?? __DIR__.'/../vendor/autoload.php';
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprArrayNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprFalseNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprFloatNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprIntegerNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprNullNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprStringNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprTrueNode;
use PHPStan\PhpDocParser\Ast\ConstExpr\ConstFetchNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayShapeNode;
use PHPStan\PhpDocParser\Ast\Type\ArrayTypeNode;
use PHPStan\PhpDocParser\Ast\Type\CallableTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeForParameterNode;
use PHPStan\PhpDocParser\Ast\Type\ConditionalTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ConstTypeNode;
use PHPStan\PhpDocParser\Ast\Type\GenericTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode;
use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode;
use PHPStan\PhpDocParser\Ast\Type\ThisTypeNode;
use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode;
use PHPStan\PhpDocParser\Lexer\Lexer;
use PHPStan\PhpDocParser\Parser\ConstExprParser;
use PHPStan\PhpDocParser\Parser\PhpDocParser;
use PHPStan\PhpDocParser\Parser\TokenIterator;
use PHPStan\PhpDocParser\Parser\TypeParser;
$linting = in_array('--lint', $argv);
collect($argv)
->skip(1)
->filter(fn ($arg) => ! str_starts_with($arg, '-'))
->map(fn ($class) => new ReflectionClass($class))
->each(function ($facade) use ($linting) {
$proxies = resolveDocSees($facade);
if ($proxies->isEmpty()) {
echo "Skipping [{$facade->getName()}] as no proxies were found.".PHP_EOL;
return;
}
// Build a list of methods that are available on the Facade...
$resolvedMethods = $proxies->map(fn ($fqcn) => new ReflectionClass($fqcn))
->flatMap(fn ($class) => [$class, ...resolveDocMixins($class)])
->flatMap(resolveMethods(...))
->reject(isMagic(...))
->reject(isInternal(...))
->reject(isDeprecated(...))
->reject(fulfillsBuiltinInterface(...))
->reject(fn ($method) => conflictsWithFacade($facade, $method))
->unique(resolveName(...))
->map(normaliseDetails(...));
// Prepare the @method docblocks...
$methods = $resolvedMethods->map(function ($method) {
if (is_string($method)) {
return " * @method static {$method}";
}
$parameters = $method['parameters']->map(function ($parameter) {
$rest = $parameter['variadic'] ? '...' : '';
$default = $parameter['optional'] ? ' = '.resolveDefaultValue($parameter) : '';
return "{$parameter['type']} {$rest}{$parameter['name']}{$default}";
});
return " * @method static {$method['returns']} {$method['name']}({$parameters->join(', ')})";
});
// Fix: ensure we keep the references to the Carbon library on the Date Facade...
if ($facade->getName() === Illuminate\Support\Facades\Date::class) {
$methods->prepend(' *')
->prepend(' * @see https://github.com/briannesbitt/Carbon/blob/master/src/Carbon/Factory.php')
->prepend(' * @see https://carbon.nesbot.com/docs/');
}
// To support generics, we want to preserve any mixins on the class...
$directMixins = resolveDocTags($facade->getDocComment() ?: '', '@mixin ');
if ($methods->isEmpty()) {
echo "Skipping [{$facade->getName()}] as no methods were found.".PHP_EOL;
return;
}
// Generate the docblock...
$docblock = <<< PHP
/**
{$methods->join(PHP_EOL)}
*
{$proxies->map(fn ($class) => " * @see {$class}")->merge($proxies->isNotEmpty() && $directMixins->isNotEmpty() ? [' *'] : [])->merge($directMixins->map(fn ($class) => " * @mixin {$class}"))->join(PHP_EOL)}
*/
PHP;
if (($facade->getDocComment() ?: '') === $docblock) {
return;
}
if ($linting) {
echo "Did not find expected docblock for [{$facade->getName()}].".PHP_EOL.PHP_EOL.$docblock;
exit(1);
}
// Update the facade docblock...
echo "Updating docblock for [{$facade->getName()}].".PHP_EOL;
$contents = file_get_contents($facade->getFileName());
$contents = str_replace($facade->getDocComment(), $docblock, $contents);
file_put_contents($facade->getFileName(), $contents);
});
echo 'Done.';
exit(0);
/**
* Resolve the classes referenced in the @see docblocks.
*
* @param \ReflectionClass $class
* @return \Illuminate\Support\Collection<class-string>
*/
function resolveDocSees($class)
{
return resolveDocTags($class->getDocComment() ?: '', '@see ')
->reject(fn ($tag) => str_starts_with($tag, 'https://'));
}
/**
* Resolve the classes referenced methods in the @methods docblocks.
*
* @param \ReflectionClass $class
* @return \Illuminate\Support\Collection<string>
*/
function resolveDocMethods($class)
{
return resolveDocTags($class->getDocComment() ?: '', '@method ')
->map(fn ($tag) => Str::squish($tag))
->map(fn ($tag) => Str::before($tag, ')').')');
}
/**
* Resolve the parameters type from the @param docblocks.
*
* @param \ReflectionMethodDecorator $method
* @param \ReflectionParameter $parameter
* @return string|null
*/
function resolveDocParamType($method, $parameter)
{
$paramTypeNode = collect(parseDocblock($method->getDocComment())->getParamTagValues())
->firstWhere('parameterName', '$'.$parameter->getName());
// As we didn't find a param type, we will now recursively check if the prototype has a value specified...
if ($paramTypeNode === null) {
try {
$prototype = new ReflectionMethodDecorator($method->getPrototype(), $method->sourceClass()->getName());
return resolveDocParamType($prototype, $parameter);
} catch (Throwable) {
return null;
}
}
$type = resolveDocblockTypes($method, $paramTypeNode->type);
return is_string($type) ? trim($type, '()') : null;
}
/**
* Resolve the return type from the @return docblock.
*
* @param \ReflectionMethodDecorator $method
* @return string|null
*/
function resolveReturnDocType($method)
{
$returnTypeNode = array_values(parseDocblock($method->getDocComment())->getReturnTagValues())[0] ?? null;
if ($returnTypeNode === null) {
return null;
}
$type = resolveDocblockTypes($method, $returnTypeNode->type);
return is_string($type) ? trim($type, '()') : null;
}
/**
* Parse the given docblock.
*
* @param string $docblock
* @return \PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocNode
*/
function parseDocblock($docblock)
{
return (new PhpDocParser(new TypeParser(new ConstExprParser), new ConstExprParser))->parse(
new TokenIterator((new Lexer)->tokenize($docblock ?: '/** */'))
);
}
/**
* Resolve the types from the docblock.
*
* @param \ReflectionMethodDecorator $method
* @param \PHPStan\PhpDocParser\Ast\Type\TypeNode $typeNode
* @return string|null
*/
function resolveDocblockTypes($method, $typeNode, $depth = 1)
{
try {
if ($typeNode instanceof UnionTypeNode) {
return '('.collect($typeNode->types)
->map(fn ($node) => resolveDocblockTypes($method, $node, $depth + 1))
->unique()
->implode('|').')';
}
if ($typeNode instanceof IntersectionTypeNode) {
return '('.collect($typeNode->types)
->map(fn ($node) => resolveDocblockTypes($method, $node, $depth + 1))
->unique()
->implode('&').')';
}
if ($typeNode instanceof GenericTypeNode) {
return resolveDocblockTypes($method, $typeNode->type, $depth + 1);
}
if ($typeNode instanceof ThisTypeNode) {
return '\\'.$method->sourceClass()->getName();
}
if ($typeNode instanceof ArrayTypeNode) {
return resolveDocblockTypes($method, $typeNode->type, $depth + 1).'[]';
}
if ($typeNode instanceof IdentifierTypeNode) {
if ($typeNode->name === 'static') {
return '\\'.$method->sourceClass()->getName();
}
if ($typeNode->name === 'self') {
return '\\'.$method->getDeclaringClass()->getName();
}
if (isBuiltIn($typeNode->name)) {
return (string) $typeNode;
}
if ($typeNode->name === 'class-string') {
return 'string';
}
if ($typeNode->name === 'list') {
return 'array';
}
if ($typeNode->name === 'int-mask-of') {
return 'int';
}
$guessedFqcn = resolveClassImports($method->getDeclaringClass())->get($typeNode->name) ?? '\\'.$method->getDeclaringClass()->getNamespaceName().'\\'.$typeNode->name;
foreach ([$typeNode->name, $guessedFqcn] as $name) {
if (class_exists($name)) {
return Str::start((string) $name, '\\');
}
if (interface_exists($name)) {
return (string) $name;
}
if (enum_exists($name)) {
return (string) $name;
}
if (isKnownOptionalDependency($name)) {
return (string) $name;
}
}
return handleUnknownIdentifierType($method, $typeNode);
}
if ($typeNode instanceof ConditionalTypeNode) {
return handleConditionalType($method, $typeNode);
}
if ($typeNode instanceof NullableTypeNode) {
return '?'.resolveDocblockTypes($method, $typeNode->type, $depth + 1);
}
if ($typeNode instanceof CallableTypeNode) {
return resolveDocblockTypes($method, $typeNode->identifier, $depth + 1);
}
if ($typeNode instanceof ConstTypeNode) {
if ($typeNode->constExpr instanceof ConstExprStringNode) {
return 'string';
}
if ($typeNode->constExpr instanceof ConstFetchNode && $typeNode->constExpr->className === '\\Psr\\Log\\LogLevel') {
return 'string';
}
if ($typeNode->constExpr instanceof ConstExprIntegerNode) {
return 'int';
}
if ($typeNode->constExpr instanceof ConstExprNullNode) {
return 'null';
}
if ($typeNode->constExpr instanceof ConstExprFloatNode) {
return 'float';
}
if ($typeNode->constExpr instanceof ConstExprFalseNode) {
return 'false';
}
if ($typeNode->constExpr instanceof ConstExprTrueNode) {
return 'true';
}
if ($typeNode->constExpr instanceof ConstExprArrayNode) {
return 'false';
}
$class = $typeNode->constExpr::class;
throw new UnresolvableType('resolveDocblockTypes', <<<MESSAGE
Unknown constant type [{$class}] encountered when evaluating [{$method->sourceClass()->getName()}::{$method->getName()}].
MESSAGE);
}
if ($typeNode instanceof ArrayShapeNode) {
return 'array';
}
if ($typeNode instanceof ConditionalTypeForParameterNode) {
return resolveDocblockTypes($method, $typeNode->if, $depth + 1).'|'.resolveDocblockTypes($method, $typeNode->else, $depth + 1);
}
$class = $typeNode::class;
throw new UnresolvableType('resolveDocblockTypes', <<<MESSAGE
Unknown type node [{$class}] encountered when evaluating [{$method->sourceClass()->getName()}::{$method->getName()}].
MESSAGE);
} catch (UnresolvableType $e) {
if ($depth > 1) {
throw $e;
}
echo $e->getMessage();
echo PHP_EOL;
echo 'You can safely ignore this message if there is a native type declartion in place, which will be used as a fallback.';
echo PHP_EOL;
echo "You may tweak the {$e->method} function of the facade-documenter if a fix is required.";
echo PHP_EOL;
echo PHP_EOL;
return null;
}
}
/**
* Handle conditional types.
*
* @param \ReflectionMethodDecorator $method
* @param \PHPStan\PhpDocParser\Ast\Type\ConditionalTypeNode $typeNode
* @return string
*/
function handleConditionalType($method, $typeNode)
{
if (
in_array($method->getname(), ['pull', 'get']) &&
$method->getDeclaringClass()->getName() === Illuminate\Cache\Repository::class
) {
return 'mixed';
}
throw new UnresolvableType('handleConditionalType', <<<MESSAGE
Unknown conditional type encountered on method [{$method->getDeclaringClass()->getName()}::{$method->getName()}].
MESSAGE);
}
/**
* Handle unknown identifier types.
*
* @param \ReflectionMethodDecorator $method
* @param \PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode $typeNode
* @return string
*/
function handleUnknownIdentifierType($method, $typeNode)
{
$docblock = parseDocblock($method->getDocComment());
$boundTemplateType = collect($docblock->getTemplateTagValues())->firstWhere('name', $typeNode->name)?->bound;
if ($boundTemplateType !== null) {
$resolvedTemplateType = resolveDocblockTypes($method, $boundTemplateType);
if ($resolvedTemplateType !== null) {
return $resolvedTemplateType;
}
}
if (
$typeNode->name === 'TCacheValue' &&
$method->getDeclaringClass()->getName() === Illuminate\Cache\Repository::class
) {
return 'mixed';
}
if (
$typeNode->name === 'TWhenParameter' &&
in_array(Illuminate\Support\Traits\Conditionable::class, class_uses_recursive($method->getDeclaringClass()->getName()))
) {
return 'mixed';
}
if (
$typeNode->name === 'TWhenReturnType' &&
in_array(Illuminate\Support\Traits\Conditionable::class, class_uses_recursive($method->getDeclaringClass()->getName()))
) {
return 'mixed';
}
if (
$typeNode->name === 'TUnlessParameter' &&
in_array(Illuminate\Support\Traits\Conditionable::class, class_uses_recursive($method->getDeclaringClass()->getName()))
) {
return 'mixed';
}
if (
$typeNode->name === 'TUnlessReturnType' &&
in_array(Illuminate\Support\Traits\Conditionable::class, class_uses_recursive($method->getDeclaringClass()->getName()))
) {
return 'mixed';
}
if (
$typeNode->name === 'TEnum' &&
$method->getDeclaringClass()->getName() === Illuminate\Http\Request::class
) {
return 'object';
}
throw new UnresolvableType('handleUnknownIdentifierType', <<<MESSAGE
Unknown doctype [{$typeNode->name}] encountered, which is likely a generic, on method [{$method->getDeclaringClass()->getName()}::{$method->getName()}].
MESSAGE);
}
/**
* Determine if the type is a built-in.
*
* @param string $type
* @return bool
*/
function isBuiltIn($type)
{
return in_array($type, [
'null', 'bool', 'int', 'float', 'string', 'array', 'object',
'resource', 'never', 'void', 'mixed', 'iterable', 'self', 'static',
'parent', 'true', 'false', 'callable',
]);
}
/**
* Determine if the type is known optional dependency.
*
* @param string $type
* @return bool
*/
function isKnownOptionalDependency($type)
{
return in_array($type, [
'\Pusher\Pusher',
'\GuzzleHttp\Psr7\RequestInterface',
]);
}
/**
* Resolve the declared type.
*
* @param \ReflectionMethodDecorator $method
* @param \ReflectionType|null $type
* @return string|null
*/
function resolveType($method, $type)
{
if ($type instanceof ReflectionIntersectionType) {
return collect($type->getTypes())
->map(fn ($type) => resolveType($method, $type))
->filter()
->join('&');
}
if ($type instanceof ReflectionUnionType) {
return collect($type->getTypes())
->map(fn ($type) => resolveType($method, $type))
->filter()
->join('|');
}
if ($type instanceof ReflectionNamedType && $type->getName() === 'null') {
return 'null';
}
if ($type instanceof ReflectionNamedType) {
if ($type->getName() === 'static') {
return '\\'.$method->sourceClass()->getName();
}
if ($type->getName() === 'self') {
return '\\'.$method->getDeclaringClass()->getName();
}
return ($type->isBuiltin() ? '' : '\\').$type->getName().(($type->allowsNull() && $type->getName() !== 'mixed') ? '|null' : '');
}
return null;
}
/**
* Resolve the docblock tags.
*
* @param string $docblock
* @param string $tag
* @return \Illuminate\Support\Collection<string>
*/
function resolveDocTags($docblock, $tag)
{
return Str::of($docblock)
->explode("\n")
->skip(1)
->reverse()
->skip(1)
->reverse()
->map(fn ($line) => ltrim($line, ' \*'))
->filter(fn ($line) => str_starts_with($line, $tag))
->map(fn ($line) => Str::of($line)->after($tag)->trim()->toString())
->values();
}
/**
* Recursively resolve docblock mixins.
*
* @param \ReflectionClass $class
* @param \Illuminate\Support\Collection<class-string> $encoutered
* @return \Illuminate\Support\Collection<\ReflectionClass>
*/
function resolveDocMixins($class, $encoutered = new Collection)
{
if ($encoutered->contains($class->getName())) {
return collect();
}
$encoutered[] = $class->getName();
return resolveDocTags($class->getDocComment() ?: '', '@mixin ')
->map(fn ($mixin) => new ReflectionClass($mixin))
->flatMap(fn ($mixin) => [$mixin, ...resolveDocMixins($mixin, $encoutered)]);
}
/**
* Resolve the classes referenced methods in the @methods docblocks.
*
* @param \ReflectionMethodDecorator $method
* @return \Illuminate\Support\Collection<int, string>
*/
function resolveDocParameters($method)
{
return resolveDocTags($method->getDocComment() ?: '', '@param ')
->map(fn ($tag) => Str::squish($tag));
}
/**
* Determine if the method is magic.
*
* @param \ReflectionMethod|string $method
* @return bool
*/
function isMagic($method)
{
return Str::startsWith(is_string($method) ? $method : $method->getName(), '__');
}
/**
* Determine if the method is marked as @internal.
*
* @param \ReflectionMethod|string $method
* @return bool
*/
function isInternal($method)
{
if (is_string($method)) {
return false;
}
return resolveDocTags($method->getDocComment(), '@internal')->isNotEmpty();
}
/**
* Determine if the method is deprecated.
*
* @param \ReflectionMethod|string $method
* @return bool
*/
function isDeprecated($method)
{
if (is_string($method)) {
return false;
}
return $method->isDeprecated() || resolveDocTags($method->getDocComment(), '@deprecated')->isNotEmpty();
}
/**
* Determine if the method is for a builtin contract.
*
* @param \ReflectionMethodDecorator|string $method
* @return bool
*/
function fulfillsBuiltinInterface($method)
{
if (is_string($method)) {
return false;
}
if ($method->sourceClass()->implementsInterface(ArrayAccess::class)) {
return in_array($method->getName(), ['offsetExists', 'offsetGet', 'offsetSet', 'offsetUnset']);
}
return false;
}
/**
* Resolve the methods name.
*
* @param \ReflectionMethod|string $method
* @return string
*/
function resolveName($method)
{
return is_string($method)
? Str::of($method)->after(' ')->before('(')->toString()
: $method->getName();
}
/**
* Resolve the classes methods.
*
* @param \ReflectionClass $class
* @return \Illuminate\Support\Collection<\ReflectionMethodDecorator|string>
*/
function resolveMethods($class)
{
return collect($class->getMethods(ReflectionMethod::IS_PUBLIC))
->map(fn ($method) => new ReflectionMethodDecorator($method, $class->getName()))
->merge(resolveDocMethods($class));
}
/**
* Determine if the given method conflicts with a Facade method.
*
* @param \ReflectionClass $facade
* @param \ReflectionMethod|string $method
* @return bool
*/
function conflictsWithFacade($facade, $method)
{
return collect($facade->getMethods(ReflectionMethod::IS_PUBLIC | ReflectionMethod::IS_STATIC))
->map(fn ($method) => $method->getName())
->contains(is_string($method) ? $method : $method->getName());
}
/**
* Normalise the method details into a easier format to work with.
*
* @param \ReflectionMethodDecorator|string $method
* @return array|string
*/
function normaliseDetails($method)
{
return is_string($method) ? $method : [
'name' => $method->getName(),
'parameters' => resolveParameters($method)
->map(fn ($parameter) => [
'name' => '$'.$parameter->getName(),
'optional' => $parameter->isOptional() && ! $parameter->isVariadic(),
'default' => $parameter->isDefaultValueAvailable()
? $parameter->getDefaultValue()
: "❌ Unknown default for [{$parameter->getName()}] in [{$parameter->getDeclaringClass()?->getName()}::{$parameter->getDeclaringFunction()->getName()}] ❌",
'variadic' => $parameter->isVariadic(),
'type' => resolveDocParamType($method, $parameter) ?? resolveType($method, $parameter->getType()) ?? 'void',
]),
'returns' => resolveReturnDocType($method) ?? resolveType($method, $method->getReturnType()) ?? 'void',
];
}
/**
* Resolve the parameters for the method.
*
* @param \ReflectionMethodDecorator $method
* @return \Illuminate\Support\Collection<int, \ReflectionParameter|\DynamicParameter>
*/
function resolveParameters($method)
{
$dynamicParameters = resolveDocParameters($method)
->skip($method->getNumberOfParameters())
->mapInto(DynamicParameter::class);
return collect($method->getParameters())->merge($dynamicParameters);
}
/**
* Resolve the classes imports.
*
* @param \ReflectionClass $class
* @return \Illuminate\Support\Collection<string, class-string>
*/
function resolveClassImports($class)
{
return Str::of(file_get_contents($class->getFileName()))
->explode(PHP_EOL)
->take($class->getStartLine() - 1)
->filter(fn ($line) => preg_match('/^use [A-Za-z0-9\\\\]+( as [A-Za-z0-9]+)?;$/', $line) === 1)
->map(fn ($line) => Str::of($line)->after('use ')->before(';'))
->mapWithKeys(fn ($class) => [
((string) ($class->contains(' as ') ? $class->after(' as ') : $class->classBasename())) => $class->start('\\')->before(' as ')->toString(),
]);
}
/**
* Resolve the default value for the parameter.
*
* @param array $parameter
* @return string
*/
function resolveDefaultValue($parameter)
{
// Reflection limitation fix for:
// - Illuminate\Filesystem\Filesystem::ensureDirectoryExists()
// - Illuminate\Filesystem\Filesystem::makeDirectory()
if ($parameter['name'] === '$mode' && $parameter['default'] === 493) {
return '0755';
}
$default = json_encode($parameter['default']);
return Str::of($default === false ? 'unknown' : $default)
->replace('"', "'")
->replace('\\/', '/')
->toString();
}
/**
* @mixin \ReflectionMethod
*/
class ReflectionMethodDecorator
{
/**
* @param \ReflectionMethod $method
* @param class-string $sourceClass
*/
public function __construct(private $method, private $sourceClass)
{
//
}
/**
* @param string $name
* @param array $arguments
* @return mixed
*/
public function __call($name, $arguments)
{
return $this->method->{$name}(...$arguments);
}
/**
* @return \ReflectionMethod
*/
public function toBase()
{
return $this->method;
}
/**
* @return \ReflectionClass
*/
public function sourceClass()
{
return new ReflectionClass($this->sourceClass);
}
}
class DynamicParameter
{
/**
* @param string $definition
*/
public function __construct(private $definition)
{
//
}
/**
* @return string
*/
public function getName()
{
return Str::of($this->definition)
->after('$')
->before(' ')
->toString();
}
/**
* @return bool
*/
public function isOptional()
{
return true;
}
/**
* @return bool
*/
public function isVariadic()
{
return Str::contains($this->definition, " ...\${$this->getName()}");
}
/**
* @return bool
*/
public function isDefaultValueAvailable()
{
return true;
}
/**
* @return null
*/
public function getDefaultValue()
{
return null;
}
}
class UnresolvableType extends Exception
{
public function __construct(public string $method, string $message)
{
parent::__construct($message);
}
}