2020-05-26 22:22:22 +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\Privatization\Rector\ClassMethod;
|
2020-05-26 22:22:22 +00:00
|
|
|
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node;
|
2022-12-12 08:02:46 +00:00
|
|
|
use PhpParser\Node\Stmt\Class_;
|
2022-06-06 17:12:56 +00:00
|
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
|
|
use PHPStan\Reflection\ClassReflection;
|
|
|
|
use Rector\Core\Rector\AbstractRector;
|
|
|
|
use Rector\Core\Reflection\ReflectionResolver;
|
2022-12-12 08:02:46 +00:00
|
|
|
use Rector\NodeTypeResolver\Node\AttributeKey;
|
2022-06-06 17:12:56 +00:00
|
|
|
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
|
|
|
|
use Rector\Privatization\VisibilityGuard\ClassMethodVisibilityGuard;
|
2022-06-07 09:18:30 +00:00
|
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
2020-05-26 22:22:22 +00:00
|
|
|
/**
|
2021-03-12 22:20:25 +00:00
|
|
|
* @see \Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\PrivatizeFinalClassMethodRectorTest
|
2020-05-26 22:22:22 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
final class PrivatizeFinalClassMethodRector extends AbstractRector
|
2020-05-26 22:22:22 +00:00
|
|
|
{
|
2020-08-24 22:26:14 +00:00
|
|
|
/**
|
2021-12-04 12:47:17 +00:00
|
|
|
* @readonly
|
2021-05-10 23:39:21 +00:00
|
|
|
* @var \Rector\Privatization\VisibilityGuard\ClassMethodVisibilityGuard
|
2020-08-24 22:26:14 +00:00
|
|
|
*/
|
|
|
|
private $classMethodVisibilityGuard;
|
2021-11-24 11:00:16 +00:00
|
|
|
/**
|
2021-12-04 12:47:17 +00:00
|
|
|
* @readonly
|
2021-11-24 11:00:16 +00:00
|
|
|
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
|
|
|
|
*/
|
|
|
|
private $visibilityManipulator;
|
2022-05-04 10:46:11 +00:00
|
|
|
/**
|
|
|
|
* @readonly
|
|
|
|
* @var \Rector\Core\Reflection\ReflectionResolver
|
|
|
|
*/
|
|
|
|
private $reflectionResolver;
|
2022-06-07 08:22:29 +00:00
|
|
|
public function __construct(ClassMethodVisibilityGuard $classMethodVisibilityGuard, VisibilityManipulator $visibilityManipulator, ReflectionResolver $reflectionResolver)
|
2020-08-24 22:26:14 +00:00
|
|
|
{
|
|
|
|
$this->classMethodVisibilityGuard = $classMethodVisibilityGuard;
|
2021-11-24 11:00:16 +00:00
|
|
|
$this->visibilityManipulator = $visibilityManipulator;
|
2022-05-04 10:46:11 +00:00
|
|
|
$this->reflectionResolver = $reflectionResolver;
|
2020-08-24 22:26:14 +00:00
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
public function getRuleDefinition() : RuleDefinition
|
2020-05-26 22:22:22 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return new RuleDefinition('Change protected class method to private if possible', [new CodeSample(<<<'CODE_SAMPLE'
|
2020-05-26 22:22:22 +00:00
|
|
|
final class SomeClass
|
|
|
|
{
|
|
|
|
protected function someMethod()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
, <<<'CODE_SAMPLE'
|
2020-05-26 22:22:22 +00:00
|
|
|
final class SomeClass
|
|
|
|
{
|
|
|
|
private function someMethod()
|
|
|
|
{
|
|
|
|
}
|
|
|
|
}
|
2020-09-15 08:23:13 +00:00
|
|
|
CODE_SAMPLE
|
2021-05-09 20:15:43 +00:00
|
|
|
)]);
|
2020-05-26 22:22:22 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-02-27 00:06:15 +00:00
|
|
|
* @return array<class-string<Node>>
|
2020-05-26 22:22:22 +00:00
|
|
|
*/
|
2021-05-09 20:15:43 +00:00
|
|
|
public function getNodeTypes() : array
|
2020-05-26 22:22:22 +00:00
|
|
|
{
|
2022-06-07 08:22:29 +00:00
|
|
|
return [ClassMethod::class];
|
2020-05-26 22:22:22 +00:00
|
|
|
}
|
|
|
|
/**
|
2021-12-10 10:22:23 +00:00
|
|
|
* @param ClassMethod $node
|
2020-05-26 22:22:22 +00:00
|
|
|
*/
|
2022-06-07 08:22:29 +00:00
|
|
|
public function refactor(Node $node) : ?Node
|
2020-05-26 22:22:22 +00:00
|
|
|
{
|
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-10-04 21:24:17 +00:00
|
|
|
return null;
|
|
|
|
}
|
2022-12-12 08:02:46 +00:00
|
|
|
$class = $node->getAttribute(AttributeKey::PARENT_NODE);
|
|
|
|
if (!$class instanceof Class_) {
|
2021-02-28 07:47:48 +00:00
|
|
|
return null;
|
|
|
|
}
|
2022-12-12 08:02:46 +00:00
|
|
|
if (!$class->isFinal()) {
|
2020-05-26 22:22:22 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
if ($this->shouldSkipClassMethod($node)) {
|
|
|
|
return null;
|
|
|
|
}
|
2021-02-28 07:47:48 +00:00
|
|
|
if ($this->classMethodVisibilityGuard->isClassMethodVisibilityGuardedByParent($node, $classReflection)) {
|
2021-01-08 22:30:33 +00:00
|
|
|
return null;
|
2020-05-26 22:22:22 +00:00
|
|
|
}
|
2021-02-28 07:47:48 +00:00
|
|
|
if ($this->classMethodVisibilityGuard->isClassMethodVisibilityGuardedByTrait($node, $classReflection)) {
|
2020-05-26 22:22:22 +00:00
|
|
|
return null;
|
|
|
|
}
|
2021-01-30 21:41:25 +00:00
|
|
|
$this->visibilityManipulator->makePrivate($node);
|
2020-05-26 22:22:22 +00:00
|
|
|
return $node;
|
|
|
|
}
|
2022-06-07 08:22:29 +00:00
|
|
|
private function shouldSkipClassMethod(ClassMethod $classMethod) : bool
|
2020-05-26 22:22:22 +00:00
|
|
|
{
|
|
|
|
if ($this->isName($classMethod, 'createComponent*')) {
|
2021-05-09 20:15:43 +00:00
|
|
|
return \true;
|
2020-05-26 22:22:22 +00:00
|
|
|
}
|
2021-05-09 20:15:43 +00:00
|
|
|
return !$classMethod->isProtected();
|
2020-05-26 22:22:22 +00:00
|
|
|
}
|
|
|
|
}
|