2019-10-13 05:59:52 +00:00
< ? php
2021-05-09 20:15:43 +00:00
declare ( strict_types = 1 );
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 ;
2021-09-24 14:11:08 +00:00
use Rector\Core\ValueObject\PhpVersionFeature ;
use Rector\VersionBonding\Contract\MinPhpVersionInterface ;
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
/**
2021-04-19 16:15:52 +00:00
* @ changelog https :// wiki . php . net / rfc / deprecations_php_7_2 #each
2020-05-03 14:07:56 +00:00
*
2021-03-12 22:20:25 +00:00
* @ see \Rector\Tests\Php72\Rector\While_\WhileEachToForeachRector\WhileEachToForeachRectorTest
2018-10-03 13:14:08 +00:00
*/
2021-09-24 14:11:08 +00:00
final class WhileEachToForeachRector extends \Rector\Core\Rector\AbstractRector implements \Rector\VersionBonding\Contract\MinPhpVersionInterface
2018-10-03 13:14:08 +00:00
{
2019-08-18 12:15:39 +00:00
/**
2021-05-10 23:39:21 +00:00
* @ var \Rector\Core\NodeManipulator\AssignManipulator
2019-08-18 12:15:39 +00:00
*/
private $assignManipulator ;
2021-05-10 22:23:08 +00:00
public function __construct ( \Rector\Core\NodeManipulator\AssignManipulator $assignManipulator )
2019-08-18 12:15:39 +00:00
{
$this -> assignManipulator = $assignManipulator ;
}
2021-09-24 14:11:08 +00:00
public function provideMinPhpVersion () : int
{
return \Rector\Core\ValueObject\PhpVersionFeature :: DEPRECATE_EACH ;
}
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2018-10-03 13:14:08 +00:00
{
2021-05-10 22:23:08 +00:00
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'each() function is deprecated, use foreach() instead.' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample ( <<< '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
2021-05-09 20:15:43 +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
2021-05-10 22:23:08 +00:00
), new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample ( <<< '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
2021-05-09 20:15:43 +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
2021-05-09 20:15:43 +00:00
)]);
2018-10-03 13:14:08 +00:00
}
/**
2021-02-27 00:06:15 +00:00
* @ return array < class - string < Node >>
2018-10-03 13:14:08 +00:00
*/
2021-05-09 20:15:43 +00:00
public function getNodeTypes () : array
2018-10-03 13:14:08 +00:00
{
2021-05-10 22:23:08 +00:00
return [ \PhpParser\Node\Stmt\While_ :: class ];
2018-10-03 13:14:08 +00:00
}
/**
2021-07-05 22:50:18 +00:00
* @ param While_ $node
2018-10-03 13:14:08 +00:00
*/
2021-07-05 22:50:18 +00:00
public function refactor ( \PhpParser\Node $node ) : ? \PhpParser\Node
2018-10-03 13:14:08 +00:00
{
2021-05-10 22:23:08 +00:00
if ( ! $node -> cond instanceof \PhpParser\Node\Expr\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 ;
2021-05-09 20:15:43 +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-05-09 20:15:43 +00:00
$foreachedExpr = \count ( $listNode -> items ) === 1 ? $this -> nodeFactory -> createFuncCall ( 'array_keys' , [ $eachFuncCall -> args [ 0 ]]) : $eachFuncCall -> args [ 0 ] -> value ;
2020-07-19 18:52:42 +00:00
/** @var ArrayItem $arrayItem */
2021-05-09 20:15:43 +00:00
$arrayItem = \array_pop ( $listNode -> items );
2021-05-10 22:23:08 +00:00
$foreach = new \PhpParser\Node\Stmt\Foreach_ ( $foreachedExpr , $arrayItem , [ 'stmts' => $node -> stmts ]);
2020-12-20 12:56:43 +00:00
$this -> mirrorComments ( $foreach , $node );
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 */
2021-05-09 20:15:43 +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
}
}