rector/rules/Renaming/Rector/ConstFetch/RenameConstantRector.php

82 lines
2.2 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Renaming\Rector\ConstFetch;
use PhpParser\Node;
use PhpParser\Node\Expr\ConstFetch;
use PhpParser\Node\Name;
use Rector\Contract\Rector\ConfigurableRectorInterface;
use Rector\Rector\AbstractRector;
use Rector\Validation\RectorAssert;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix202403\Webmozart\Assert\Assert;
/**
* @see \Rector\Tests\Renaming\Rector\ConstFetch\RenameConstantRector\RenameConstantRectorTest
*/
final class RenameConstantRector extends AbstractRector implements ConfigurableRectorInterface
{
/**
* @var array<string, string>
*/
private $oldToNewConstants = [];
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Replace constant by new ones', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
final class SomeClass
{
public function run()
{
return MYSQL_ASSOC;
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
final class SomeClass
{
public function run()
{
return MYSQLI_ASSOC;
}
}
CODE_SAMPLE
, ['MYSQL_ASSOC' => 'MYSQLI_ASSOC', 'OLD_CONSTANT' => 'NEW_CONSTANT'])]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [ConstFetch::class];
}
/**
* @param ConstFetch $node
*/
public function refactor(Node $node) : ?Node
{
foreach ($this->oldToNewConstants as $oldConstant => $newConstant) {
if (!$this->isName($node->name, $oldConstant)) {
continue;
}
$node->name = new Name($newConstant);
return $node;
}
return null;
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration) : void
{
Assert::allString(\array_keys($configuration));
Assert::allString($configuration);
foreach ($configuration as $oldConstant => $newConstant) {
RectorAssert::constantName($oldConstant);
RectorAssert::constantName($newConstant);
}
/** @var array<string, string> $configuration */
$this->oldToNewConstants = $configuration;
}
}