mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-27 21:23:31 +00:00
142 lines
4.9 KiB
PHP
142 lines
4.9 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Php55\Rector\String_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Arg;
|
|
use PhpParser\Node\Expr\ClassConstFetch;
|
|
use PhpParser\Node\Expr\FuncCall;
|
|
use PhpParser\Node\Name\FullyQualified;
|
|
use PhpParser\Node\Scalar\String_;
|
|
use PhpParser\Node\Stmt\ClassConst;
|
|
use Rector\Core\Contract\Rector\AllowEmptyConfigurableRectorInterface;
|
|
use Rector\Core\Rector\AbstractRector;
|
|
use Rector\Core\ValueObject\PhpVersionFeature;
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
|
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
|
|
use RectorPrefix20220425\Symplify\PackageBuilder\Reflection\ClassLikeExistenceChecker;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
use RectorPrefix20220425\Webmozart\Assert\Assert;
|
|
/**
|
|
* @changelog https://wiki.php.net/rfc/class_name_scalars https://github.com/symfony/symfony/blob/2.8/UPGRADE-2.8.md#form
|
|
*
|
|
* @see \Rector\Tests\Php55\Rector\String_\StringClassNameToClassConstantRector\StringClassNameToClassConstantRectorTest
|
|
*/
|
|
final class StringClassNameToClassConstantRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\AllowEmptyConfigurableRectorInterface, \Rector\VersionBonding\Contract\MinPhpVersionInterface
|
|
{
|
|
/**
|
|
* @var string[]
|
|
*/
|
|
private $classesToSkip = [
|
|
// can be string
|
|
'Error',
|
|
'Exception',
|
|
];
|
|
/**
|
|
* @readonly
|
|
* @var \Symplify\PackageBuilder\Reflection\ClassLikeExistenceChecker
|
|
*/
|
|
private $classLikeExistenceChecker;
|
|
public function __construct(\RectorPrefix20220425\Symplify\PackageBuilder\Reflection\ClassLikeExistenceChecker $classLikeExistenceChecker)
|
|
{
|
|
$this->classLikeExistenceChecker = $classLikeExistenceChecker;
|
|
}
|
|
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
|
|
{
|
|
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Replace string class names by <class>::class constant', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
|
class AnotherClass
|
|
{
|
|
}
|
|
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
return 'AnotherClass';
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class AnotherClass
|
|
{
|
|
}
|
|
|
|
class SomeClass
|
|
{
|
|
public function run()
|
|
{
|
|
return \AnotherClass::class;
|
|
}
|
|
}
|
|
CODE_SAMPLE
|
|
, ['ClassName', 'AnotherClassName'])]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [\PhpParser\Node\Scalar\String_::class];
|
|
}
|
|
/**
|
|
* @param String_ $node
|
|
*/
|
|
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
|
|
{
|
|
$classLikeName = $node->value;
|
|
// remove leading slash
|
|
$classLikeName = \ltrim($classLikeName, '\\');
|
|
if ($classLikeName === '') {
|
|
return null;
|
|
}
|
|
if ($this->shouldSkip($classLikeName, $node)) {
|
|
return null;
|
|
}
|
|
$fullyQualified = new \PhpParser\Node\Name\FullyQualified($classLikeName);
|
|
return new \PhpParser\Node\Expr\ClassConstFetch($fullyQualified, 'class');
|
|
}
|
|
/**
|
|
* @param mixed[] $configuration
|
|
*/
|
|
public function configure(array $configuration) : void
|
|
{
|
|
\RectorPrefix20220425\Webmozart\Assert\Assert::allString($configuration);
|
|
$this->classesToSkip = $configuration;
|
|
}
|
|
public function provideMinPhpVersion() : int
|
|
{
|
|
return \Rector\Core\ValueObject\PhpVersionFeature::CLASSNAME_CONSTANT;
|
|
}
|
|
private function isPartOfIsAFuncCall(\PhpParser\Node\Scalar\String_ $string) : bool
|
|
{
|
|
$parent = $string->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::PARENT_NODE);
|
|
if (!$parent instanceof \PhpParser\Node\Arg) {
|
|
return \false;
|
|
}
|
|
$parentParent = $parent->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::PARENT_NODE);
|
|
if (!$parentParent instanceof \PhpParser\Node\Expr\FuncCall) {
|
|
return \false;
|
|
}
|
|
return $this->nodeNameResolver->isName($parentParent, 'is_a');
|
|
}
|
|
private function shouldSkip(string $classLikeName, \PhpParser\Node\Scalar\String_ $string) : bool
|
|
{
|
|
if (!$this->classLikeExistenceChecker->doesClassLikeInsensitiveExists($classLikeName)) {
|
|
return \true;
|
|
}
|
|
foreach ($this->classesToSkip as $classToSkip) {
|
|
if ($this->nodeNameResolver->isStringName($classLikeName, $classToSkip)) {
|
|
return \true;
|
|
}
|
|
}
|
|
if ($this->isPartOfIsAFuncCall($string)) {
|
|
return \true;
|
|
}
|
|
// allow class strings to be part of class const arrays, as probably on purpose
|
|
$parentClassConst = $this->betterNodeFinder->findParentType($string, \PhpParser\Node\Stmt\ClassConst::class);
|
|
return $parentClassConst instanceof \PhpParser\Node\Stmt\ClassConst;
|
|
}
|
|
}
|