rector/rules/Transform/Rector/String_/StringToClassConstantRector.php

74 lines
2.5 KiB
PHP
Raw Normal View History

2019-10-13 05:59:52 +00:00
<?php
declare (strict_types=1);
namespace Rector\Transform\Rector\String_;
2019-02-09 23:12:10 +00:00
use PhpParser\Node;
use PhpParser\Node\Scalar\String_;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use Rector\Transform\ValueObject\StringToClassConstant;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
use RectorPrefix20220607\Webmozart\Assert\Assert;
2019-09-03 09:11:45 +00:00
/**
* @see \Rector\Tests\Transform\Rector\String_\StringToClassConstantRector\StringToClassConstantRectorTest
2019-09-03 09:11:45 +00:00
*/
final class StringToClassConstantRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\ConfigurableRectorInterface
2019-02-09 23:12:10 +00:00
{
/**
* @var StringToClassConstant[]
2019-02-09 23:12:10 +00:00
*/
2020-07-29 23:39:41 +00:00
private $stringsToClassConstants = [];
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
2019-02-09 23:12:10 +00:00
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Changes strings to specific constants', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample(<<<'CODE_SAMPLE'
2019-02-09 23:12:10 +00:00
final class SomeSubscriber
{
public static function getSubscribedEvents()
{
return ['compiler.post_dump' => 'compile'];
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
2019-02-09 23:12:10 +00:00
final class SomeSubscriber
{
public static function getSubscribedEvents()
{
return [\Yet\AnotherClass::CONSTANT => 'compile'];
}
}
CODE_SAMPLE
, [new \Rector\Transform\ValueObject\StringToClassConstant('compiler.post_dump', 'Yet\\AnotherClass', 'CONSTANT')])]);
2019-02-09 23:12:10 +00:00
}
/**
* @return array<class-string<Node>>
2019-02-09 23:12:10 +00:00
*/
public function getNodeTypes() : array
2019-02-09 23:12:10 +00:00
{
return [\PhpParser\Node\Scalar\String_::class];
2019-02-09 23:12:10 +00:00
}
/**
* @param String_ $node
2019-02-09 23:12:10 +00:00
*/
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
2019-02-09 23:12:10 +00:00
{
foreach ($this->stringsToClassConstants as $stringToClassConstant) {
if (!$this->valueResolver->isValue($node, $stringToClassConstant->getString())) {
2019-02-09 23:12:10 +00:00
continue;
}
return $this->nodeFactory->createClassConstFetch($stringToClassConstant->getClass(), $stringToClassConstant->getConstant());
2019-02-09 23:12:10 +00:00
}
return $node;
}
/**
* @param mixed[] $configuration
*/
public function configure(array $configuration) : void
2020-07-29 23:39:41 +00:00
{
\RectorPrefix20220607\Webmozart\Assert\Assert::allIsAOf($configuration, \Rector\Transform\ValueObject\StringToClassConstant::class);
$this->stringsToClassConstants = $configuration;
2020-07-29 23:39:41 +00:00
}
2019-02-09 23:12:10 +00:00
}