rector/rules/Privatization/Rector/ClassMethod/PrivatizeFinalClassMethodRe...

107 lines
3.2 KiB
PHP

<?php
declare (strict_types=1);
namespace Rector\Privatization\Rector\ClassMethod;
use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassMethod;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use Rector\Core\Rector\AbstractRector;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
use Rector\Privatization\VisibilityGuard\ClassMethodVisibilityGuard;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @see \Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\PrivatizeFinalClassMethodRectorTest
*/
final class PrivatizeFinalClassMethodRector extends AbstractRector
{
/**
* @readonly
* @var \Rector\Privatization\VisibilityGuard\ClassMethodVisibilityGuard
*/
private $classMethodVisibilityGuard;
/**
* @readonly
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
*/
private $visibilityManipulator;
public function __construct(ClassMethodVisibilityGuard $classMethodVisibilityGuard, VisibilityManipulator $visibilityManipulator)
{
$this->classMethodVisibilityGuard = $classMethodVisibilityGuard;
$this->visibilityManipulator = $visibilityManipulator;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Change protected class method to private if possible', [new CodeSample(<<<'CODE_SAMPLE'
final class SomeClass
{
protected function someMethod()
{
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
final class SomeClass
{
private function someMethod()
{
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Class_::class];
}
/**
* @param Class_ $node
*/
public function refactor(Node $node) : ?Node
{
if (!$node->isFinal()) {
return null;
}
$classScope = $node->getAttribute(AttributeKey::SCOPE);
if (!$classScope instanceof Scope) {
return null;
}
$classReflection = $classScope->getClassReflection();
if (!$classReflection instanceof ClassReflection) {
return null;
}
$hasChanged = \false;
foreach ($node->getMethods() as $classMethod) {
if ($this->shouldSkipClassMethod($classMethod)) {
continue;
}
if ($this->classMethodVisibilityGuard->isClassMethodVisibilityGuardedByParent($classMethod, $classReflection)) {
continue;
}
if ($this->classMethodVisibilityGuard->isClassMethodVisibilityGuardedByTrait($classMethod, $classReflection)) {
continue;
}
$this->visibilityManipulator->makePrivate($classMethod);
$hasChanged = \true;
}
if ($hasChanged) {
return $node;
}
return null;
}
private function shouldSkipClassMethod(ClassMethod $classMethod) : bool
{
if ($this->isName($classMethod, 'createComponent*')) {
return \true;
}
return !$classMethod->isProtected();
}
}