Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

QueryBuilderGetQueryDynamicReturnTypeExtension: handle regular set usages #498

Merged
merged 1 commit into from
Nov 21, 2023
Merged

QueryBuilderGetQueryDynamicReturnTypeExtension: handle regular set usages #498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Type/Doctrine/ArgumentsProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ class ArgumentsProcessor

/**
* @param Arg[] $methodCallArgs
* @return mixed[]
* @return list<mixed>
* @throws DynamicQueryBuilderArgumentException
*/
public function processArgs(
Expand Down
13 changes: 13 additions & 0 deletions src/Type/Doctrine/QueryBuilder/QueryBuilderGetQueryDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use Throwable;
use function array_slice;
use function count;
use function in_array;
use function method_exists;
Expand Down Expand Up @@ -152,6 +153,18 @@ public function getTypeFromMethodCall(
continue;
}

if ($lowerMethodName === 'set') {
try {
$args = $this->argumentsProcessor->processArgs($scope, $methodName, array_slice($calledMethodCall->getArgs(), 0, 1));
} catch (DynamicQueryBuilderArgumentException $e) {
return $defaultReturnType;
}
if (count($args) === 1) {
$queryBuilder->set($args[0], $args[0]);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This branch does not seem to be tested

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is. This is the main thing that enables the whole thing. Maybe you missed array_slice above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea here is to drop second argument (which is typically an expression) and do "dummy update" alias.field = alias.field instead.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh alright, I know less and less about this extension every day :D

continue;
}
}

if (!method_exists($queryBuilder, $methodName)) {
continue;
}
Expand Down
10 changes: 10 additions & 0 deletions tests/Rules/Doctrine/ORM/QueryBuilderDqlRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,16 @@ public function testAndOrVariants(): void
$this->analyse([__DIR__ . '/data/query-builder-dql-and-or-variants.php'], []);
}

public function testUpdateIssue(): void
{
$this->analyse([__DIR__ . '/data/query-builder-dql-update.php'], [
[
'Could not analyse QueryBuilder with dynamic arguments.',
31,
],
]);
}

public function testBranchingPerformance(): void
{
$this->analyse([__DIR__ . '/data/query-builder-branches-performance.php'], [
Expand Down
40 changes: 40 additions & 0 deletions tests/Rules/Doctrine/ORM/data/query-builder-dql-update.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php declare(strict_types = 1);

namespace PHPStan\Rules\Doctrine\ORM;

use Doctrine\ORM\EntityManager;

class TestUpdateQueryBuilder
{

/** @var EntityManager */
private $entityManager;

public function __construct(EntityManager $entityManager)
{
$this->entityManager = $entityManager;
}

public function nonDynamicSet(int $int, string $title): void
{
$this->entityManager->createQueryBuilder()
->update(MyEntity::class, 'e')
->set('e.title', $title)
->andWhere('e.id = :int')
->setParameter('int', $int)
->getQuery()
->execute();
}

public function dynamicSet(int $int, string $field, string $title): void
{
$this->entityManager->createQueryBuilder()
->update(MyEntity::class, 'e')
->set('e.' . $field, $title)
->andWhere('e.id = :int')
->setParameter('int', $int)
->getQuery()
->execute();
}

}