-
-
Notifications
You must be signed in to change notification settings - Fork 60
/
ProvideCObjViaMethodRector.php
136 lines (114 loc) · 3.63 KB
/
ProvideCObjViaMethodRector.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
<?php
declare(strict_types=1);
namespace Ssch\TYPO3Rector\TYPO311\v4;
use PhpParser\Builder\Method;
use PhpParser\Builder\Param;
use PhpParser\Node;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Nop;
use PhpParser\Node\Stmt\Property;
use PHPStan\Type\ObjectType;
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
use Rector\Rector\AbstractRector;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.4/Deprecation-94956-PublicCObj.html
* @see \Ssch\TYPO3Rector\Tests\Rector\v11\v4\ProvideCObjViaMethodRector\ProvideCObjViaMethodRectorTest
*/
final class ProvideCObjViaMethodRector extends AbstractRector
{
/**
* @var string
*/
private const COBJ = 'cObj';
/**
* @readonly
*/
private VisibilityManipulator $visibilityManipulator;
public function __construct(VisibilityManipulator $visibilityManipulator)
{
$this->visibilityManipulator = $visibilityManipulator;
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node): ?Node
{
if ($this->shouldSkip($node)) {
return null;
}
$cObjProperty = $node->getProperty(self::COBJ);
if (! $cObjProperty instanceof Property) {
return null;
}
if (! $cObjProperty->isPublic()) {
return null;
}
$this->visibilityManipulator->makeProtected($cObjProperty);
$this->addSetContentObjectRendererMethod($node);
return $node;
}
public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Replaces public $cObj with protected and set via method', [
new CodeSample(
<<<'CODE_SAMPLE'
class Foo
{
public $cObj;
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class Foo
{
protected $cObj;
public function setContentObjectRenderer(ContentObjectRenderer $cObj): void
{
$this->cObj = $cObj;
}
}
CODE_SAMPLE
),
]);
}
private function addSetContentObjectRendererMethod(Class_ $class): void
{
$paramBuilder = new Param(self::COBJ);
$paramBuilder->setType(new FullyQualified('TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer'));
$param = $paramBuilder->getNode();
$propertyAssignNode = $this->nodeFactory->createPropertyAssignmentWithExpr(
self::COBJ,
new Variable(self::COBJ)
);
$classMethodBuilder = new Method('setContentObjectRenderer');
$classMethodBuilder->addParam($param);
$classMethodBuilder->addStmt($propertyAssignNode);
$classMethodBuilder->makePublic();
$classMethodBuilder->setReturnType('void');
$class->stmts[] = new Nop();
$class->stmts[] = $classMethodBuilder->getNode();
}
private function shouldSkip(Class_ $class): bool
{
if ($this->isObjectType($class, new ObjectType('TYPO3\CMS\Frontend\Plugin\AbstractPlugin'))) {
return true;
}
if ($this->isObjectType($class, new ObjectType('TYPO3\CMS\Extbase\Mvc\Controller\ActionController'))) {
return true;
}
$classMethod = $class->getMethod('setContentObjectRenderer');
return $classMethod instanceof ClassMethod;
}
}