2020-01-04 12:51:09 +00:00
< ? php
2021-05-09 20:15:43 +00:00
declare ( strict_types = 1 );
2020-01-04 12:51:09 +00:00
namespace Rector\CodeQuality\Rector\For_ ;
use PhpParser\Node ;
use PhpParser\Node\Expr\Assign ;
use PhpParser\Node\Expr\FuncCall ;
use PhpParser\Node\Expr\Variable ;
use PhpParser\Node\Stmt\For_ ;
2020-02-06 21:48:18 +00:00
use Rector\Core\Rector\AbstractRector ;
2021-06-10 10:46:24 +00:00
use Rector\Naming\Naming\VariableNaming ;
2020-01-04 14:30:53 +00:00
use Rector\NodeTypeResolver\Node\AttributeKey ;
2020-11-16 17:50:38 +00:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
2020-01-04 12:51:09 +00:00
/**
2021-03-12 22:20:25 +00:00
* @ see \Rector\Tests\CodeQuality\Rector\For_\ForRepeatedCountToOwnVariableRector\ForRepeatedCountToOwnVariableRectorTest
2020-01-04 12:51:09 +00:00
*/
2021-05-10 22:23:08 +00:00
final class ForRepeatedCountToOwnVariableRector extends \Rector\Core\Rector\AbstractRector
2020-01-04 12:51:09 +00:00
{
/**
2021-12-04 12:47:17 +00:00
* @ readonly
2021-06-10 10:46:24 +00:00
* @ var \Rector\Naming\Naming\VariableNaming
2020-01-04 12:51:09 +00:00
*/
2020-08-22 13:02:55 +00:00
private $variableNaming ;
2021-06-10 10:46:24 +00:00
public function __construct ( \Rector\Naming\Naming\VariableNaming $variableNaming )
2020-08-22 13:02:55 +00:00
{
$this -> variableNaming = $variableNaming ;
}
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2020-01-04 12:51:09 +00:00
{
2021-05-10 22:23:08 +00:00
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'Change count() in for function to own variable' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample ( <<< 'CODE_SAMPLE'
2020-01-04 12:51:09 +00:00
class SomeClass
{
public function run ( $items )
{
for ( $i = 5 ; $i <= count ( $items ); $i ++ ) {
echo $items [ $i ];
}
}
}
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, <<< 'CODE_SAMPLE'
2020-01-04 12:51:09 +00:00
class SomeClass
{
public function run ( $items )
{
$itemsCount = count ( $items );
for ( $i = 5 ; $i <= $itemsCount ; $i ++ ) {
echo $items [ $i ];
}
}
}
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
)]);
2020-01-04 12:51:09 +00:00
}
/**
2021-02-27 00:06:15 +00:00
* @ return array < class - string < Node >>
2020-01-04 12:51:09 +00:00
*/
2021-05-09 20:15:43 +00:00
public function getNodeTypes () : array
2020-01-04 12:51:09 +00:00
{
2021-05-10 22:23:08 +00:00
return [ \PhpParser\Node\Stmt\For_ :: class ];
2020-01-04 12:51:09 +00:00
}
/**
2021-12-10 10:22:23 +00:00
* @ param For_ $node
2020-01-04 12:51:09 +00:00
*/
2021-12-10 10:22:23 +00:00
public function refactor ( \PhpParser\Node $node ) : ? \PhpParser\Node
2020-01-04 12:51:09 +00:00
{
$countInCond = null ;
2020-08-22 13:02:55 +00:00
$variableName = null ;
2021-05-10 22:23:08 +00:00
$forScope = $node -> getAttribute ( \Rector\NodeTypeResolver\Node\AttributeKey :: SCOPE );
$this -> traverseNodesWithCallable ( $node -> cond , function ( \PhpParser\Node $node ) use ( & $countInCond , & $variableName , $forScope ) : ? Variable {
if ( ! $node instanceof \PhpParser\Node\Expr\FuncCall ) {
2020-01-04 12:51:09 +00:00
return null ;
}
2021-05-09 20:15:43 +00:00
if ( ! $this -> isName ( $node , 'count' )) {
2020-01-04 12:51:09 +00:00
return null ;
}
$countInCond = $node ;
2021-05-09 20:15:43 +00:00
$variableName = $this -> variableNaming -> resolveFromFuncCallFirstArgumentWithSuffix ( $node , 'Count' , 'itemsCount' , $forScope );
2021-05-10 22:23:08 +00:00
return new \PhpParser\Node\Expr\Variable ( $variableName );
2020-01-04 12:51:09 +00:00
});
2020-12-24 16:28:56 +00:00
if ( $countInCond === null ) {
return null ;
}
if ( $variableName === null ) {
2020-01-04 12:51:09 +00:00
return null ;
}
2021-05-10 22:23:08 +00:00
$countAssign = new \PhpParser\Node\Expr\Assign ( new \PhpParser\Node\Expr\Variable ( $variableName ), $countInCond );
2021-09-02 06:46:57 +00:00
$this -> nodesToAddCollector -> addNodeBeforeNode ( $countAssign , $node );
2020-01-04 12:51:09 +00:00
return $node ;
}
}