2020-06-29 18:36:58 +00:00
< ? php
2021-05-09 20:15:43 +00:00
declare ( strict_types = 1 );
2022-06-06 17:12:56 +00:00
namespace Rector\CodingStyle\Rector\String_ ;
2020-06-29 18:36:58 +00:00
2024-03-01 20:02:28 +00:00
use RectorPrefix202403\Nette\Utils\Strings ;
2022-06-06 17:12:56 +00:00
use PhpParser\Node ;
use PhpParser\Node\Expr\ClassConstFetch ;
use PhpParser\Node\Name\FullyQualified ;
use PhpParser\Node\Scalar\String_ ;
use PHPStan\Reflection\ReflectionProvider ;
2022-12-02 14:15:07 +00:00
use Rector\NodeTypeResolver\Node\AttributeKey ;
2024-01-02 02:40:38 +00:00
use Rector\Rector\AbstractRector ;
2022-06-07 09:18:30 +00:00
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample ;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition ;
2020-06-29 18:36:58 +00:00
/**
2021-03-12 22:20:25 +00:00
* @ see \Rector\Tests\CodingStyle\Rector\String_\UseClassKeywordForClassNameResolutionRector\UseClassKeywordForClassNameResolutionRectorTest
2020-06-29 18:36:58 +00:00
*/
2022-06-07 08:22:29 +00:00
final class UseClassKeywordForClassNameResolutionRector extends AbstractRector
2020-06-29 18:36:58 +00:00
{
2021-02-28 07:47:48 +00:00
/**
2023-06-11 23:01:39 +00:00
* @ readonly
2021-08-23 00:20:32 +00:00
* @ var \PHPStan\Reflection\ReflectionProvider
2021-02-28 07:47:48 +00:00
*/
private $reflectionProvider ;
2023-06-08 22:00:17 +00:00
/**
* @ var string
* @ see https :// regex101 . com / r / Vv41Qr / 1 /
*/
private const CLASS_BEFORE_STATIC_ACCESS_REGEX = '#(?<class_name>[\\\\a-zA-Z0-9_\\x80-\\xff]*)::#' ;
2022-06-07 08:22:29 +00:00
public function __construct ( ReflectionProvider $reflectionProvider )
2021-02-28 07:47:48 +00:00
{
$this -> reflectionProvider = $reflectionProvider ;
}
2022-06-07 08:22:29 +00:00
public function getRuleDefinition () : RuleDefinition
2020-06-29 18:36:58 +00:00
{
2022-06-07 08:22:29 +00:00
return new RuleDefinition ( 'Use `class` keyword for class name resolution in string instead of hardcoded string reference' , [ new CodeSample ( <<< 'CODE_SAMPLE'
2020-06-29 18:36:58 +00:00
$value = 'App\SomeClass::someMethod()' ;
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
, <<< 'CODE_SAMPLE'
2021-11-24 19:57:13 +00:00
$value = \App\SomeClass :: class . '::someMethod()' ;
2020-09-15 08:23:13 +00:00
CODE_SAMPLE
2021-05-09 20:15:43 +00:00
)]);
2020-06-29 18:36:58 +00:00
}
/**
2021-02-27 00:06:15 +00:00
* @ return array < class - string < Node >>
2020-06-29 18:36:58 +00:00
*/
2021-05-09 20:15:43 +00:00
public function getNodeTypes () : array
2020-06-29 18:36:58 +00:00
{
2022-06-07 08:22:29 +00:00
return [ String_ :: class ];
2020-06-29 18:36:58 +00:00
}
/**
2021-12-10 10:22:23 +00:00
* @ param String_ $node
2020-06-29 18:36:58 +00:00
*/
2022-06-07 08:22:29 +00:00
public function refactor ( Node $node ) : ? Node
2020-06-29 18:36:58 +00:00
{
2022-12-02 14:15:07 +00:00
$stringKind = $node -> getAttribute ( AttributeKey :: KIND );
if ( \in_array ( $stringKind , [ String_ :: KIND_HEREDOC , String_ :: KIND_NOWDOC ], \true )) {
return null ;
}
2020-07-04 16:01:55 +00:00
$classNames = $this -> getExistingClasses ( $node );
2022-12-05 11:03:13 +00:00
$classNames = $this -> filterOurShortClasses ( $classNames );
2020-07-04 14:53:40 +00:00
if ( $classNames === []) {
2022-12-05 11:03:13 +00:00
return null ;
2020-06-29 18:36:58 +00:00
}
2020-07-04 14:53:40 +00:00
$parts = $this -> getParts ( $node , $classNames );
2020-07-04 16:01:55 +00:00
if ( $parts === []) {
return null ;
2020-06-29 18:36:58 +00:00
}
2020-07-04 16:01:55 +00:00
$exprsToConcat = $this -> createExpressionsToConcat ( $parts );
2021-01-30 21:41:25 +00:00
return $this -> nodeFactory -> createConcat ( $exprsToConcat );
2020-06-29 18:36:58 +00:00
}
2022-12-23 17:10:25 +00:00
/**
* @ param string [] $classNames
* @ return mixed []
*/
private function getParts ( String_ $string , array $classNames ) : array
{
$quotedClassNames = \array_map ( 'preg_quote' , $classNames );
// @see https://regex101.com/r/8nGS0F/1
$parts = Strings :: split ( $string -> value , '#(' . \implode ( '|' , $quotedClassNames ) . ')#' );
return \array_filter ( $parts , static function ( string $className ) : bool {
return $className !== '' ;
});
}
2020-07-04 16:01:55 +00:00
/**
2020-10-11 14:17:43 +00:00
* @ return string []
2020-07-04 16:01:55 +00:00
*/
2022-12-23 17:10:25 +00:00
private function getExistingClasses ( String_ $string ) : array
2020-07-04 14:53:40 +00:00
{
2020-10-11 14:17:43 +00:00
/** @var mixed[] $matches */
2022-06-07 08:22:29 +00:00
$matches = Strings :: matchAll ( $string -> value , self :: CLASS_BEFORE_STATIC_ACCESS_REGEX , \PREG_PATTERN_ORDER );
2021-05-09 20:15:43 +00:00
if ( ! isset ( $matches [ 'class_name' ])) {
2020-10-11 14:17:43 +00:00
return [];
}
$classNames = [];
foreach ( $matches [ 'class_name' ] as $matchedClassName ) {
2021-05-09 20:15:43 +00:00
if ( ! $this -> reflectionProvider -> hasClass ( $matchedClassName )) {
2020-10-11 14:17:43 +00:00
continue ;
}
$classNames [] = $matchedClassName ;
}
return $classNames ;
2020-07-04 14:53:40 +00:00
}
2020-07-04 16:01:55 +00:00
/**
* @ param string [] $parts
2020-08-29 09:03:40 +00:00
* @ return ClassConstFetch [] | String_ []
2020-07-04 16:01:55 +00:00
*/
2021-05-09 20:15:43 +00:00
private function createExpressionsToConcat ( array $parts ) : array
2020-07-04 16:01:55 +00:00
{
$exprsToConcat = [];
foreach ( $parts as $part ) {
2021-02-28 07:47:48 +00:00
if ( $this -> reflectionProvider -> hasClass ( $part )) {
2022-06-07 08:22:29 +00:00
$exprsToConcat [] = new ClassConstFetch ( new FullyQualified ( \ltrim ( $part , '\\' )), 'class' );
2020-07-04 16:01:55 +00:00
} else {
2022-06-07 08:22:29 +00:00
$exprsToConcat [] = new String_ ( $part );
2020-07-04 16:01:55 +00:00
}
}
return $exprsToConcat ;
}
2022-12-05 11:03:13 +00:00
/**
* @ param string [] $classNames
* @ return string []
*/
private function filterOurShortClasses ( array $classNames ) : array
{
return \array_filter ( $classNames , static function ( string $className ) : bool {
return \strpos ( $className , '\\' ) !== \false ;
});
}
2020-06-29 18:36:58 +00:00
}