rector/rules/Removing/Rector/Class_/RemoveTraitUseRector.php
Tomas Votruba 96112cb1f0 Updated Rector to commit 2da49992cc
2da49992cc [Downgrade] [PHP 7.2] Make DowngradeParameterTypeWideningRector always downgrade to phpdoc type (#390)
2021-07-05 22:50:18 +00:00

83 lines
2.5 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Removing\Rector\Class_;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\Trait_;
use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\Removing\Rector\Class_\RemoveTraitUseRector\RemoveTraitUseRectorTest
*/
final class RemoveTraitUseRector extends \Rector\Core\Rector\AbstractRector implements \Rector\Core\Contract\Rector\ConfigurableRectorInterface
{
/**
* @var string
*/
public const TRAITS_TO_REMOVE = 'traits_to_remove';
/**
* @var bool
*/
private $classHasChanged = \false;
/**
* @var string[]
*/
private $traitsToRemove = [];
public function getRuleDefinition() : \Symplify\RuleDocGenerator\ValueObject\RuleDefinition
{
return new \Symplify\RuleDocGenerator\ValueObject\RuleDefinition('Remove specific traits from code', [new \Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample(<<<'CODE_SAMPLE'
class SomeClass
{
use SomeTrait;
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass
{
}
CODE_SAMPLE
, [self::TRAITS_TO_REMOVE => ['TraitNameToRemove']])]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [\PhpParser\Node\Stmt\Class_::class, \PhpParser\Node\Stmt\Trait_::class];
}
/**
* @param Class_|Trait_ $node
*/
public function refactor(\PhpParser\Node $node) : ?\PhpParser\Node
{
$this->classHasChanged = \false;
foreach ($node->getTraitUses() as $traitUse) {
foreach ($traitUse->traits as $trait) {
if (!$this->isNames($trait, $this->traitsToRemove)) {
continue;
}
$this->removeNode($traitUse);
$this->classHasChanged = \true;
}
}
// invoke re-print
if ($this->classHasChanged) {
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::ORIGINAL_NODE, null);
return $node;
}
return null;
}
/**
* @param array<string, string[]> $configuration
*/
public function configure(array $configuration) : void
{
$this->traitsToRemove = $configuration[self::TRAITS_TO_REMOVE] ?? [];
}
}