/
AccessPropertiesRule.php
174 lines (151 loc) · 4.71 KB
/
AccessPropertiesRule.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
<?php declare(strict_types = 1);
namespace PHPStan\Rules\Properties;
use PhpParser\Node;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Identifier;
use PHPStan\Analyser\NullsafeOperatorHelper;
use PHPStan\Analyser\Scope;
use PHPStan\Internal\SprintfHelper;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleError;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Rules\RuleLevelHelper;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\ErrorType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeUtils;
use PHPStan\Type\VerbosityLevel;
use function array_map;
use function array_merge;
use function count;
use function sprintf;
/**
* @implements Rule<Node\Expr\PropertyFetch>
*/
class AccessPropertiesRule implements Rule
{
public function __construct(
private ReflectionProvider $reflectionProvider,
private RuleLevelHelper $ruleLevelHelper,
private bool $reportMagicProperties,
private bool $checkDynamicProperties,
)
{
}
public function getNodeType(): string
{
return PropertyFetch::class;
}
public function processNode(Node $node, Scope $scope): array
{
if ($node->name instanceof Identifier) {
$names = [$node->name->name];
} else {
$names = array_map(static fn (ConstantStringType $type): string => $type->getValue(), $scope->getType($node->name)->getConstantStrings());
}
$errors = [];
foreach ($names as $name) {
$errors = array_merge($errors, $this->processSingleProperty($scope, $node, $name));
}
return $errors;
}
/**
* @return RuleError[]
*/
private function processSingleProperty(Scope $scope, PropertyFetch $node, string $name): array
{
$typeResult = $this->ruleLevelHelper->findTypeToCheck(
$scope,
NullsafeOperatorHelper::getNullsafeShortcircuitedExprRespectingScope($scope, $node->var),
sprintf('Access to property $%s on an unknown class %%s.', SprintfHelper::escapeFormatString($name)),
static fn (Type $type): bool => $type->canAccessProperties()->yes() && $type->hasProperty($name)->yes(),
);
$type = $typeResult->getType();
if ($type instanceof ErrorType) {
return $typeResult->getUnknownClassErrors();
}
if ($scope->isInExpressionAssign($node)) {
return [];
}
if ($type->canAccessProperties()->no() || $type->canAccessProperties()->maybe() && !$scope->isUndefinedExpressionAllowed($node)) {
return [
RuleErrorBuilder::message(sprintf(
'Cannot access property $%s on %s.',
$name,
$type->describe(VerbosityLevel::typeOnly()),
))->build(),
];
}
$has = $type->hasProperty($name);
if (!$has->no() && $this->canAccessUndefinedProperties($scope, $node)) {
return [];
}
if (!$has->yes()) {
if ($scope->hasExpressionType($node)->yes()) {
return [];
}
$classNames = TypeUtils::getDirectClassNames($type);
if (!$this->reportMagicProperties) {
foreach ($classNames as $className) {
if (!$this->reflectionProvider->hasClass($className)) {
continue;
}
$classReflection = $this->reflectionProvider->getClass($className);
if (
$classReflection->hasNativeMethod('__get')
|| $classReflection->hasNativeMethod('__set')
) {
return [];
}
}
}
if (count($classNames) === 1) {
$propertyClassReflection = $this->reflectionProvider->getClass($classNames[0]);
$parentClassReflection = $propertyClassReflection->getParentClass();
while ($parentClassReflection !== null) {
if ($parentClassReflection->hasProperty($name)) {
if ($scope->canAccessProperty($parentClassReflection->getProperty($name, $scope))) {
return [];
}
return [
RuleErrorBuilder::message(sprintf(
'Access to private property $%s of parent class %s.',
$name,
$parentClassReflection->getDisplayName(),
))->build(),
];
}
$parentClassReflection = $parentClassReflection->getParentClass();
}
}
$ruleErrorBuilder = RuleErrorBuilder::message(sprintf(
'Access to an undefined property %s::$%s.',
$type->describe(VerbosityLevel::typeOnly()),
$name,
));
if ($typeResult->getTip() !== null) {
$ruleErrorBuilder->tip($typeResult->getTip());
}
return [
$ruleErrorBuilder->build(),
];
}
$propertyReflection = $type->getProperty($name, $scope);
if (!$scope->canAccessProperty($propertyReflection)) {
return [
RuleErrorBuilder::message(sprintf(
'Access to %s property %s::$%s.',
$propertyReflection->isPrivate() ? 'private' : 'protected',
$type->describe(VerbosityLevel::typeOnly()),
$name,
))->build(),
];
}
return [];
}
private function canAccessUndefinedProperties(Scope $scope, Node\Expr $node): bool
{
return $scope->isUndefinedExpressionAllowed($node) && !$this->checkDynamicProperties;
}
}