-
-
Notifications
You must be signed in to change notification settings - Fork 23
/
RequireThisCallOnLocalMethodRule.php
133 lines (114 loc) · 3.23 KB
/
RequireThisCallOnLocalMethodRule.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
<?php
declare(strict_types=1);
namespace Symplify\PHPStanRules\Rules;
use PhpParser\Node;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\NodeFinder;
use PHPStan\Analyser\Scope;
use PHPStan\Node\InClassNode;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleError;
use PHPStan\Rules\RuleErrorBuilder;
use Symplify\RuleDocGenerator\Contract\DocumentedRuleInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Symplify\PHPStanRules\Tests\Rules\RequireThisCallOnLocalMethodRule\RequireThisCallOnLocalMethodRuleTest
* @implements Rule<InClassNode>
*/
final class RequireThisCallOnLocalMethodRule implements Rule, DocumentedRuleInterface
{
/**
* @var string
*/
public const ERROR_MESSAGE = 'Use "$this-><method>()" instead of "self::<method>()" to call local method';
public function __construct(
private readonly NodeFinder $nodeFinder
) {
}
/**
* @return class-string<Node>
*/
public function getNodeType(): string
{
return InClassNode::class;
}
/**
* @param InClassNode $node
* @return RuleError[]
*/
public function processNode(Node $node, Scope $scope): array
{
$classLike = $node->getOriginalNode();
if (! $classLike instanceof Class_) {
return [];
}
$errorMessages = [];
/** @var StaticCall[] $staticCalls */
$staticCalls = $this->nodeFinder->findInstanceOf($classLike, StaticCall::class);
foreach ($staticCalls as $staticCall) {
if (! $staticCall->class instanceof Name) {
continue;
}
$staticCallClass = $staticCall->class->toString();
if ($staticCallClass !== 'self') {
continue;
}
$classMethod = $this->getClassMethodInCurrentClass($staticCall, $classLike);
if (! $classMethod instanceof ClassMethod) {
continue;
}
if ($classMethod->isStatic()) {
continue;
}
$errorMessages[] = RuleErrorBuilder::message(self::ERROR_MESSAGE)
->line($staticCall->getLine())
->build();
}
return $errorMessages;
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(self::ERROR_MESSAGE, [
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
public function run()
{
self::execute();
}
private function execute()
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeClass
{
public function run()
{
$this->execute();
}
private function execute()
{
}
}
CODE_SAMPLE
),
]);
}
private function getClassMethodInCurrentClass(StaticCall $staticCall, Class_ $class): ?ClassMethod
{
if (! $staticCall->name instanceof Identifier) {
return null;
}
$staticCallName = $staticCall->name->toString();
return $class->getMethod($staticCallName);
}
}