2019-10-13 05:59:52 +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\Renaming\Rector\ClassConstFetch;
|
2017-10-20 18:29:23 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Expr\ClassConstFetch;
|
|
|
|
use PhpParser\Node\Identifier;
|
|
|
|
use PhpParser\Node\Name\FullyQualified;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\Contract\Rector\ConfigurableRectorInterface;
|
|
|
|
use Rector\Rector\AbstractRector;
|
2022-06-06 17:12:56 +00:00
|
|
|
use Rector\Renaming\Contract\RenameClassConstFetchInterface;
|
|
|
|
use Rector\Renaming\ValueObject\RenameClassAndConstFetch;
|
|
|
|
use Rector\Renaming\ValueObject\RenameClassConstFetch;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2024-03-01 20:02:28 +00:00
|
|
|
use RectorPrefix202403\Webmozart\Assert\Assert;
|
2019-09-03 09:11:45 +00:00
|
|
|
/**
|
2021-03-12 22:20:25 +00:00
|
|
|
* @see \Rector\Tests\Renaming\Rector\ClassConstFetch\RenameClassConstFetchRector\RenameClassConstFetchRectorTest
|
2019-09-03 09:11:45 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class RenameClassConstFetchRector extends AbstractRector implements ConfigurableRectorInterface
|
2017-10-20 18:29:23 +00:00
|
|
|
{
|
|
|
|
/**
|
2021-01-27 14:09:08 +00:00
|
|
|
* @var RenameClassConstFetchInterface[]
|
2017-10-20 18:29:23 +00:00
|
|
|
*/
|
2021-01-27 14:09:08 +00:00
|
|
|
private $renameClassConstFetches = [];
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2018-04-08 11:51:26 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Replaces defined class constants in their calls.', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
2019-02-02 20:57:09 +00:00
|
|
|
$value = SomeClass::OLD_CONSTANT;
|
|
|
|
$value = SomeClass::OTHER_OLD_CONSTANT;
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2019-02-02 20:57:09 +00:00
|
|
|
$value = SomeClass::NEW_CONSTANT;
|
|
|
|
$value = DifferentClass::NEW_CONSTANT;
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2022-06-07 08:22:29 +00:00
|
|
|
, [new RenameClassConstFetch('SomeClass', 'OLD_CONSTANT', 'NEW_CONSTANT'), new RenameClassAndConstFetch('SomeClass', 'OTHER_OLD_CONSTANT', 'DifferentClass', 'NEW_CONSTANT')])]);
|
2018-04-08 11:51:26 +00:00
|
|
|
}
|
2018-08-14 22:12:41 +00:00
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2018-08-14 22:12:41 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2017-10-20 18:29:23 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return [ClassConstFetch::class];
|
2017-10-20 18:29:23 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param ClassConstFetch $node
|
2017-10-20 18:29:23 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function refactor(Node $node) : ?ClassConstFetch
|
2017-10-20 18:29:23 +00:00
|
|
|
{
|
2021-03-05 10:55:40 +00:00
|
|
|
foreach ($this->renameClassConstFetches as $renameClassConstFetch) {
|
2023-03-22 14:20:22 +00:00
|
|
|
if (!$this->isName($node->name, $renameClassConstFetch->getOldConstant())) {
|
2018-10-15 02:37:09 +00:00
|
|
|
continue;
|
|
|
|
}
|
2023-03-22 14:20:22 +00:00
|
|
|
if (!$this->isObjectType($node->class, $renameClassConstFetch->getOldObjectType())) {
|
2020-08-26 10:54:53 +00:00
|
|
|
continue;
|
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
if ($renameClassConstFetch instanceof RenameClassAndConstFetch) {
|
2021-03-05 10:55:40 +00:00
|
|
|
return $this->createClassAndConstFetch($renameClassConstFetch);
|
2020-08-26 10:54:53 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
$node->name = new Identifier($renameClassConstFetch->getNewConstant());
|
2020-08-26 10:54:53 +00:00
|
|
|
return $node;
|
2017-12-25 19:10:47 +00:00
|
|
|
}
|
2021-07-23 12:47:55 +00:00
|
|
|
return null;
|
2017-10-20 18:29:23 +00:00
|
|
|
}
|
2020-07-29 13:55:33 +00:00
|
|
|
/**
|
2021-11-28 17:01:20 +00:00
|
|
|
* @param mixed[] $configuration
|
2020-07-29 13:55:33 +00:00
|
|
|
*/
|
2021-12-10 10:22:23 +00:00
|
|
|
public function configure(array $configuration) : void
|
2020-07-29 13:55:33 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
Assert::allIsAOf($configuration, RenameClassConstFetchInterface::class);
|
2022-02-18 01:46:17 +00:00
|
|
|
$this->renameClassConstFetches = $configuration;
|
2020-07-29 13:55:33 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
private function createClassAndConstFetch(RenameClassAndConstFetch $renameClassAndConstFetch) : ClassConstFetch
|
2019-02-02 20:57:09 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new ClassConstFetch(new FullyQualified($renameClassAndConstFetch->getNewClass()), new Identifier($renameClassAndConstFetch->getNewConstant()));
|
2019-02-02 20:57:09 +00:00
|
|
|
}
|
2017-10-20 18:29:23 +00:00
|
|
|
}
|