-
Notifications
You must be signed in to change notification settings - Fork 653
/
GetObjectVarsReturnTypeProvider.php
123 lines (108 loc) · 4.02 KB
/
GetObjectVarsReturnTypeProvider.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
<?php
namespace Psalm\Internal\Provider\ReturnTypeProvider;
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Internal\Analyzer\ClassAnalyzer;
use Psalm\Internal\Analyzer\SourceAnalyzer;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Plugin\EventHandler\Event\FunctionReturnTypeProviderEvent;
use Psalm\Plugin\EventHandler\FunctionReturnTypeProviderInterface;
use Psalm\Type;
use Psalm\Type\Atomic\TKeyedArray;
use Psalm\Type\Atomic\TNamedObject;
use Psalm\Type\Atomic\TObjectWithProperties;
use Psalm\Type\Union;
use stdClass;
use function reset;
use function strtolower;
class GetObjectVarsReturnTypeProvider implements FunctionReturnTypeProviderInterface
{
/**
* @return array<lowercase-string>
*/
public static function getFunctionIds(): array
{
return [
'get_object_vars',
];
}
public static function getGetObjectVarsReturnType(
Union $first_arg_type,
SourceAnalyzer $statements_source,
Context $context,
CodeLocation $location
): Union {
if ($first_arg_type->isSingle()) {
$atomics = $first_arg_type->getAtomicTypes();
$object_type = reset($atomics);
if ($object_type instanceof TObjectWithProperties) {
if ([] === $object_type->properties) {
return Type::getEmptyArray();
}
return new Union([
new TKeyedArray($object_type->properties)
]);
}
if ($object_type instanceof TNamedObject) {
if (strtolower($object_type->value) === strtolower(stdClass::class)) {
return Type::parseString('array<string, mixed>');
}
$codebase = $statements_source->getCodebase();
$class_storage = $codebase->classlikes->getStorageFor($object_type->value);
if (null === $class_storage) {
return Type::parseString('array<string, mixed>');
}
if ([] === $class_storage->appearing_property_ids) {
return Type::getEmptyArray();
}
$properties = [];
foreach ($class_storage->appearing_property_ids as $name => $property_id) {
if (ClassAnalyzer::checkPropertyVisibility(
$property_id,
$context,
$statements_source,
$location,
$statements_source->getSuppressedIssues(),
false
) === true) {
$property_type = $codebase->properties->getPropertyType(
$property_id,
false,
$statements_source,
$context
);
$properties[$name] = $property_type ?? Type::getMixed();
}
}
if ([] === $properties) {
return Type::getEmptyArray();
}
return new Union([
new TKeyedArray($properties)
]);
}
}
return Type::parseString('array<string, mixed>');
}
public static function getFunctionReturnType(FunctionReturnTypeProviderEvent $event): ?Union
{
$statements_source = $event->getStatementsSource();
$call_args = $event->getCallArgs();
if (!$statements_source instanceof StatementsAnalyzer
|| !$call_args
) {
return Type::getMixed();
}
if (($first_arg_type = $statements_source->node_data->getType($call_args[0]->value))
&& $first_arg_type->isObjectType()
) {
return self::getGetObjectVarsReturnType(
$first_arg_type,
$statements_source,
$event->getContext(),
$event->getCodeLocation()
);
}
return null;
}
}