mirror of https://github.com/rectorphp/rector.git
129 lines
4.0 KiB
PHP
129 lines
4.0 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Php74\Rector\Property;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Stmt\Class_;
|
|
use PhpParser\Node\Stmt\Property;
|
|
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
|
|
use Rector\Rector\AbstractRector;
|
|
use Rector\TypeDeclaration\AlreadyAssignDetector\ConstructorAssignDetector;
|
|
use Rector\ValueObject\PhpVersionFeature;
|
|
use Rector\VersionBonding\Contract\MinPhpVersionInterface;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Tests\Php74\Rector\Property\RestoreDefaultNullToNullableTypePropertyRector\RestoreDefaultNullToNullableTypePropertyRectorTest
|
|
*/
|
|
final class RestoreDefaultNullToNullableTypePropertyRector extends AbstractRector implements MinPhpVersionInterface
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\TypeDeclaration\AlreadyAssignDetector\ConstructorAssignDetector
|
|
*/
|
|
private $constructorAssignDetector;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory
|
|
*/
|
|
private $phpDocInfoFactory;
|
|
public function __construct(ConstructorAssignDetector $constructorAssignDetector, PhpDocInfoFactory $phpDocInfoFactory)
|
|
{
|
|
$this->constructorAssignDetector = $constructorAssignDetector;
|
|
$this->phpDocInfoFactory = $phpDocInfoFactory;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Add null default to properties with PHP 7.4 property nullable type', [new CodeSample(<<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public ?string $name;
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
class SomeClass
|
|
{
|
|
public ?string $name = null;
|
|
}
|
|
CODE_SAMPLE
|
|
)]);
|
|
}
|
|
/**
|
|
* @return array<class-string<Node>>
|
|
*/
|
|
public function getNodeTypes() : array
|
|
{
|
|
return [Class_::class];
|
|
}
|
|
/**
|
|
* @param Class_ $node
|
|
*/
|
|
public function refactor(Node $node) : ?Node
|
|
{
|
|
if ($this->isReadonlyClass($node)) {
|
|
return null;
|
|
}
|
|
$hasChanged = \false;
|
|
foreach ($node->getProperties() as $property) {
|
|
if ($this->shouldSkip($property, $node)) {
|
|
continue;
|
|
}
|
|
$onlyProperty = $property->props[0];
|
|
$onlyProperty->default = $this->nodeFactory->createNull();
|
|
$hasChanged = \true;
|
|
}
|
|
if ($hasChanged) {
|
|
return $node;
|
|
}
|
|
return null;
|
|
}
|
|
public function provideMinPhpVersion() : int
|
|
{
|
|
return PhpVersionFeature::TYPED_PROPERTIES;
|
|
}
|
|
private function shouldSkip(Property $property, Class_ $class) : bool
|
|
{
|
|
if ($property->type === null) {
|
|
return \true;
|
|
}
|
|
if (\count($property->props) > 1) {
|
|
return \true;
|
|
}
|
|
$onlyProperty = $property->props[0];
|
|
if ($onlyProperty->default instanceof Expr) {
|
|
return \true;
|
|
}
|
|
if ($this->isReadonlyProperty($property)) {
|
|
return \true;
|
|
}
|
|
if (!$this->nodeTypeResolver->isNullableType($property)) {
|
|
return \true;
|
|
}
|
|
// is variable assigned in constructor
|
|
$propertyName = $this->getName($property);
|
|
return $this->constructorAssignDetector->isPropertyAssigned($class, $propertyName);
|
|
}
|
|
private function isReadonlyProperty(Property $property) : bool
|
|
{
|
|
// native readonly
|
|
if ($property->isReadonly()) {
|
|
return \true;
|
|
}
|
|
// @readonly annotation
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
|
|
return $phpDocInfo->hasByName('@readonly');
|
|
}
|
|
private function isReadonlyClass(Class_ $class) : bool
|
|
{
|
|
// native readonly
|
|
if ($class->isReadonly()) {
|
|
return \true;
|
|
}
|
|
// @immutable annotation
|
|
$phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($class);
|
|
return $phpDocInfo->hasByName('@immutable');
|
|
}
|
|
}
|