2020-02-23 21:04:20 +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\DeadCode\Rector\ClassConst;
|
2020-02-23 21:04:20 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Stmt\ClassConst;
|
2023-06-05 09:32:57 +00:00
|
|
|
use PhpParser\NodeTraverser;
|
2023-06-09 15:36:48 +00:00
|
|
|
use PHPStan\Analyser\Scope;
|
2022-06-06 17:12:56 +00:00
|
|
|
use PHPStan\Reflection\ClassReflection;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\NodeManipulator\ClassConstManipulator;
|
|
|
|
use Rector\Rector\AbstractScopeAwareRector;
|
|
|
|
use Rector\Reflection\ReflectionResolver;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2020-02-23 21:04:20 +00:00
|
|
|
/**
|
2021-03-23 22:13:35 +00:00
|
|
|
* @see \Rector\Tests\DeadCode\Rector\ClassConst\RemoveUnusedPrivateClassConstantRector\RemoveUnusedPrivateClassConstantRectorTest
|
2020-02-23 21:04:20 +00:00
|
|
|
*/
|
2023-06-09 15:36:48 +00:00
|
|
|
final class RemoveUnusedPrivateClassConstantRector extends AbstractScopeAwareRector
|
2020-02-23 21:04:20 +00:00
|
|
|
{
|
2020-10-15 13:04:58 +00:00
|
|
|
/**
|
2023-06-11 23:01:39 +00:00
|
|
|
* @readonly
|
2024-01-02 02:40:38 +00:00
|
|
|
* @var \Rector\NodeManipulator\ClassConstManipulator
|
2020-10-15 13:04:58 +00:00
|
|
|
*/
|
|
|
|
private $classConstManipulator;
|
2022-05-04 10:46:11 +00:00
|
|
|
/**
|
2023-06-11 23:01:39 +00:00
|
|
|
* @readonly
|
2024-01-02 02:40:38 +00:00
|
|
|
* @var \Rector\Reflection\ReflectionResolver
|
2022-05-04 10:46:11 +00:00
|
|
|
*/
|
|
|
|
private $reflectionResolver;
|
2023-06-09 15:36:48 +00:00
|
|
|
public function __construct(ClassConstManipulator $classConstManipulator, ReflectionResolver $reflectionResolver)
|
2020-10-15 13:04:58 +00:00
|
|
|
{
|
|
|
|
$this->classConstManipulator = $classConstManipulator;
|
2022-05-04 10:46:11 +00:00
|
|
|
$this->reflectionResolver = $reflectionResolver;
|
2020-10-15 13:04:58 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2020-02-23 21:04:20 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Remove unused class constants', [new CodeSample(<<<'CODE_SAMPLE'
|
2020-02-23 21:04:20 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
private const SOME_CONST = 'dead';
|
|
|
|
|
|
|
|
public function run()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2020-02-23 21:04:20 +00:00
|
|
|
class SomeClass
|
|
|
|
{
|
|
|
|
public function run()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
)]);
|
2020-02-23 21:04:20 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2020-02-23 21:04:20 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2020-02-23 21:04:20 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return [ClassConst::class];
|
2020-02-23 21:04:20 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param ClassConst $node
|
2020-02-23 21:04:20 +00:00
|
|
|
*/
|
2023-06-09 15:36:48 +00:00
|
|
|
public function refactorWithScope(Node $node, Scope $scope) : ?int
|
2020-02-23 21:04:20 +00:00
|
|
|
{
|
2023-06-09 15:36:48 +00:00
|
|
|
if ($this->shouldSkipClassConst($node, $scope)) {
|
2020-02-23 21:04:20 +00:00
|
|
|
return null;
|
|
|
|
}
|
2022-05-04 10:46:11 +00:00
|
|
|
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
|
2022-06-07 08:22:29 +00:00
|
|
|
if (!$classReflection instanceof ClassReflection) {
|
2021-03-23 22:13:35 +00:00
|
|
|
return null;
|
2020-07-01 19:53:13 +00:00
|
|
|
}
|
2021-07-05 09:49:56 +00:00
|
|
|
if ($this->classConstManipulator->hasClassConstFetch($node, $classReflection)) {
|
2021-03-23 22:13:35 +00:00
|
|
|
return null;
|
2020-02-23 21:04:20 +00:00
|
|
|
}
|
2023-06-05 09:32:57 +00:00
|
|
|
return NodeTraverser::REMOVE_NODE;
|
2020-02-23 21:04:20 +00:00
|
|
|
}
|
2023-06-09 15:36:48 +00:00
|
|
|
private function shouldSkipClassConst(ClassConst $classConst, Scope $scope) : bool
|
2020-02-29 14:28:08 +00:00
|
|
|
{
|
2021-05-09 20:15:43 +00:00
|
|
|
if (!$classConst->isPrivate()) {
|
|
|
|
return \true;
|
2020-02-29 14:28:08 +00:00
|
|
|
}
|
2021-05-09 20:15:43 +00:00
|
|
|
if (\count($classConst->consts) !== 1) {
|
|
|
|
return \true;
|
2020-07-21 06:13:31 +00:00
|
|
|
}
|
2023-06-09 15:36:48 +00:00
|
|
|
$classReflection = $scope->getClassReflection();
|
|
|
|
if (!$classReflection instanceof ClassReflection) {
|
|
|
|
return \false;
|
|
|
|
}
|
|
|
|
return $this->hasParentClassOfEnumSuffix($classReflection);
|
|
|
|
}
|
|
|
|
private function hasParentClassOfEnumSuffix(ClassReflection $classReflection) : bool
|
|
|
|
{
|
|
|
|
foreach ($classReflection->getParentClassesNames() as $parentClassesName) {
|
|
|
|
if (\substr_compare($parentClassesName, 'Enum', -\strlen('Enum')) === 0) {
|
|
|
|
return \true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return \false;
|
2020-02-29 14:28:08 +00:00
|
|
|
}
|
2020-02-23 21:04:20 +00:00
|
|
|
}
|