rector/rules/DeadCode/Rector/ClassConst/RemoveUnusedPrivateClassCon...

99 lines
2.7 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\DeadCode\Rector\ClassConst;
use PhpParser\Node;
use PhpParser\Node\Stmt\ClassConst;
use PhpParser\NodeTraverser;
use PHPStan\Reflection\ClassReflection;
use Rector\Core\NodeAnalyzer\EnumAnalyzer;
use Rector\Core\NodeManipulator\ClassConstManipulator;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\Reflection\ReflectionResolver;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\DeadCode\Rector\ClassConst\RemoveUnusedPrivateClassConstantRector\RemoveUnusedPrivateClassConstantRectorTest
*/
final class RemoveUnusedPrivateClassConstantRector extends AbstractRector
{
/**
* @readonly
* @var \Rector\Core\NodeManipulator\ClassConstManipulator
*/
private $classConstManipulator;
/**
* @readonly
* @var \Rector\Core\NodeAnalyzer\EnumAnalyzer
*/
private $enumAnalyzer;
/**
* @readonly
* @var \Rector\Core\Reflection\ReflectionResolver
*/
private $reflectionResolver;
public function __construct(ClassConstManipulator $classConstManipulator, EnumAnalyzer $enumAnalyzer, ReflectionResolver $reflectionResolver)
{
$this->classConstManipulator = $classConstManipulator;
$this->enumAnalyzer = $enumAnalyzer;
$this->reflectionResolver = $reflectionResolver;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Remove unused class constants', [new CodeSample(<<<'CODE_SAMPLE'
class SomeClass
{
private const SOME_CONST = 'dead';
public function run()
{
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass
{
public function run()
{
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [ClassConst::class];
}
/**
* @param ClassConst $node
*/
public function refactor(Node $node) : ?int
{
if ($this->shouldSkipClassConst($node)) {
return null;
}
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
if (!$classReflection instanceof ClassReflection) {
return null;
}
if ($this->classConstManipulator->hasClassConstFetch($node, $classReflection)) {
return null;
}
return NodeTraverser::REMOVE_NODE;
}
private function shouldSkipClassConst(ClassConst $classConst) : bool
{
if (!$classConst->isPrivate()) {
return \true;
}
if (\count($classConst->consts) !== 1) {
return \true;
}
return $this->enumAnalyzer->isEnumClassConst($classConst);
}
}