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\Renaming\Rector\ClassConstFetch ;
2017-10-20 18:29:23 +00:00
use PhpParser\Node ;
use PhpParser\Node\Expr\ClassConstFetch ;
2018-10-31 20:43:43 +00:00
use PhpParser\Node\Identifier ;
2019-02-02 20:57:09 +00:00
use PhpParser\Node\Name\FullyQualified ;
2020-07-29 13:55:33 +00:00
use Rector\Core\Contract\Rector\ConfigurableRectorInterface ;
2020-02-06 21:48:18 +00:00
use Rector\Core\Rector\AbstractRector ;
2021-01-27 14:09:08 +00:00
use Rector\Renaming\Contract\RenameClassConstFetchInterface ;
use Rector\Renaming\ValueObject\RenameClassAndConstFetch ;
use Rector\Renaming\ValueObject\RenameClassConstFetch ;
2020-11-16 17:50:38 +00:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
2021-07-23 06:16:10 +00:00
use RectorPrefix20210723\Webmozart\Assert\Assert ;
2019-09-03 09:11:45 +00:00
/**
2021-03-12 22:20:25 +00:00
* @ see \Rector\Tests\Renaming\Rector\ClassConstFetch\RenameClassConstFetchRector\RenameClassConstFetchRectorTest
2019-09-03 09:11:45 +00:00
*/
2021-05-10 22:23:08 +00:00
final class RenameClassConstFetchRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\ConfigurableRectorInterface
2017-10-20 18:29:23 +00:00
{
2020-07-29 13:55:33 +00:00
/**
* @ var string
*/
2020-08-26 10:54:53 +00:00
public const CLASS_CONSTANT_RENAME = 'constant_rename' ;
2017-10-20 18:29:23 +00:00
/**
2021-01-27 14:09:08 +00:00
* @ var RenameClassConstFetchInterface []
2017-10-20 18:29:23 +00:00
*/
2021-01-27 14:09:08 +00:00
private $renameClassConstFetches = [];
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2018-04-08 11:51:26 +00:00
{
2021-05-10 22:23:08 +00:00
$configuration = [ self :: CLASS_CONSTANT_RENAME => [ new \Rector\Renaming\ValueObject\RenameClassConstFetch ( 'SomeClass' , 'OLD_CONSTANT' , 'NEW_CONSTANT' ), new \Rector\Renaming\ValueObject\RenameClassAndConstFetch ( 'SomeClass' , 'OTHER_OLD_CONSTANT' , 'DifferentClass' , 'NEW_CONSTANT' )]];
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'Replaces defined class constants in their calls.' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ( <<< 'CODE_SAMPLE'
2019-02-02 20:57:09 +00:00
$value = SomeClass :: OLD_CONSTANT ;
$value = SomeClass :: OTHER_OLD_CONSTANT ;
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, <<< 'CODE_SAMPLE'
2019-02-02 20:57:09 +00:00
$value = SomeClass :: NEW_CONSTANT ;
$value = DifferentClass :: NEW_CONSTANT ;
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, $configuration )]);
2018-04-08 11:51:26 +00:00
}
2018-08-14 22:12:41 +00:00
/**
2021-02-27 00:06:15 +00:00
* @ return array < class - string < Node >>
2018-08-14 22:12:41 +00:00
*/
2021-05-09 20:15:43 +00:00
public function getNodeTypes () : array
2017-10-20 18:29:23 +00:00
{
2021-05-10 22:23:08 +00:00
return [ \PhpParser\Node\Expr\ClassConstFetch :: class ];
2017-10-20 18:29:23 +00:00
}
/**
2021-07-05 22:50:18 +00:00
* @ param ClassConstFetch $node
2017-10-20 18:29:23 +00:00
*/
2021-07-05 22:50:18 +00:00
public function refactor ( \PhpParser\Node $node ) : \PhpParser\Node\Expr\ClassConstFetch
2017-10-20 18:29:23 +00:00
{
2021-03-05 10:55:40 +00:00
foreach ( $this -> renameClassConstFetches as $renameClassConstFetch ) {
2021-05-09 20:15:43 +00:00
if ( ! $this -> isObjectType ( $node -> class , $renameClassConstFetch -> getOldObjectType ())) {
2018-10-15 02:37:09 +00:00
continue ;
}
2021-05-09 20:15:43 +00:00
if ( ! $this -> isName ( $node -> name , $renameClassConstFetch -> getOldConstant ())) {
2020-08-26 10:54:53 +00:00
continue ;
}
2021-05-10 22:23:08 +00:00
if ( $renameClassConstFetch instanceof \Rector\Renaming\ValueObject\RenameClassAndConstFetch ) {
2021-03-05 10:55:40 +00:00
return $this -> createClassAndConstFetch ( $renameClassConstFetch );
2020-08-26 10:54:53 +00:00
}
2021-05-10 22:23:08 +00:00
$node -> name = new \PhpParser\Node\Identifier ( $renameClassConstFetch -> getNewConstant ());
2020-08-26 10:54:53 +00:00
return $node ;
2017-12-25 19:10:47 +00:00
}
2018-10-15 04:36:58 +00:00
return $node ;
2017-10-20 18:29:23 +00:00
}
2020-07-29 13:55:33 +00:00
/**
2021-01-27 14:09:08 +00:00
* @ param array < string , RenameClassConstFetchInterface [] > $configuration
2020-07-29 13:55:33 +00:00
*/
2021-05-09 20:15:43 +00:00
public function configure ( array $configuration ) : void
2020-07-29 13:55:33 +00:00
{
2021-01-27 14:09:08 +00:00
$renameClassConstFetches = $configuration [ self :: CLASS_CONSTANT_RENAME ] ? ? [];
2021-07-23 06:16:10 +00:00
\RectorPrefix20210723\Webmozart\Assert\Assert :: allIsInstanceOf ( $renameClassConstFetches , \Rector\Renaming\Contract\RenameClassConstFetchInterface :: class );
2021-01-27 14:09:08 +00:00
$this -> renameClassConstFetches = $renameClassConstFetches ;
2020-07-29 13:55:33 +00:00
}
2021-05-10 22:23:08 +00:00
private function createClassAndConstFetch ( \Rector\Renaming\ValueObject\RenameClassAndConstFetch $renameClassAndConstFetch ) : \PhpParser\Node\Expr\ClassConstFetch
2019-02-02 20:57:09 +00:00
{
2021-05-10 22:23:08 +00:00
return new \PhpParser\Node\Expr\ClassConstFetch ( new \PhpParser\Node\Name\FullyQualified ( $renameClassAndConstFetch -> getNewClass ()), new \PhpParser\Node\Identifier ( $renameClassAndConstFetch -> getNewConstant ()));
2019-02-02 20:57:09 +00:00
}
2017-10-20 18:29:23 +00:00
}