/
FunctionReturnTypeProvider.php
157 lines (144 loc) · 6.87 KB
/
FunctionReturnTypeProvider.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
<?php
namespace Psalm\Internal\Provider;
use Closure;
use PhpParser;
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayChunkReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayColumnReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayFillReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayFilterReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayMapReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayMergeReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayPadReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayPointerAdjustmentReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayPopReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayRandReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayReduceReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayReverseReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArraySliceReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArraySpliceReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ArrayUniqueReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ExplodeReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\FilterVarReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\FirstArgStringReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\GetClassMethodsReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\GetObjectVarsReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\HexdecReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\InArrayReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\IteratorToArrayReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\MbInternalEncodingReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\MinMaxReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\MktimeReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\ParseUrlReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\RandReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\RoundReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\StrReplaceReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\StrTrReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\TriggerErrorReturnTypeProvider;
use Psalm\Internal\Provider\ReturnTypeProvider\VersionCompareReturnTypeProvider;
use Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent;
use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
use Psalm\StatementsSource;
use Psalm\Type\Union;
use function is_subclass_of;
use function strtolower;
/**
* @internal
*/
class FunctionReturnTypeProvider
{
/**
* @var array<
* lowercase-string,
* array<Closure(FunctionReturnTypeProviderEvent): ?Union>
* >
*/
private static $handlers = [];
public function __construct()
{
self::$handlers = [];
$this->registerClass(ArrayChunkReturnTypeProvider::class);
$this->registerClass(ArrayColumnReturnTypeProvider::class);
$this->registerClass(ArrayFilterReturnTypeProvider::class);
$this->registerClass(ArrayMapReturnTypeProvider::class);
$this->registerClass(ArrayMergeReturnTypeProvider::class);
$this->registerClass(ArrayPadReturnTypeProvider::class);
$this->registerClass(ArrayPointerAdjustmentReturnTypeProvider::class);
$this->registerClass(ArrayPopReturnTypeProvider::class);
$this->registerClass(ArrayRandReturnTypeProvider::class);
$this->registerClass(ArrayReduceReturnTypeProvider::class);
$this->registerClass(ArraySliceReturnTypeProvider::class);
$this->registerClass(ArraySpliceReturnTypeProvider::class);
$this->registerClass(ArrayReverseReturnTypeProvider::class);
$this->registerClass(ArrayUniqueReturnTypeProvider::class);
$this->registerClass(ArrayFillReturnTypeProvider::class);
$this->registerClass(FilterVarReturnTypeProvider::class);
$this->registerClass(IteratorToArrayReturnTypeProvider::class);
$this->registerClass(ParseUrlReturnTypeProvider::class);
$this->registerClass(StrReplaceReturnTypeProvider::class);
$this->registerClass(StrTrReturnTypeProvider::class);
$this->registerClass(VersionCompareReturnTypeProvider::class);
$this->registerClass(MktimeReturnTypeProvider::class);
$this->registerClass(ExplodeReturnTypeProvider::class);
$this->registerClass(GetObjectVarsReturnTypeProvider::class);
$this->registerClass(GetClassMethodsReturnTypeProvider::class);
$this->registerClass(FirstArgStringReturnTypeProvider::class);
$this->registerClass(HexdecReturnTypeProvider::class);
$this->registerClass(MinMaxReturnTypeProvider::class);
$this->registerClass(TriggerErrorReturnTypeProvider::class);
$this->registerClass(RandReturnTypeProvider::class);
$this->registerClass(InArrayReturnTypeProvider::class);
$this->registerClass(RoundReturnTypeProvider::class);
$this->registerClass(MbInternalEncodingReturnTypeProvider::class);
}
/**
* @param class-string $class
*/
public function registerClass(string $class): void
{
if (is_subclass_of($class, FunctionReturnTypeProviderInterface::class, true)) {
$callable = Closure::fromCallable([$class, 'getFunctionReturnType']);
foreach ($class::getFunctionIds() as $function_id) {
$this->registerClosure($function_id, $callable);
}
}
}
/**
* @param lowercase-string $function_id
* @param Closure(FunctionReturnTypeProviderEvent): ?Union $c
*/
public function registerClosure(string $function_id, Closure $c): void
{
self::$handlers[$function_id][] = $c;
}
public function has(string $function_id): bool
{
return isset(self::$handlers[strtolower($function_id)]);
}
/**
* @param non-empty-string $function_id
*/
public function getReturnType(
StatementsSource $statements_source,
string $function_id,
PhpParser\Node\Expr\FuncCall $stmt,
Context $context,
CodeLocation $code_location
): ?Union {
foreach (self::$handlers[strtolower($function_id)] ?? [] as $function_handler) {
$event = new FunctionReturnTypeProviderEvent(
$statements_source,
$function_id,
$stmt,
$context,
$code_location
);
$return_type = $function_handler($event);
if ($return_type) {
return $return_type;
}
}
return null;
}
}