forked from phpstan/phpstan-src
/
GenericAncestorsCheck.php
136 lines (117 loc) · 3.93 KB
/
GenericAncestorsCheck.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
<?php declare(strict_types = 1);
namespace PHPStan\Rules\Generics;
use PhpParser\Node;
use PhpParser\Node\Name;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\MissingTypehintCheck;
use PHPStan\Rules\RuleError;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\Generic\GenericObjectType;
use PHPStan\Type\Generic\TemplateTypeVariance;
use PHPStan\Type\Type;
use PHPStan\Type\VerbosityLevel;
use function array_fill_keys;
use function array_keys;
use function array_map;
use function array_merge;
use function count;
use function implode;
use function in_array;
use function sprintf;
class GenericAncestorsCheck
{
/**
* @param string[] $skipCheckGenericClasses
*/
public function __construct(
private ReflectionProvider $reflectionProvider,
private GenericObjectTypeCheck $genericObjectTypeCheck,
private VarianceCheck $varianceCheck,
private bool $checkGenericClassInNonGenericObjectType,
private array $skipCheckGenericClasses,
)
{
}
/**
* @param array<Node\Name> $nameNodes
* @param array<Type> $ancestorTypes
* @return RuleError[]
*/
public function check(
array $nameNodes,
array $ancestorTypes,
string $incompatibleTypeMessage,
string $noNamesMessage,
string $noRelatedNameMessage,
string $classNotGenericMessage,
string $notEnoughTypesMessage,
string $extraTypesMessage,
string $typeIsNotSubtypeMessage,
string $invalidTypeMessage,
string $genericClassInNonGenericObjectType,
string $invalidVarianceMessage,
): array
{
$names = array_fill_keys(array_map(static fn (Name $nameNode): string => $nameNode->toString(), $nameNodes), true);
$unusedNames = $names;
$messages = [];
foreach ($ancestorTypes as $ancestorType) {
if (!$ancestorType instanceof GenericObjectType) {
$messages[] = RuleErrorBuilder::message(sprintf($incompatibleTypeMessage, $ancestorType->describe(VerbosityLevel::typeOnly())))->build();
continue;
}
$ancestorTypeClassName = $ancestorType->getClassName();
if (!isset($names[$ancestorTypeClassName])) {
if (count($names) === 0) {
$messages[] = RuleErrorBuilder::message($noNamesMessage)->build();
} else {
$messages[] = RuleErrorBuilder::message(sprintf($noRelatedNameMessage, $ancestorTypeClassName, implode(', ', array_keys($names))))->build();
}
continue;
}
unset($unusedNames[$ancestorTypeClassName]);
$genericObjectTypeCheckMessages = $this->genericObjectTypeCheck->check(
$ancestorType,
$classNotGenericMessage,
$notEnoughTypesMessage,
$extraTypesMessage,
$typeIsNotSubtypeMessage,
);
$messages = array_merge($messages, $genericObjectTypeCheckMessages);
foreach ($ancestorType->getReferencedClasses() as $referencedClass) {
if ($this->reflectionProvider->hasClass($referencedClass)) {
continue;
}
$messages[] = RuleErrorBuilder::message(sprintf($invalidTypeMessage, $referencedClass))->build();
}
$variance = TemplateTypeVariance::createStatic();
$messageContext = sprintf(
$invalidVarianceMessage,
$ancestorType->describe(VerbosityLevel::typeOnly()),
);
foreach ($this->varianceCheck->check($variance, $ancestorType, $messageContext) as $message) {
$messages[] = $message;
}
}
if ($this->checkGenericClassInNonGenericObjectType) {
foreach (array_keys($unusedNames) as $unusedName) {
if (!$this->reflectionProvider->hasClass($unusedName)) {
continue;
}
$unusedNameClassReflection = $this->reflectionProvider->getClass($unusedName);
if (in_array($unusedNameClassReflection->getName(), $this->skipCheckGenericClasses, true)) {
continue;
}
if (!$unusedNameClassReflection->isGeneric()) {
continue;
}
$messages[] = RuleErrorBuilder::message(sprintf(
$genericClassInNonGenericObjectType,
$unusedName,
implode(', ', array_keys($unusedNameClassReflection->getTemplateTypeMap()->getTypes())),
))->tip(MissingTypehintCheck::TURN_OFF_NON_GENERIC_CHECK_TIP)->build();
}
}
return $messages;
}
}