2019-10-13 05:59:52 +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\Visibility\Rector\ClassConst;
|
2018-07-31 09:15:27 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
|
|
|
use PhpParser\Node\Stmt\ClassConst;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\Contract\Rector\ConfigurableRectorInterface;
|
2022-06-06 17:12:56 +00:00
|
|
|
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
|
2024-01-02 02:40:38 +00:00
|
|
|
use Rector\Rector\AbstractRector;
|
|
|
|
use Rector\ValueObject\Visibility;
|
2022-06-06 17:12:56 +00:00
|
|
|
use Rector\Visibility\ValueObject\ChangeConstantVisibility;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2024-05-02 02:21:56 +00:00
|
|
|
use RectorPrefix202405\Webmozart\Assert\Assert;
|
2019-09-03 09:11:45 +00:00
|
|
|
/**
|
2021-03-12 22:20:25 +00:00
|
|
|
* @see \Rector\Tests\Visibility\Rector\ClassConst\ChangeConstantVisibilityRector\ChangeConstantVisibilityRectorTest
|
2019-09-03 09:11:45 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class ChangeConstantVisibilityRector extends AbstractRector implements ConfigurableRectorInterface
|
2018-07-31 09:15:27 +00:00
|
|
|
{
|
2021-11-24 11:00:16 +00:00
|
|
|
/**
|
2023-06-11 23:01:39 +00:00
|
|
|
* @readonly
|
2021-11-24 11:00:16 +00:00
|
|
|
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
|
|
|
|
*/
|
|
|
|
private $visibilityManipulator;
|
2023-06-08 22:00:17 +00:00
|
|
|
/**
|
|
|
|
* @var ChangeConstantVisibility[]
|
|
|
|
*/
|
|
|
|
private $classConstantVisibilityChanges = [];
|
2022-06-07 08:22:29 +00:00
|
|
|
public function __construct(VisibilityManipulator $visibilityManipulator)
|
2021-11-24 11:00:16 +00:00
|
|
|
{
|
|
|
|
$this->visibilityManipulator = $visibilityManipulator;
|
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2018-07-31 09:15:27 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Change visibility of constant from parent class.', [new ConfiguredCodeSample(<<<'CODE_SAMPLE'
|
2018-07-31 09:15:27 +00:00
|
|
|
class FrameworkClass
|
|
|
|
{
|
|
|
|
protected const SOME_CONSTANT = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
class MyClass extends FrameworkClass
|
|
|
|
{
|
|
|
|
public const SOME_CONSTANT = 1;
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2018-07-31 09:15:27 +00:00
|
|
|
class FrameworkClass
|
|
|
|
{
|
|
|
|
protected const SOME_CONSTANT = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
class MyClass extends FrameworkClass
|
|
|
|
{
|
|
|
|
protected const SOME_CONSTANT = 1;
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2022-06-07 08:22:29 +00:00
|
|
|
, [new ChangeConstantVisibility('ParentObject', 'SOME_CONSTANT', Visibility::PROTECTED)])]);
|
2018-07-31 09:15:27 +00:00
|
|
|
}
|
2018-08-14 22:12:41 +00:00
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2018-08-14 22:12:41 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2018-07-31 09:15:27 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return [ClassConst::class];
|
2018-07-31 09:15:27 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param ClassConst $node
|
2018-07-31 09:15:27 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function refactor(Node $node) : ?Node
|
2018-07-31 09:15:27 +00:00
|
|
|
{
|
2020-08-27 10:19:22 +00:00
|
|
|
foreach ($this->classConstantVisibilityChanges as $classConstantVisibilityChange) {
|
2023-03-22 14:20:22 +00:00
|
|
|
if (!$this->isName($node, $classConstantVisibilityChange->getConstant())) {
|
2018-10-31 21:26:34 +00:00
|
|
|
continue;
|
|
|
|
}
|
2023-03-22 14:20:22 +00:00
|
|
|
if (!$this->isObjectType($node, $classConstantVisibilityChange->getObjectType())) {
|
2020-08-27 10:19:22 +00:00
|
|
|
continue;
|
|
|
|
}
|
2021-01-30 21:41:25 +00:00
|
|
|
$this->visibilityManipulator->changeNodeVisibility($node, $classConstantVisibilityChange->getVisibility());
|
2020-08-27 10:19:22 +00:00
|
|
|
return $node;
|
2018-10-31 21:26:34 +00:00
|
|
|
}
|
|
|
|
return null;
|
2018-07-31 09:19:00 +00:00
|
|
|
}
|
2021-11-02 15:11:40 +00:00
|
|
|
/**
|
2021-11-28 16:42:02 +00:00
|
|
|
* @param mixed[] $configuration
|
2021-11-02 15:11:40 +00:00
|
|
|
*/
|
2021-12-10 10:22:23 +00:00
|
|
|
public function configure(array $configuration) : void
|
2020-07-29 23:39:41 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
Assert::allIsAOf($configuration, ChangeConstantVisibility::class);
|
2022-02-18 01:46:17 +00:00
|
|
|
$this->classConstantVisibilityChanges = $configuration;
|
2020-07-29 23:39:41 +00:00
|
|
|
}
|
2018-07-31 09:15:27 +00:00
|
|
|
}
|