-
-
Notifications
You must be signed in to change notification settings - Fork 680
/
FuncGetArgsToVariadicParamRector.php
169 lines (167 loc) · 5.75 KB
/
FuncGetArgsToVariadicParamRector.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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<?php
declare (strict_types=1);
namespace Rector\CodingStyle\Rector\ClassMethod;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\Closure;
use PhpParser\Node\Expr\FuncCall;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Param;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\Function_;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\Rector\AbstractRector;
use Rector\ValueObject\PhpVersionFeature;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\CodingStyle\Rector\ClassMethod\FuncGetArgsToVariadicParamRector\FuncGetArgsToVariadicParamRectorTest
*/
final class FuncGetArgsToVariadicParamRector extends AbstractRector implements MinPhpVersionInterface
{
/**
* @readonly
* @var \Rector\PhpParser\Node\BetterNodeFinder
*/
private $betterNodeFinder;
public function __construct(BetterNodeFinder $betterNodeFinder)
{
$this->betterNodeFinder = $betterNodeFinder;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Refactor func_get_args() in to a variadic param', [new CodeSample(<<<'CODE_SAMPLE'
function run()
{
$args = \func_get_args();
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
function run(...$args)
{
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [ClassMethod::class, Function_::class, Closure::class];
}
/**
* @param ClassMethod|Function_|Closure $node
*/
public function refactor(Node $node) : ?Node
{
if ($node->params !== [] || $node->stmts === null) {
return null;
}
/** @var Expression<Assign>|null $expression */
$expression = $this->matchFuncGetArgsVariableAssign($node);
if (!$expression instanceof Expression) {
return null;
}
foreach ($node->stmts as $key => $stmt) {
if (!$stmt instanceof Expression) {
continue;
}
if (!$stmt->expr instanceof Assign) {
continue;
}
$assign = $stmt->expr;
if (!$this->isFuncGetArgsFuncCall($assign->expr)) {
continue;
}
if ($assign->var instanceof Variable) {
/** @var string $variableName */
$variableName = $this->getName($assign->var);
unset($node->stmts[$key]);
return $this->applyVariadicParams($node, $variableName);
}
$assign->expr = new Variable('args');
return $this->applyVariadicParams($node, 'args');
}
return null;
}
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::VARIADIC_PARAM;
}
/**
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure $node
* @return \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure|null
*/
private function applyVariadicParams($node, string $variableName)
{
$param = $this->createVariadicParam($variableName);
if ($param->var instanceof Variable && $this->hasFunctionOrClosureInside($node, $param->var)) {
return null;
}
$node->params[] = $param;
return $node;
}
/**
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure $functionLike
*/
private function hasFunctionOrClosureInside($functionLike, Variable $variable) : bool
{
if ($functionLike->stmts === null) {
return \false;
}
return (bool) $this->betterNodeFinder->findFirst($functionLike->stmts, function (Node $node) use($variable) : bool {
if (!$node instanceof Closure && !$node instanceof Function_) {
return \false;
}
if ($node->params !== []) {
return \false;
}
$expression = $this->matchFuncGetArgsVariableAssign($node);
if (!$expression instanceof Expression) {
return \false;
}
/** @var Assign $assign */
$assign = $expression->expr;
return $this->nodeComparator->areNodesEqual($assign->var, $variable);
});
}
/**
* @return Expression<Assign>|null
* @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure $functionLike
*/
private function matchFuncGetArgsVariableAssign($functionLike) : ?Expression
{
/** @var Expression[] $expressions */
$expressions = $this->betterNodeFinder->findInstancesOfInFunctionLikeScoped($functionLike, Expression::class);
foreach ($expressions as $expression) {
if (!$expression->expr instanceof Assign) {
continue;
}
$assign = $expression->expr;
if (!$assign->expr instanceof FuncCall) {
continue;
}
if (!$this->isName($assign->expr, 'func_get_args')) {
continue;
}
return $expression;
}
return null;
}
private function createVariadicParam(string $variableName) : Param
{
$variable = new Variable($variableName);
return new Param($variable, null, null, \false, \true);
}
private function isFuncGetArgsFuncCall(Expr $expr) : bool
{
if (!$expr instanceof FuncCall) {
return \false;
}
return $this->isName($expr, 'func_get_args');
}
}