/
ImpossibleCheckTypeMethodCallRule.php
97 lines (82 loc) · 2.65 KB
/
ImpossibleCheckTypeMethodCallRule.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
<?php declare(strict_types = 1);
namespace PHPStan\Rules\Comparison;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\ShouldNotHappenException;
use function sprintf;
/**
* @implements Rule<Node\Expr\MethodCall>
*/
class ImpossibleCheckTypeMethodCallRule implements Rule
{
public function __construct(
private ImpossibleCheckTypeHelper $impossibleCheckTypeHelper,
private bool $checkAlwaysTrueCheckTypeFunctionCall,
private bool $treatPhpDocTypesAsCertain,
)
{
}
public function getNodeType(): string
{
return Node\Expr\MethodCall::class;
}
public function processNode(Node $node, Scope $scope): array
{
if (!$node->name instanceof Node\Identifier) {
return [];
}
$isAlways = $this->impossibleCheckTypeHelper->findSpecifiedType($scope, $node);
if ($isAlways === null) {
return [];
}
$addTip = function (RuleErrorBuilder $ruleErrorBuilder) use ($scope, $node): RuleErrorBuilder {
if (!$this->treatPhpDocTypesAsCertain) {
return $ruleErrorBuilder;
}
$isAlways = $this->impossibleCheckTypeHelper->doNotTreatPhpDocTypesAsCertain()->findSpecifiedType($scope, $node);
if ($isAlways !== null) {
return $ruleErrorBuilder;
}
return $ruleErrorBuilder->tip('Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.');
};
if (!$isAlways) {
$method = $this->getMethod($node->var, $node->name->name, $scope);
return [
$addTip(RuleErrorBuilder::message(sprintf(
'Call to method %s::%s()%s will always evaluate to false.',
$method->getDeclaringClass()->getDisplayName(),
$method->getName(),
$this->impossibleCheckTypeHelper->getArgumentsDescription($scope, $node->getArgs()),
)))->build(),
];
} elseif ($this->checkAlwaysTrueCheckTypeFunctionCall) {
$method = $this->getMethod($node->var, $node->name->name, $scope);
return [
$addTip(RuleErrorBuilder::message(sprintf(
'Call to method %s::%s()%s will always evaluate to true.',
$method->getDeclaringClass()->getDisplayName(),
$method->getName(),
$this->impossibleCheckTypeHelper->getArgumentsDescription($scope, $node->getArgs()),
)))->build(),
];
}
return [];
}
private function getMethod(
Expr $var,
string $methodName,
Scope $scope,
): MethodReflection
{
$calledOnType = $scope->getType($var);
$method = $scope->getMethodReflection($calledOnType, $methodName);
if ($method === null) {
throw new ShouldNotHappenException();
}
return $method;
}
}