-
-
Notifications
You must be signed in to change notification settings - Fork 406
/
ModelPropertiesRuleHelper.php
190 lines (153 loc) · 7.1 KB
/
ModelPropertiesRuleHelper.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
<?php
declare(strict_types=1);
namespace NunoMaduro\Larastan\Rules\ModelProperties;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use NunoMaduro\Larastan\Types\ModelProperty\GenericModelPropertyType;
use NunoMaduro\Larastan\Types\ModelProperty\ModelPropertyType;
use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\ShouldNotHappenException;
use PHPStan\Type\ArrayType;
use PHPStan\Type\Constant\ConstantArrayType;
use PHPStan\Type\GeneralizePrecision;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeUtils;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
class ModelPropertiesRuleHelper
{
/**
* @param MethodReflection $methodReflection
* @param Scope $scope
* @param Node\Arg[] $args
* @param ClassReflection|null $modelReflection
* @return string[]
*
* @throws ShouldNotHappenException
*/
public function check(MethodReflection $methodReflection, Scope $scope, array $args, ?ClassReflection $modelReflection = null): array
{
$modelPropertyParameter = $this->hasModelPropertyParameter($methodReflection, $scope, $args, $modelReflection);
if (count($modelPropertyParameter) !== 2) {
return [];
}
/** @var int $parameterIndex */
/** @var Type $modelType */
[$parameterIndex, $modelType] = $modelPropertyParameter;
if (! (new ObjectType(Model::class))->isSuperTypeOf($modelType)->yes() || $modelType->equals(new ObjectType(Model::class))) {
return [];
}
if (! array_key_exists($parameterIndex, $args)) {
return [];
}
$argValue = $args[$parameterIndex]->value;
if (! $argValue instanceof Node\Expr) {
return [];
}
$argType = $scope->getType($argValue);
if ($argType instanceof ConstantArrayType) {
$errors = [];
$keyType = $argType->getKeyType()->generalize(GeneralizePrecision::lessSpecific());
if ($keyType->isInteger()->yes()) {
$valueTypes = $argType->getValuesArray()->getValueTypes();
} elseif ($keyType->isString()->yes()) {
$valueTypes = $argType->getKeysArray()->getValueTypes();
} else {
$valueTypes = [];
}
foreach ($valueTypes as $valueType) {
$strings = TypeUtils::getConstantStrings($valueType);
// It could be something like `DB::raw`
// We only want to analyze strings
if ($strings === []) {
continue;
}
foreach ($strings as $string) {
// TODO: maybe check table names and columns here. And for JSON access maybe just the column name
if (mb_strpos($string->getValue(), '.') !== false || mb_strpos($string->getValue(), '->') !== false) {
continue;
}
if (! $modelType->hasProperty($string->getValue())->yes()) {
$error = sprintf('Property \'%s\' does not exist in %s model.', $string->getValue(), $modelType->describe(VerbosityLevel::typeOnly()));
if ($methodReflection->getDeclaringClass()->getName() === BelongsToMany::class) {
$error .= sprintf(" If '%s' exists as a column on the pivot table, consider using 'wherePivot' or prefix the column with table name instead.", $string->getValue());
}
$errors[] = $error;
}
}
}
return $errors;
}
$argStrings = TypeUtils::getConstantStrings($argType);
if ($argStrings === []) {
return [];
}
foreach ($argStrings as $argString) {
// TODO: maybe check table names and columns here. And for JSON access maybe just the column name
if (mb_strpos($argString->getValue(), '.') !== false || mb_strpos($argString->getValue(), '->') !== false) {
return [];
}
if (! $modelType->hasProperty($argString->getValue())->yes()) {
$error = sprintf('Property \'%s\' does not exist in %s model.', $argString->getValue(), $modelType->describe(VerbosityLevel::typeOnly()));
if ((new ObjectType(BelongsToMany::class))->isSuperTypeOf(ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType())->yes()) {
$error .= sprintf(" If '%s' exists as a column on the pivot table, consider using 'wherePivot' or prefix the column with table name instead.", $argString->getValue());
}
return [$error];
}
}
return [];
}
/**
* @param MethodReflection $methodReflection
* @param Scope $scope
* @param Node\Arg[] $args
* @param ClassReflection|null $modelReflection
* @return array<int, int|Type>
*/
public function hasModelPropertyParameter(
MethodReflection $methodReflection,
Scope $scope,
array $args,
?ClassReflection $modelReflection = null
): array {
$parameters = ParametersAcceptorSelector::selectFromArgs($scope, $args, $methodReflection->getVariants())->getParameters();
foreach ($parameters as $index => $parameter) {
$type = $parameter->getType();
if ($type instanceof UnionType) {
foreach ($type->getTypes() as $innerType) {
if ($innerType instanceof GenericModelPropertyType) {
return [$index, $innerType->getGenericType()];
}
if ($innerType instanceof ModelPropertyType && $modelReflection !== null) {
return [$index, new ObjectType($modelReflection->getName())];
}
}
} elseif ($type instanceof ArrayType) {
$keyType = $type->getKeyType();
$itemType = $type->getItemType();
if ($keyType instanceof GenericModelPropertyType) {
return [$index, $keyType->getGenericType()];
}
if ($itemType instanceof GenericModelPropertyType) {
return [$index, $itemType->getGenericType()];
}
if ($modelReflection !== null && (($keyType instanceof ModelPropertyType) || ($itemType instanceof ModelPropertyType))) {
return [$index, new ObjectType($modelReflection->getName())];
}
} else {
if ($type instanceof GenericModelPropertyType) {
return [$index, $type->getGenericType()];
}
if ($modelReflection !== null && $type instanceof ModelPropertyType) {
return [$index, new ObjectType($modelReflection->getName())];
}
}
}
return [];
}
}