2018-10-03 13:14:08 +00:00
|
|
|
<?php declare(strict_types=1);
|
|
|
|
|
|
|
|
namespace Rector\Php\Rector\Each;
|
|
|
|
|
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Expr\ArrayItem;
|
|
|
|
use PhpParser\Node\Expr\Assign;
|
|
|
|
use PhpParser\Node\Expr\FuncCall;
|
|
|
|
use PhpParser\Node\Expr\List_;
|
|
|
|
use PhpParser\Node\Stmt\Foreach_;
|
|
|
|
use PhpParser\Node\Stmt\While_;
|
|
|
|
use Rector\Rector\AbstractRector;
|
|
|
|
use Rector\RectorDefinition\CodeSample;
|
|
|
|
use Rector\RectorDefinition\RectorDefinition;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @source https://wiki.php.net/rfc/deprecations_php_7_2#each
|
|
|
|
*/
|
|
|
|
final class WhileEachToForeachRector extends AbstractRector
|
|
|
|
{
|
|
|
|
public function getDefinition(): RectorDefinition
|
|
|
|
{
|
|
|
|
return new RectorDefinition(
|
|
|
|
'each() function is deprecated, use foreach() instead.',
|
|
|
|
[
|
|
|
|
new CodeSample(
|
|
|
|
<<<'CODE_SAMPLE'
|
|
|
|
while (list($key, $callback) = each($callbacks)) {
|
|
|
|
// ...
|
|
|
|
}
|
|
|
|
CODE_SAMPLE
|
|
|
|
,
|
|
|
|
<<<'CODE_SAMPLE'
|
|
|
|
foreach ($callbacks as $key => $callback) {
|
|
|
|
// ...
|
|
|
|
}
|
|
|
|
CODE_SAMPLE
|
|
|
|
),
|
|
|
|
new CodeSample(
|
|
|
|
<<<'CODE_SAMPLE'
|
|
|
|
while (list($key) = each($callbacks)) {
|
|
|
|
// ...
|
|
|
|
}
|
|
|
|
CODE_SAMPLE
|
|
|
|
,
|
|
|
|
<<<'CODE_SAMPLE'
|
|
|
|
foreach (array_keys($callbacks) as $key) {
|
|
|
|
// ...
|
|
|
|
}
|
|
|
|
CODE_SAMPLE
|
|
|
|
),
|
|
|
|
]
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @return string[]
|
|
|
|
*/
|
|
|
|
public function getNodeTypes(): array
|
|
|
|
{
|
|
|
|
return [While_::class];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-10-15 04:36:58 +00:00
|
|
|
* @param While_ $node
|
2018-10-03 13:14:08 +00:00
|
|
|
*/
|
2018-10-15 04:36:58 +00:00
|
|
|
public function refactor(Node $node): ?Node
|
2018-10-03 13:14:08 +00:00
|
|
|
{
|
2018-10-15 04:36:58 +00:00
|
|
|
if (! $node->cond instanceof Assign) {
|
2018-10-21 10:19:14 +00:00
|
|
|
return null;
|
2018-10-03 13:14:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/** @var Assign $assignNode */
|
2018-10-15 04:36:58 +00:00
|
|
|
$assignNode = $node->cond;
|
2018-10-03 13:14:08 +00:00
|
|
|
if (! $this->isListToEachAssign($assignNode)) {
|
2018-10-21 10:19:14 +00:00
|
|
|
return null;
|
2018-10-03 13:14:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/** @var FuncCall $eachFuncCall */
|
|
|
|
$eachFuncCall = $assignNode->expr;
|
|
|
|
|
|
|
|
/** @var List_ $listNode */
|
|
|
|
$listNode = $assignNode->var;
|
|
|
|
|
|
|
|
if (count($listNode->items) === 1) { // just one argument - the key
|
2018-11-03 09:35:05 +00:00
|
|
|
$foreachedExpr = $this->createFunction('array_keys', [$eachFuncCall->args[0]]);
|
2018-10-03 13:14:08 +00:00
|
|
|
} else {
|
|
|
|
$foreachedExpr = $eachFuncCall->args[0]->value;
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @var ArrayItem $valueItem */
|
|
|
|
$valueItem = array_pop($listNode->items);
|
|
|
|
$foreachNode = new Foreach_($foreachedExpr, $valueItem, [
|
2018-10-15 04:36:58 +00:00
|
|
|
'stmts' => $node->stmts,
|
2018-10-03 13:14:08 +00:00
|
|
|
]);
|
|
|
|
|
|
|
|
// is key included? add it to foreach
|
2019-02-17 14:12:47 +00:00
|
|
|
if (count($listNode->items) > 0) {
|
2018-10-03 13:14:08 +00:00
|
|
|
/** @var ArrayItem $keyItem */
|
|
|
|
$keyItem = array_pop($listNode->items);
|
|
|
|
$foreachNode->keyVar = $keyItem->value;
|
|
|
|
}
|
|
|
|
|
|
|
|
return $foreachNode;
|
|
|
|
}
|
|
|
|
|
|
|
|
private function isListToEachAssign(Assign $assignNode): bool
|
|
|
|
{
|
|
|
|
if (! $assignNode->var instanceof List_) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-10-22 10:43:10 +00:00
|
|
|
return $assignNode->expr instanceof FuncCall && $this->isName($assignNode->expr, 'each');
|
2018-10-03 13:14:08 +00:00
|
|
|
}
|
|
|
|
}
|