mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-03 18:00:50 +00:00
96112cb1f0
2da49992cc [Downgrade] [PHP 7.2] Make DowngradeParameterTypeWideningRector always downgrade to phpdoc type (#390)
96 lines
3.2 KiB
PHP
96 lines
3.2 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Php72\Rector\While_;
|
|
|
|
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\Core\NodeManipulator\AssignManipulator;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @changelog https://wiki.php.net/rfc/deprecations_php_7_2#each
|
|
*
|
|
* @see \Rector\Tests\Php72\Rector\While_\WhileEachToForeachRector\WhileEachToForeachRectorTest
|
|
*/
|
|
final class WhileEachToForeachRector extends \Rector\Core\Rector\AbstractRector
|
|
{
|
|
/**
|
|
* @var \Rector\Core\NodeManipulator\AssignManipulator
|
|
*/
|
|
private $assignManipulator;
|
|
public function __construct(\Rector\Core\NodeManipulator\AssignManipulator $assignManipulator)
|
|
{
|
|
$this->assignManipulator = $assignManipulator;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('each() function is deprecated, use foreach() instead.', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
while (list($key, $callback) = each($callbacks)) {
|
|
// ...
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
foreach ($callbacks as $key => $callback) {
|
|
// ...
|
|
}
|
|
CODE_SAMPLE
|
|
), new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample(<<<'CODE_SAMPLE'
|
|
while (list($key) = each($callbacks)) {
|
|
// ...
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
foreach (array_keys($callbacks) as $key) {
|
|
// ...
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Stmt\While_::class];
|
|
}
|
|
/**
|
|
* @param While_ $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
if (!$node->cond instanceof \PhpParser\Node\Expr\Assign) {
|
|
return null;
|
|
}
|
|
/** @var Assign $assignNode */
|
|
$assignNode = $node->cond;
|
|
if (!$this->assignManipulator->isListToEachAssign($assignNode)) {
|
|
return null;
|
|
}
|
|
/** @var FuncCall $eachFuncCall */
|
|
$eachFuncCall = $assignNode->expr;
|
|
/** @var List_ $listNode */
|
|
$listNode = $assignNode->var;
|
|
$foreachedExpr = \count($listNode->items) === 1 ? $this->nodeFactory->createFuncCall('array_keys', [$eachFuncCall->args[0]]) : $eachFuncCall->args[0]->value;
|
|
/** @var ArrayItem $arrayItem */
|
|
$arrayItem = \array_pop($listNode->items);
|
|
$foreach = new \PhpParser\Node\Stmt\Foreach_($foreachedExpr, $arrayItem, ['stmts' => $node->stmts]);
|
|
$this->mirrorComments($foreach, $node);
|
|
// is key included? add it to foreach
|
|
if ($listNode->items !== []) {
|
|
/** @var ArrayItem|null $keyItem */
|
|
$keyItem = \array_pop($listNode->items);
|
|
if ($keyItem !== null) {
|
|
$foreach->keyVar = $keyItem->value;
|
|
}
|
|
}
|
|
return $foreach;
|
|
}
|
|
}
|