2019-10-13 05:59:52 +00:00
< ? php
2021-05-09 20:15:43 +00:00
declare ( strict_types = 1 );
2019-09-22 18:57:03 +00:00
namespace Rector\Php55\Rector\String_ ;
2019-05-23 17:08:44 +00:00
use PhpParser\Node ;
2021-02-11 17:24:08 +00:00
use PhpParser\Node\Arg ;
2019-05-25 16:36:53 +00:00
use PhpParser\Node\Expr\ClassConstFetch ;
2021-03-19 23:11:36 +00:00
use PhpParser\Node\Expr\FuncCall ;
2019-05-25 16:36:53 +00:00
use PhpParser\Node\Name\FullyQualified ;
2019-05-23 17:08:44 +00:00
use PhpParser\Node\Scalar\String_ ;
2021-02-20 20:53:11 +00:00
use PhpParser\Node\Stmt\ClassConst ;
2021-12-10 07:56:16 +00:00
use Rector\Core\Contract\Rector\AllowEmptyConfigurableRectorInterface ;
2020-02-06 21:48:18 +00:00
use Rector\Core\Rector\AbstractRector ;
use Rector\Core\ValueObject\PhpVersionFeature ;
2020-05-13 07:57:21 +00:00
use Rector\NodeTypeResolver\Node\AttributeKey ;
2021-07-21 09:35:57 +00:00
use Rector\VersionBonding\Contract\MinPhpVersionInterface ;
2022-01-25 00:12:31 +00:00
use RectorPrefix20220125\Symplify\PackageBuilder\Reflection\ClassLikeExistenceChecker ;
2020-11-16 17:50:38 +00:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
2022-01-25 00:12:31 +00:00
use RectorPrefix20220125\Webmozart\Assert\Assert ;
2019-05-23 17:08:44 +00:00
/**
2021-04-10 18:47:17 +00:00
* @ changelog https :// wiki . php . net / rfc / class_name_scalars https :// github . com / symfony / symfony / blob / 2.8 / UPGRADE - 2.8 . md #form
2020-05-03 19:30:01 +00:00
*
2021-03-12 22:20:25 +00:00
* @ see \Rector\Tests\Php55\Rector\String_\StringClassNameToClassConstantRector\StringClassNameToClassConstantRectorTest
2019-05-23 17:08:44 +00:00
*/
2021-12-10 07:56:16 +00:00
final class StringClassNameToClassConstantRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\AllowEmptyConfigurableRectorInterface , \Rector\VersionBonding\Contract\MinPhpVersionInterface
2019-05-23 17:08:44 +00:00
{
/**
2020-07-29 23:39:41 +00:00
* @ api
2021-12-10 08:45:03 +00:00
* @ deprecated
2020-07-29 23:39:41 +00:00
* @ var string
2019-05-23 17:08:44 +00:00
*/
2021-02-20 20:53:11 +00:00
public const CLASSES_TO_SKIP = 'classes_to_skip' ;
2019-06-05 06:40:03 +00:00
/**
* @ var string []
*/
2020-07-29 23:39:41 +00:00
private $classesToSkip = [
// can be string
'Error' ,
'Exception' ,
];
2021-02-20 20:53:11 +00:00
/**
2021-12-04 12:47:17 +00:00
* @ readonly
2021-08-23 00:20:32 +00:00
* @ var \Symplify\PackageBuilder\Reflection\ClassLikeExistenceChecker
2021-02-20 20:53:11 +00:00
*/
private $classLikeExistenceChecker ;
2022-01-25 00:12:31 +00:00
public function __construct ( \RectorPrefix20220125\Symplify\PackageBuilder\Reflection\ClassLikeExistenceChecker $classLikeExistenceChecker )
2021-02-20 20:53:11 +00:00
{
$this -> classLikeExistenceChecker = $classLikeExistenceChecker ;
}
2021-05-10 22:23:08 +00:00
public function getRuleDefinition () : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2019-05-23 17:08:44 +00:00
{
2021-05-10 22:23:08 +00:00
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition ( 'Replace string class names by <class>::class constant' , [ new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample ( <<< 'CODE_SAMPLE'
2019-05-23 17:08:44 +00:00
class AnotherClass
{
}
class SomeClass
{
public function run ()
{
return 'AnotherClass' ;
}
}
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, <<< 'CODE_SAMPLE'
2019-05-23 17:08:44 +00:00
class AnotherClass
{
}
class SomeClass
{
public function run ()
{
return \AnotherClass :: class ;
}
}
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-12-06 21:12:03 +00:00
, [ 'ClassName' , 'AnotherClassName' ])]);
2019-05-23 17:08:44 +00:00
}
/**
2021-02-27 00:06:15 +00:00
* @ return array < class - string < Node >>
2019-05-23 17:08:44 +00:00
*/
2021-05-09 20:15:43 +00:00
public function getNodeTypes () : array
2019-05-23 17:08:44 +00:00
{
2021-05-10 22:23:08 +00:00
return [ \PhpParser\Node\Scalar\String_ :: class ];
2019-05-23 17:08:44 +00:00
}
/**
2021-12-10 10:22:23 +00:00
* @ param String_ $node
2019-05-23 17:08:44 +00:00
*/
2021-12-10 10:22:23 +00:00
public function refactor ( \PhpParser\Node $node ) : ? \PhpParser\Node
2019-05-23 17:08:44 +00:00
{
$classLikeName = $node -> value ;
2019-06-10 15:52:59 +00:00
// remove leading slash
2021-05-09 20:15:43 +00:00
$classLikeName = \ltrim ( $classLikeName , '\\' );
2019-06-10 15:52:59 +00:00
if ( $classLikeName === '' ) {
2019-06-10 15:49:44 +00:00
return null ;
}
2021-02-20 20:53:11 +00:00
if ( $this -> shouldSkip ( $classLikeName , $node )) {
2021-02-11 17:24:08 +00:00
return null ;
}
2021-05-10 22:23:08 +00:00
$fullyQualified = new \PhpParser\Node\Name\FullyQualified ( $classLikeName );
return new \PhpParser\Node\Expr\ClassConstFetch ( $fullyQualified , 'class' );
2019-05-23 17:08:44 +00:00
}
2021-02-20 20:53:11 +00:00
/**
2021-11-28 17:01:20 +00:00
* @ param mixed [] $configuration
2021-02-20 20:53:11 +00:00
*/
2021-12-10 10:22:23 +00:00
public function configure ( array $configuration ) : void
2020-07-29 23:39:41 +00:00
{
2021-11-28 17:01:20 +00:00
$classesToSkip = $configuration [ self :: CLASSES_TO_SKIP ] ? ? $configuration ;
2022-01-25 00:12:31 +00:00
\RectorPrefix20220125\Webmozart\Assert\Assert :: isArray ( $classesToSkip );
\RectorPrefix20220125\Webmozart\Assert\Assert :: allString ( $classesToSkip );
2021-10-29 12:16:51 +00:00
$this -> classesToSkip = $classesToSkip ;
2020-07-29 23:39:41 +00:00
}
2021-07-21 09:35:57 +00:00
public function provideMinPhpVersion () : int
{
return \Rector\Core\ValueObject\PhpVersionFeature :: CLASSNAME_CONSTANT ;
}
2021-05-10 22:23:08 +00:00
private function isPartOfIsAFuncCall ( \PhpParser\Node\Scalar\String_ $string ) : bool
2021-02-11 17:24:08 +00:00
{
2021-05-10 22:23:08 +00:00
$parent = $string -> getAttribute ( \Rector\NodeTypeResolver\Node\AttributeKey :: PARENT_NODE );
if ( ! $parent instanceof \PhpParser\Node\Arg ) {
2021-05-09 20:15:43 +00:00
return \false ;
2021-02-11 17:24:08 +00:00
}
2021-05-10 22:23:08 +00:00
$parentParent = $parent -> getAttribute ( \Rector\NodeTypeResolver\Node\AttributeKey :: PARENT_NODE );
if ( ! $parentParent instanceof \PhpParser\Node\Expr\FuncCall ) {
2021-05-09 20:15:43 +00:00
return \false ;
2021-02-11 17:24:08 +00:00
}
2021-03-19 23:11:36 +00:00
return $this -> nodeNameResolver -> isName ( $parentParent , 'is_a' );
2021-02-11 17:24:08 +00:00
}
2021-07-05 22:50:18 +00:00
private function shouldSkip ( string $classLikeName , \PhpParser\Node\Scalar\String_ $string ) : bool
2021-02-20 20:53:11 +00:00
{
2021-05-09 20:15:43 +00:00
if ( ! $this -> classLikeExistenceChecker -> doesClassLikeInsensitiveExists ( $classLikeName )) {
return \true ;
2021-02-20 20:53:11 +00:00
}
2021-10-29 12:16:51 +00:00
foreach ( $this -> classesToSkip as $classToSkip ) {
if ( $this -> nodeNameResolver -> isStringName ( $classLikeName , $classToSkip )) {
return \true ;
}
2021-02-20 20:53:11 +00:00
}
if ( $this -> isPartOfIsAFuncCall ( $string )) {
2021-05-09 20:15:43 +00:00
return \true ;
2021-02-20 20:53:11 +00:00
}
// allow class strings to be part of class const arrays, as probably on purpose
2021-05-10 22:23:08 +00:00
$parentClassConst = $this -> betterNodeFinder -> findParentType ( $string , \PhpParser\Node\Stmt\ClassConst :: class );
return $parentClassConst instanceof \PhpParser\Node\Stmt\ClassConst ;
2021-02-20 20:53:11 +00:00
}
2019-05-23 17:08:44 +00:00
}