2019-10-13 05:59:52 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
declare(strict_types=1);
|
2018-10-03 13:14:08 +00:00
|
|
|
|
2020-08-18 15:57:30 +00:00
|
|
|
namespace Rector\Php72\Rector\While_;
|
2018-10-03 13:14:08 +00:00
|
|
|
|
|
|
|
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_;
|
2021-02-08 12:33:17 +00:00
|
|
|
use Rector\Core\NodeManipulator\AssignManipulator;
|
2020-02-06 21:48:18 +00:00
|
|
|
use Rector\Core\Rector\AbstractRector;
|
2020-11-16 17:50:38 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2018-10-03 13:14:08 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @source https://wiki.php.net/rfc/deprecations_php_7_2#each
|
2020-05-03 14:07:56 +00:00
|
|
|
*
|
2020-08-18 15:57:30 +00:00
|
|
|
* @see \Rector\Php72\Tests\Rector\While_\WhileEachToForeachRector\WhileEachToForeachRectorTest
|
2018-10-03 13:14:08 +00:00
|
|
|
*/
|
|
|
|
final class WhileEachToForeachRector extends AbstractRector
|
|
|
|
{
|
2019-08-18 12:15:39 +00:00
|
|
|
/**
|
|
|
|
* @var AssignManipulator
|
|
|
|
*/
|
|
|
|
private $assignManipulator;
|
|
|
|
|
|
|
|
public function __construct(AssignManipulator $assignManipulator)
|
|
|
|
{
|
|
|
|
$this->assignManipulator = $assignManipulator;
|
|
|
|
}
|
|
|
|
|
2020-11-16 17:50:38 +00:00
|
|
|
public function getRuleDefinition(): RuleDefinition
|
2018-10-03 13:14:08 +00:00
|
|
|
{
|
2020-11-16 17:50:38 +00:00
|
|
|
return new RuleDefinition(
|
2018-10-03 13:14:08 +00:00
|
|
|
'each() function is deprecated, use foreach() instead.',
|
|
|
|
[
|
|
|
|
new CodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-03 13:14:08 +00:00
|
|
|
while (list($key, $callback) = each($callbacks)) {
|
|
|
|
// ...
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-03 13:14:08 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-03 13:14:08 +00:00
|
|
|
foreach ($callbacks as $key => $callback) {
|
|
|
|
// ...
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-03 13:14:08 +00:00
|
|
|
),
|
|
|
|
new CodeSample(
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-03 13:14:08 +00:00
|
|
|
while (list($key) = each($callbacks)) {
|
|
|
|
// ...
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-03 13:14:08 +00:00
|
|
|
,
|
2020-09-15 08:23:13 +00:00
|
|
|
<<<'CODE_SAMPLE'
|
2018-10-03 13:14:08 +00:00
|
|
|
foreach (array_keys($callbacks) as $key) {
|
|
|
|
// ...
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2018-10-03 13:14:08 +00:00
|
|
|
),
|
|
|
|
]
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @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;
|
2019-08-18 12:15:39 +00:00
|
|
|
if (! $this->assignManipulator->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;
|
|
|
|
|
2021-01-30 21:41:25 +00:00
|
|
|
$foreachedExpr = count($listNode->items) === 1 ? $this->nodeFactory->createFuncCall(
|
2019-02-27 13:21:11 +00:00
|
|
|
'array_keys',
|
|
|
|
[$eachFuncCall->args[0]]
|
|
|
|
) : $eachFuncCall->args[0]->value;
|
2018-10-03 13:14:08 +00:00
|
|
|
|
2020-07-19 18:52:42 +00:00
|
|
|
/** @var ArrayItem $arrayItem */
|
|
|
|
$arrayItem = array_pop($listNode->items);
|
|
|
|
$foreach = new Foreach_($foreachedExpr, $arrayItem, [
|
2018-10-15 04:36:58 +00:00
|
|
|
'stmts' => $node->stmts,
|
2018-10-03 13:14:08 +00:00
|
|
|
]);
|
|
|
|
|
2020-12-20 12:56:43 +00:00
|
|
|
$this->mirrorComments($foreach, $node);
|
2020-12-15 16:37:15 +00:00
|
|
|
|
2018-10-03 13:14:08 +00:00
|
|
|
// is key included? add it to foreach
|
2020-10-29 08:59:39 +00:00
|
|
|
if ($listNode->items !== []) {
|
2020-05-31 17:18:57 +00:00
|
|
|
/** @var ArrayItem|null $keyItem */
|
2018-10-03 13:14:08 +00:00
|
|
|
$keyItem = array_pop($listNode->items);
|
2020-05-31 17:18:57 +00:00
|
|
|
|
|
|
|
if ($keyItem !== null) {
|
2020-06-29 21:19:37 +00:00
|
|
|
$foreach->keyVar = $keyItem->value;
|
2020-05-31 17:18:57 +00:00
|
|
|
}
|
2018-10-03 13:14:08 +00:00
|
|
|
}
|
|
|
|
|
2020-06-29 21:19:37 +00:00
|
|
|
return $foreach;
|
2018-10-03 13:14:08 +00:00
|
|
|
}
|
|
|
|
}
|