-
-
Notifications
You must be signed in to change notification settings - Fork 60
/
InjectMethodToConstructorInjectionRector.php
154 lines (127 loc) · 3.93 KB
/
InjectMethodToConstructorInjectionRector.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
<?php
declare(strict_types=1);
namespace Ssch\TYPO3Rector\CodeQuality\General;
use PhpParser\Node;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Param;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Function_;
use PHPStan\Type\ObjectType;
use Rector\NodeManipulator\ClassDependencyManipulator;
use Rector\PostRector\ValueObject\PropertyMetadata;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/DependencyInjection/Index.html
* @see \Ssch\TYPO3Rector\Tests\Rector\CodeQuality\Rector\General\InjectMethodToConstructorInjectionRector\InjectMethodToConstructorInjectionRectorTest
*/
final class InjectMethodToConstructorInjectionRector extends AbstractRector
{
/**
* @readonly
*/
private ClassDependencyManipulator $classDependencyManipulator;
public function __construct(ClassDependencyManipulator $classDependencyManipulator)
{
$this->classDependencyManipulator = $classDependencyManipulator;
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Replace inject method to constructor injection',
[
new CodeSample(
<<<'CODE_SAMPLE'
namespace App\Service;
use \TYPO3\CMS\Core\Cache\CacheManager;
class Service
{
private CacheManager $cacheManager;
public function injectCacheManager(CacheManager $cacheManager): void
{
$this->cacheManager = $cacheManager;
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
namespace App\Service;
use \TYPO3\CMS\Core\Cache\CacheManager;
class Service
{
private CacheManager $cacheManager;
public function __construct(CacheManager $cacheManager)
{
$this->cacheManager = $cacheManager;
}
}
CODE_SAMPLE
),
]
);
}
/**
* @return class-string[]
*/
public function getNodeTypes(): array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node): ?Node
{
if ($this->shouldSkip($node)) {
return null;
}
$injectMethods = array_filter(
$node->getMethods(),
static fn ($classMethod) => str_starts_with((string) $classMethod->name, 'inject')
);
if ($injectMethods === []) {
return null;
}
foreach ($injectMethods as $injectMethod) {
$params = $injectMethod->getParams();
if ($params === []) {
continue;
}
reset($params);
/** @var Param $param */
$param = current($params);
if (! $param->type instanceof FullyQualified) {
continue;
}
$paramName = $this->getName($param->var);
if ($paramName === null) {
continue;
}
$this->classDependencyManipulator->addConstructorDependency(
$node,
new PropertyMetadata($paramName, new ObjectType((string) $param->type), Class_::MODIFIER_PROTECTED)
);
$this->removeNodeFromStatements($node, $injectMethod);
}
return $node;
}
private function shouldSkip(Class_ $class): bool
{
return $class->getMethods() === [];
}
/**
* @param Class_ | ClassMethod | Function_ $nodeWithStatements
*/
private function removeNodeFromStatements(Node $nodeWithStatements, Node $toBeRemovedNode): void
{
foreach ((array) $nodeWithStatements->stmts as $key => $stmt) {
if ($toBeRemovedNode !== $stmt) {
continue;
}
unset($nodeWithStatements->stmts[$key]);
break;
}
}
}