mirror of https://github.com/rectorphp/rector.git
93 lines
2.8 KiB
PHP
93 lines
2.8 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Visibility\Rector\ClassConst;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Stmt\ClassConst;
|
|
use Rector\Contract\Rector\ConfigurableRectorInterface;
|
|
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
|
|
use Rector\Rector\AbstractRector;
|
|
use Rector\ValueObject\Visibility;
|
|
use Rector\Visibility\ValueObject\ChangeConstantVisibility;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
use RectorPrefix202405\Webmozart\Assert\Assert;
|
|
/**
|
|
* @see \Rector\Tests\Visibility\Rector\ClassConst\ChangeConstantVisibilityRector\ChangeConstantVisibilityRectorTest
|
|
*/
|
|
final class ChangeConstantVisibilityRector extends AbstractRector implements ConfigurableRectorInterface
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
|
|
*/
|
|
private $visibilityManipulator;
|
|
/**
|
|
* @var ChangeConstantVisibility[]
|
|
*/
|
|
private $classConstantVisibilityChanges = [];
|
|
public function __construct(VisibilityManipulator $visibilityManipulator)
|
|
{
|
|
$this->visibilityManipulator = $visibilityManipulator;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Change visibility of constant from parent class.', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
|
class FrameworkClass
|
|
{
|
|
protected const SOME_CONSTANT = 1;
|
|
}
|
|
|
|
class MyClass extends FrameworkClass
|
|
{
|
|
public const SOME_CONSTANT = 1;
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class FrameworkClass
|
|
{
|
|
protected const SOME_CONSTANT = 1;
|
|
}
|
|
|
|
class MyClass extends FrameworkClass
|
|
{
|
|
protected const SOME_CONSTANT = 1;
|
|
}
|
|
CODE_SAMPLE
|
|
, [new ChangeConstantVisibility('ParentObject', 'SOME_CONSTANT', Visibility::PROTECTED)])]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [ClassConst::class];
|
|
}
|
|
/**
|
|
* @param ClassConst $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
foreach ($this->classConstantVisibilityChanges as $classConstantVisibilityChange) {
|
|
if (!$this->isName($node, $classConstantVisibilityChange->getConstant())) {
|
|
continue;
|
|
}
|
|
if (!$this->isObjectType($node, $classConstantVisibilityChange->getObjectType())) {
|
|
continue;
|
|
}
|
|
$this->visibilityManipulator->changeNodeVisibility($node, $classConstantVisibilityChange->getVisibility());
|
|
return $node;
|
|
}
|
|
return null;
|
|
}
|
|
/**
|
|
* @param mixed[] $configuration
|
|
*/
|
|
public function configure(array $configuration) : void
|
|
{
|
|
Assert::allIsAOf($configuration, ChangeConstantVisibility::class);
|
|
$this->classConstantVisibilityChanges = $configuration;
|
|
}
|
|
}
|