Add a Rector Rule to change the argument type from array to ArrayColl…

…ection for the setParameters ORM QueryBuilder method

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/Fixtures/array-with-parameters.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters([
+ new \Doctrine\ORM\Query\Parameter('foo', 'bar'),
+ new \Doctrine\ORM\Query\Parameter('bar', 1),
+ new \Doctrine\ORM\Query\Parameter('baz', false),
+ ]);
+ }
+}
+?>
+-----
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters(new \Doctrine\Common\Collections\ArrayCollection([new \Doctrine\ORM\Query\Parameter('foo', 'bar'), new \Doctrine\ORM\Query\Parameter('bar', 1), new \Doctrine\ORM\Query\Parameter('baz', false)]));
+ }
+}
+?>

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/Fixtures/collection-with-key-value.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters(new \Doctrine\Common\Collections\ArrayCollection([
+ 'foo' => 'bar',
+ 'bar' => 1,
+ 'baz' => false
+ ]));
+ }
+}
+?>
+-----
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters(new \Doctrine\Common\Collections\ArrayCollection([new \Doctrine\ORM\Query\Parameter('foo', 'bar'), new \Doctrine\ORM\Query\Parameter('bar', 1), new \Doctrine\ORM\Query\Parameter('baz', false)]));
+ }
+}
+?>

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/Fixtures/key-value.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters([
+ 'foo' => 'bar',
+ 'bar' => 1,
+ 'baz' => false
+ ]);
+ }
+}
+?>
+-----
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters(new \Doctrine\Common\Collections\ArrayCollection([new \Doctrine\ORM\Query\Parameter('foo', 'bar'), new \Doctrine\ORM\Query\Parameter('bar', 1), new \Doctrine\ORM\Query\Parameter('baz', false)]));
+ }
+}
+?>

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/Fixtures/no-change.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilder()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters(new \Doctrine\Common\Collections\ArrayCollection([
+ new \Doctrine\ORM\Query\Parameter('foo', 'bar'),
+ new \Doctrine\ORM\Query\Parameter('bar', 1),
+ new \Doctrine\ORM\Query\Parameter('baz', false),
+ ]));
+ }
+}
+?>

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/Fixtures/numeric_list.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilderWithNumeric()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters([
+ 'one',
+ 'two',
+ 'three'
+ ]);
+ }
+}
+?>
+-----
+<?php
+
+final class QueryBuilderCall
+{
+ public function createCustomQueryBuilderWithNumeric()
+ {
+ $ormQueryBuilder = new \Doctrine\ORM\QueryBuilder();
+ $ormQueryBuilder->setParameters(new \Doctrine\Common\Collections\ArrayCollection([new \Doctrine\ORM\Query\Parameter(0, 'one'), new \Doctrine\ORM\Query\Parameter(1, 'two'), new \Doctrine\ORM\Query\Parameter(2, 'three')]));
+ }
+}
+?>

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/SetParametersArrayToCollectionRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Tests\Orm30\Rector\MethodCall\SetParametersArrayToCollectionRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class SetParametersArrayToCollectionRectorTest extends AbstractRectorTestCase
+{
+ #[DataProvider('provideData')]
+ public function test(string $filePath): void
+ {
+ $this->doTestFile($filePath);
+ }
+
+ public static function provideData(): Iterator
+ {
+ return self::yieldFilesFromDirectory(__DIR__ . '/Fixtures');
+ }
+
+ public function provideConfigFilePath(): string
+ {
+ return __DIR__ . '/configured_rule.php';
+ }
+}

rules-tests/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector/configured_rule.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+ ->withRules([\Rector\Doctrine\Orm30\Rector\MethodCall\SetParametersArrayToCollectionRector::class]);

rules/Orm30/Rector/MethodCall/SetParametersArrayToCollectionRector.php

@@ -0,0 +1,127 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Doctrine\Orm30\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\ArrayItem;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Scalar\LNumber;
+use PHPStan\Type\ObjectType;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see https://github.com/doctrine/orm/pull/9490
+ * @see https://github.com/doctrine/orm/blob/3.0.x/UPGRADE.md#query-querybuilder-and-nativequery-parameters-bc-break
+ */
+final class SetParametersArrayToCollectionRector extends AbstractRector
+{
+ public function getRuleDefinition(): RuleDefinition
+ {
+ return new RuleDefinition(
+ 'Change the argument type for setParameters from array to ArrayCollection and Parameter calls',
+ [
+ new CodeSample(
+ <<<'CODE_SAMPLE'
+ $entityManager->createQueryBuilder()->setParameters([
+ 'foo' => 'bar'
+ ]);
+ CODE_SAMPLE
+ ,
+ <<<'CODE_SAMPLE'
+ $entityManager->createQueryBuilder()->setParameters(new \Doctrine\Common\Collections\ArrayCollection([
+ new \Doctrine\ORM\Query\Parameter('foo', 'bar')
+ ]));
+ CODE_SAMPLE
+ )]
+ );
+ }
+
+ /**
+ * @return array<class-string<Node>>
+ */
+ public function getNodeTypes(): array
+ {
+ return [MethodCall::class];
+ }
+
+ public function refactor(Node $node): Node|null
+ {
+ assert($node instanceof MethodCall);
+ $varType = $this->nodeTypeResolver->getType($node->var);
+
+ if (! $varType instanceof ObjectType) {
+ return null;
+ }
+
+ if (! $varType->isInstanceOf('Doctrine\\ORM\\QueryBuilder')->yes()) {
+ return null;
+ }
+
+ if (! $this->isNames($node->name, ['setParameters'])) {
+ return null;
+ }
+
+ $args = $node->getArgs();
+ if (\count($args) !== 1) {
+ return null;
+ }
+
+ $currentArg = $args[0]->value;
+ $isAlreadyAnArrayCollection = false;
+
+ $currentArgType = $this->nodeTypeResolver->getType($currentArg);
+ if (
+ $currentArgType instanceof ObjectType
+ && $currentArgType->isInstanceOf('Doctrine\\Common\\Collections\\ArrayCollection')
+ ->yes()
+ && $currentArg instanceof New_
+ && count($currentArg->args) === 1
+ && $currentArg->args[0] instanceof Arg
+ ) {
+ $currentArg = $currentArg->args[0]->value;
+ $isAlreadyAnArrayCollection = true;
+ }
+
+ if (! $currentArg instanceof Array_) {
+ return null;
+ }
+
+ $changedParameterType = false;
+ $parameters = [];
+ foreach ($currentArg->items as $index => $value) {
+ if (! $value instanceof ArrayItem) {
+ return null;
+ }
+
+ $arrayValueType = $this->nodeTypeResolver->getType($value->value);
+ if (! $arrayValueType instanceof ObjectType || ! $arrayValueType->isInstanceOf(
+ 'Doctrine\\ORM\\Query\\Parameter'
+ )->yes()) {
+ $newParameter = new New_(new FullyQualified('Doctrine\\ORM\\Query\\Parameter'));
+ $newParameter->args = [new Arg($value->key ?? new LNumber($index)), new Arg($value->value)];
+ $value->value = $newParameter;
+ $changedParameterType = true;
+ }
+
+ $parameters[] = new ArrayItem($value->value);
+ }
+
+ if ($changedParameterType === false && $isAlreadyAnArrayCollection) {
+ return null;
+ }
+
+ $newCollection = new New_(new FullyQualified('Doctrine\\Common\\Collections\\ArrayCollection'));
+ $newCollection->args = [new Arg(new Array_($parameters))];
+
+ $node->args = [new Arg($newCollection)];
+ return $node;
+ }
+}

src/NodeManipulator/ToOneRelationPropertyTypeResolver.php

@@ -6,6 +6,7 @@
 
 use Nette\Utils\Strings;
 use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\ConstFetch;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\ConstExpr\ConstExprTrueNode;
 use PHPStan\Type\MixedType;
@@ -163,6 +164,6 @@ private function isNullableJoinColumn(Property $property): bool
  self::JOIN_COLUMN,
  'nullable'
  );
- return $joinExpr instanceof Expr\ConstFetch && ! in_array('false', $joinExpr->name->getParts(), true);
+ return $joinExpr instanceof ConstFetch && ! in_array('false', $joinExpr->name->getParts(), true);
  }
 }