Repository navigation
Expand file tree
/
Copy pathAbstractRector.php
More file actions
163 lines (138 loc) · 5.06 KB
/
Copy pathAbstractRector.php
File metadata and controls
163 lines (138 loc) · 5.06 KB
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
<?php
declare(strict_types=1);
namespace Rector\Rector;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Name;
use PhpParser\Node\PropertyItem;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Const_;
use PhpParser\Node\Stmt\Interface_;
use PhpParser\Node\Stmt\Property;
use PhpParser\Node\Stmt\Trait_;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use Rector\Application\Provider\CurrentFileProvider;
use Rector\BetterPhpDocParser\Comment\CommentsMerger;
use Rector\Contract\Rector\RectorInterface;
use Rector\Exception\ShouldNotHappenException;
use Rector\NodeNameResolver\NodeNameResolver;
use Rector\NodeTypeResolver\NodeTypeResolver;
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpParser\Comparing\NodeComparator;
use Rector\PhpParser\Node\NodeFactory;
use Rector\ValueObject\Application\File;
abstract class AbstractRector implements RectorInterface
{
protected NodeNameResolver $nodeNameResolver;
protected NodeTypeResolver $nodeTypeResolver;
protected NodeFactory $nodeFactory;
protected NodeComparator $nodeComparator;
private SimpleCallableNodeTraverser $simpleCallableNodeTraverser;
private CurrentFileProvider $currentFileProvider;
private CommentsMerger $commentsMerger;
private ReflectionProvider $reflectionProvider;
public function autowire(
NodeNameResolver $nodeNameResolver,
NodeTypeResolver $nodeTypeResolver,
SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
NodeFactory $nodeFactory,
NodeComparator $nodeComparator,
CurrentFileProvider $currentFileProvider,
CommentsMerger $commentsMerger,
ReflectionProvider $reflectionProvider
): void {
$this->nodeNameResolver = $nodeNameResolver;
$this->nodeTypeResolver = $nodeTypeResolver;
$this->simpleCallableNodeTraverser = $simpleCallableNodeTraverser;
$this->nodeFactory = $nodeFactory;
$this->nodeComparator = $nodeComparator;
$this->currentFileProvider = $currentFileProvider;
$this->commentsMerger = $commentsMerger;
$this->reflectionProvider = $reflectionProvider;
}
protected function fetchClassLikeReflection(ClassLike $classLike): ?ClassReflection
{
$className = $this->getName($classLike);
if ($className === null) {
return null;
}
if (! $this->reflectionProvider->hasClass($className)) {
throw new ShouldNotHappenException(sprintf('Class "%s" should be known at this point', $className));
}
return $this->reflectionProvider->getClass($className);
}
protected function getFile(): File
{
$file = $this->currentFileProvider->getFile();
if (! $file instanceof File) {
throw new ShouldNotHappenException(
'File object is missing. Make sure you call $this->currentFileProvider->setFile(...) before traversing.'
);
}
return $file;
}
protected function isName(Node $node, string $name): bool
{
return $this->nodeNameResolver->isName($node, $name);
}
/**
* @param string[] $names
*/
protected function isNames(Node $node, array $names): bool
{
return $this->nodeNameResolver->isNames($node, $names);
}
/**
* Some nodes have always-known string name. This makes PHPStan smarter.
* @see https://phpstan.org/writing-php-code/phpdoc-types#conditional-return-types
*
* @return ($node is Node\Param ? string :
* ($node is ClassMethod ? string :
* ($node is Property ? string :
* ($node is PropertyItem ? string :
* ($node is Trait_ ? string :
* ($node is Interface_ ? string :
* ($node is Const_ ? string :
* ($node is Node\Const_ ? string :
* ($node is Name ? string :
* string|null )))))))))
*/
protected function getName(Node $node): ?string
{
return $this->nodeNameResolver->getName($node);
}
protected function isObjectType(Node $node, ObjectType $objectType): bool
{
return $this->nodeTypeResolver->isObjectType($node, $objectType);
}
/**
* Use this method for getting expr|node type
*/
protected function getType(Node $node): Type
{
return $this->nodeTypeResolver->getType($node);
}
/**
* Use this method for getting native expr type
*/
protected function getNativeType(Expr $expr): Type
{
return $this->nodeTypeResolver->getNativeType($expr);
}
/**
* @param Node|Node[] $nodes
* @param callable(Node): (int|Node|null|Node[]) $callable
*/
protected function traverseNodesWithCallable(Node|array $nodes, callable $callable): void
{
$this->simpleCallableNodeTraverser->traverseNodesWithCallable($nodes, $callable);
}
protected function mirrorComments(Node $newNode, Node $oldNode): void
{
$this->commentsMerger->mirrorComments($newNode, $oldNode);
}
}