mirror of
https://github.com/rectorphp/rector.git
synced 2024-06-01 00:40:52 +00:00
11b9220a05
b4eb883e91
[DeadCode] Skip isset() from property fetch from docblock on RemoveAlwaysTrueIfConditionRector (#5754)
127 lines
4.4 KiB
PHP
127 lines
4.4 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Doctrine\CodeQuality\Rector\Class_;
|
|
|
|
use PhpParser\Node;
|
|
use PhpParser\Node\Expr;
|
|
use PhpParser\Node\Name\FullyQualified;
|
|
use PhpParser\Node\Stmt\Class_;
|
|
use Rector\Doctrine\NodeAnalyzer\AttrinationFinder;
|
|
use Rector\Doctrine\NodeFactory\ArrayCollectionAssignFactory;
|
|
use Rector\NodeManipulator\ClassDependencyManipulator;
|
|
use Rector\Rector\AbstractRector;
|
|
use Rector\TypeDeclaration\AlreadyAssignDetector\ConstructorAssignDetector;
|
|
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
|
|
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
|
|
/**
|
|
* @see \Rector\Doctrine\Tests\CodeQuality\Rector\Class_\ExplicitRelationCollectionRector\ExplicitRelationCollectionRectorTest
|
|
*
|
|
* @changelog https://www.doctrine-project.org/projects/doctrine-orm/en/2.6/reference/best-practices.html#initialize-collections-in-the-constructor
|
|
*/
|
|
final class ExplicitRelationCollectionRector extends AbstractRector
|
|
{
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Doctrine\NodeAnalyzer\AttrinationFinder
|
|
*/
|
|
private $attrinationFinder;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\TypeDeclaration\AlreadyAssignDetector\ConstructorAssignDetector
|
|
*/
|
|
private $constructorAssignDetector;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Doctrine\NodeFactory\ArrayCollectionAssignFactory
|
|
*/
|
|
private $arrayCollectionAssignFactory;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\NodeManipulator\ClassDependencyManipulator
|
|
*/
|
|
private $classDependencyManipulator;
|
|
public function __construct(AttrinationFinder $attrinationFinder, ConstructorAssignDetector $constructorAssignDetector, ArrayCollectionAssignFactory $arrayCollectionAssignFactory, ClassDependencyManipulator $classDependencyManipulator)
|
|
{
|
|
$this->attrinationFinder = $attrinationFinder;
|
|
$this->constructorAssignDetector = $constructorAssignDetector;
|
|
$this->arrayCollectionAssignFactory = $arrayCollectionAssignFactory;
|
|
$this->classDependencyManipulator = $classDependencyManipulator;
|
|
}
|
|
public function getRuleDefinition() : RuleDefinition
|
|
{
|
|
return new RuleDefinition('Use explicit collection in one-to-many relations of Doctrine entity', [new CodeSample(<<<'CODE_SAMPLE'
|
|
use Doctrine\ORM\Mapping\OneToMany;
|
|
use Doctrine\ORM\Mapping\Entity;
|
|
|
|
#[Entity]
|
|
class SomeClass
|
|
{
|
|
#[OneToMany(targetEntity: 'SomeClass')]
|
|
private $items = [];
|
|
}
|
|
CODE_SAMPLE
|
|
, <<<'CODE_SAMPLE'
|
|
use Doctrine\ORM\Mapping\Entity;
|
|
use Doctrine\ORM\Mapping\OneToMany;
|
|
use Doctrine\Common\Collections\ArrayCollection;
|
|
use Doctrine\Common\Collections\Collection;
|
|
|
|
#[Entity]
|
|
class SomeClass
|
|
{
|
|
#[OneToMany(targetEntity: 'SomeClass')]
|
|
private Collection $items;
|
|
|
|
public function __construct()
|
|
{
|
|
$this->items = new ArrayCollection();
|
|
}
|
|
}
|
|
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->attrinationFinder->hasByOne($node, 'Doctrine\\ORM\\Mapping\\Entity')) {
|
|
return null;
|
|
}
|
|
$arrayCollectionAssigns = [];
|
|
foreach ($node->getProperties() as $property) {
|
|
if (!$this->attrinationFinder->hasByMany($property, ['Doctrine\\ORM\\Mapping\\OneToMany', 'Doctrine\\ORM\\Mapping\\ManyToMany'])) {
|
|
continue;
|
|
}
|
|
// make sure has collection
|
|
if (!$property->type instanceof Node) {
|
|
$property->type = new FullyQualified('Doctrine\\Common\\Collections\\Collection');
|
|
}
|
|
// make sure is null
|
|
if ($property->props[0]->default instanceof Expr) {
|
|
$property->props[0]->default = null;
|
|
}
|
|
/** @var string $propertyName */
|
|
$propertyName = $this->getName($property);
|
|
if ($this->constructorAssignDetector->isPropertyAssigned($node, $propertyName)) {
|
|
continue;
|
|
}
|
|
$arrayCollectionAssigns[] = $this->arrayCollectionAssignFactory->createFromPropertyName($propertyName);
|
|
// make sure it is initialized in constructor
|
|
}
|
|
if ($arrayCollectionAssigns === []) {
|
|
return null;
|
|
}
|
|
$this->classDependencyManipulator->addStmtsToConstructorIfNotThereYet($node, $arrayCollectionAssigns);
|
|
return $node;
|
|
}
|
|
}
|