rector/rules/Renaming/Rector/Name/RenameClassRector.php

99 lines
3.1 KiB
PHP
Raw Normal View History

2019-10-13 05:59:52 +00:00
<?php
declare (strict_types=1);
namespace Rector\Renaming\Rector\Name;
use PhpParser\Node;
use PhpParser\Node\FunctionLike;
use PhpParser\Node\Name\FullyQualified;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Expression;
use PhpParser\Node\Stmt\If_;
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Property;
use Rector\Configuration\RenamedClassesDataCollector;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Rector\AbstractRector;
use Rector\Renaming\NodeManipulator\ClassRenamer;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix202403\Webmozart\Assert\Assert;
2019-09-03 09:11:45 +00:00
/**
* @see \Rector\Tests\Renaming\Rector\Name\RenameClassRector\RenameClassRectorTest
2019-09-03 09:11:45 +00:00
*/
final class RenameClassRector extends AbstractRector implements ConfigurableRectorInterface
2017-10-05 10:40:19 +00:00
{
/**
* @readonly
* @var \Rector\Configuration\RenamedClassesDataCollector
2019-08-30 18:21:21 +00:00
*/
private $renamedClassesDataCollector;
2017-10-05 10:40:19 +00:00
/**
* @readonly
* @var \Rector\Renaming\NodeManipulator\ClassRenamer
2017-10-05 10:40:19 +00:00
*/
private $classRenamer;
public function __construct(RenamedClassesDataCollector $renamedClassesDataCollector, ClassRenamer $classRenamer)
2020-07-29 13:55:33 +00:00
{
$this->renamedClassesDataCollector = $renamedClassesDataCollector;
$this->classRenamer = $classRenamer;
2017-10-05 10:40:19 +00:00
}
public function getRuleDefinition() : RuleDefinition
2018-04-08 11:51:26 +00:00
{
return new RuleDefinition('Replaces defined classes by new ones.', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
namespace App;
2018-10-17 10:51:28 +00:00
use SomeOldClass;
2019-03-15 19:36:58 +00:00
function someFunction(SomeOldClass $someOldClass): SomeOldClass
2018-10-17 10:51:28 +00:00
{
if ($someOldClass instanceof SomeOldClass) {
2019-12-27 17:26:20 +00:00
return new SomeOldClass;
2018-10-17 10:51:28 +00:00
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
namespace App;
2018-10-17 10:51:28 +00:00
use SomeNewClass;
2019-03-15 19:36:58 +00:00
function someFunction(SomeNewClass $someOldClass): SomeNewClass
2018-10-17 10:51:28 +00:00
{
if ($someOldClass instanceof SomeNewClass) {
return new SomeNewClass;
}
}
CODE_SAMPLE
, ['App\\SomeOldClass' => 'App\\SomeNewClass'])]);
2018-04-08 11:51:26 +00:00
}
2018-08-14 22:12:41 +00:00
/**
* @return array<class-string<Node>>
2018-08-14 22:12:41 +00:00
*/
public function getNodeTypes() : array
2017-10-06 06:34:58 +00:00
{
return [FullyQualified::class, Property::class, FunctionLike::class, Expression::class, ClassLike::class, If_::class];
2017-10-06 06:34:58 +00:00
}
2017-10-05 10:40:19 +00:00
/**
* @param FunctionLike|FullyQualified|ClassLike|Expression|Namespace_|Property|If_ $node
2017-10-05 10:40:19 +00:00
*/
public function refactor(Node $node) : ?Node
2017-10-06 06:34:58 +00:00
{
$oldToNewClasses = $this->renamedClassesDataCollector->getOldToNewClasses();
if ($oldToNewClasses !== []) {
$scope = $node->getAttribute(AttributeKey::SCOPE);
return $this->classRenamer->renameNode($node, $oldToNewClasses, $scope);
}
return null;
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration) : void
2020-07-29 13:55:33 +00:00
{
Assert::allString($configuration);
Assert::allString(\array_keys($configuration));
$this->renamedClassesDataCollector->addOldToNewClasses($configuration);
2020-07-29 13:55:33 +00:00
}
2017-10-05 10:40:19 +00:00
}