Your IP : 216.73.216.43
<?php
declare (strict_types=1);
namespace Rector\Php81\Rector\Property;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Expr\Assign;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Param;
use PhpParser\Node\Stmt\Class_;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\Node\Stmt\Property;
use PhpParser\NodeTraverser;
use Rector\Core\NodeAnalyzer\ParamAnalyzer;
use Rector\Core\NodeManipulator\PropertyFetchAssignManipulator;
use Rector\Core\NodeManipulator\PropertyManipulator;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\MethodName;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\Core\ValueObject\Visibility;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
/**
* @changelog https://wiki.php.net/rfc/readonly_properties_v2
*
* @see \Rector\Tests\Php81\Rector\Property\ReadOnlyPropertyRector\ReadOnlyPropertyRectorTest
*/
final class ReadOnlyPropertyRector extends AbstractRector implements MinPhpVersionInterface
{
/**
* @readonly
* @var \Rector\Core\NodeManipulator\PropertyManipulator
*/
private $propertyManipulator;
/**
* @readonly
* @var \Rector\Core\NodeManipulator\PropertyFetchAssignManipulator
*/
private $propertyFetchAssignManipulator;
/**
* @readonly
* @var \Rector\Core\NodeAnalyzer\ParamAnalyzer
*/
private $paramAnalyzer;
/**
* @readonly
* @var \Rector\Privatization\NodeManipulator\VisibilityManipulator
*/
private $visibilityManipulator;
public function __construct(PropertyManipulator $propertyManipulator, PropertyFetchAssignManipulator $propertyFetchAssignManipulator, ParamAnalyzer $paramAnalyzer, VisibilityManipulator $visibilityManipulator)
{
$this->propertyManipulator = $propertyManipulator;
$this->propertyFetchAssignManipulator = $propertyFetchAssignManipulator;
$this->paramAnalyzer = $paramAnalyzer;
$this->visibilityManipulator = $visibilityManipulator;
}
public function getRuleDefinition() : RuleDefinition
{
return new RuleDefinition('Decorate read-only property with `readonly` attribute', [new CodeSample(<<<'CODE_SAMPLE'
class SomeClass
{
public function __construct(
private string $name
) {
}
public function getName()
{
return $this->name;
}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClass
{
public function __construct(
private readonly string $name
) {
}
public function getName()
{
return $this->name;
}
}
CODE_SAMPLE
)]);
}
/**
* @return array<class-string<Node>>
*/
public function getNodeTypes() : array
{
return [Property::class, Param::class];
}
/**
* @param Property|Param $node
*/
public function refactor(Node $node) : ?Node
{
if ($node instanceof Param) {
return $this->refactorParam($node);
}
return $this->refactorProperty($node);
}
public function provideMinPhpVersion() : int
{
return PhpVersionFeature::READONLY_PROPERTY;
}
/**
* @param \PhpParser\Node\Stmt\Property|\PhpParser\Node\Param $node
*/
private function shouldSkipInReadonlyClass($node) : bool
{
$class = $this->betterNodeFinder->findParentType($node, Class_::class);
if (!$class instanceof Class_) {
return \true;
}
return $class->isReadonly();
}
private function refactorProperty(Property $property) : ?Property
{
// 1. is property read-only?
if ($property->isReadonly()) {
return null;
}
if ($property->props[0]->default instanceof Expr) {
return null;
}
if ($property->type === null) {
return null;
}
if ($property->isStatic()) {
return null;
}
if (!$this->visibilityManipulator->hasVisibility($property, Visibility::PRIVATE)) {
return null;
}
if ($this->propertyManipulator->isPropertyChangeableExceptConstructor($property)) {
return null;
}
if ($this->propertyFetchAssignManipulator->isAssignedMultipleTimesInConstructor($property)) {
return null;
}
if ($this->shouldSkipInReadonlyClass($property)) {
return null;
}
$this->visibilityManipulator->makeReadonly($property);
$attributeGroups = $property->attrGroups;
if ($attributeGroups !== []) {
$property->setAttribute(AttributeKey::ORIGINAL_NODE, null);
}
return $property;
}
private function refactorParam(Param $param) : ?\PhpParser\Node\Param
{
if (!$this->visibilityManipulator->hasVisibility($param, Visibility::PRIVATE)) {
return null;
}
if ($param->type === null) {
return null;
}
// promoted property?
if ($this->propertyManipulator->isPropertyChangeableExceptConstructor($param)) {
return null;
}
if ($this->visibilityManipulator->isReadonly($param)) {
return null;
}
if ($this->paramAnalyzer->isParamReassign($param)) {
return null;
}
if ($this->isPromotedPropertyAssigned($param)) {
return null;
}
if ($this->shouldSkipInReadonlyClass($param)) {
return null;
}
$this->visibilityManipulator->makeReadonly($param);
return $param;
}
private function isPromotedPropertyAssigned(Param $param) : bool
{
$classLike = $this->betterNodeFinder->findParentType($param, ClassLike::class);
if (!$classLike instanceof Class_) {
return \false;
}
$constructClassMethod = $classLike->getMethod(MethodName::CONSTRUCT);
if (!$constructClassMethod instanceof ClassMethod) {
return \false;
}
if ($param->flags === 0) {
return \false;
}
$propertyFetch = new PropertyFetch(new Variable('this'), $this->getName($param));
$stmts = $classLike->stmts;
$isAssigned = \false;
$this->traverseNodesWithCallable($stmts, function (Node $node) use($propertyFetch, &$isAssigned) : ?int {
if ($node instanceof Assign && $this->nodeComparator->areNodesEqual($propertyFetch, $node->var)) {
$isAssigned = \true;
return NodeTraverser::STOP_TRAVERSAL;
}
return null;
});
return $isAssigned;
}
}