Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions src/Rules/Doctrine/RequireQueryBuilderOnRepositoryRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use PhpParser\Node;
use PhpParser\Node\Expr\MethodCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\ObjectType;
Expand Down Expand Up @@ -38,6 +39,11 @@ public function processNode(Node $node, Scope $scope): array
return [];
}

// only relevant inside repository classes, where $this->createQueryBuilder() is available as a safe swap
if (! $this->isInsideRepositoryClass($scope)) {
return [];
}

$callerType = $scope->getType($node->var);
if ($this->isValidRepositoryObjectType($callerType)) {
return [];
Expand All @@ -50,6 +56,20 @@ public function processNode(Node $node, Scope $scope): array
return [$identifierRuleError];
}

private function isInsideRepositoryClass(Scope $scope): bool
{
$classReflection = $scope->getClassReflection();
if (! $classReflection instanceof ClassReflection) {
return false;
}

if ($classReflection->isSubclassOf(DoctrineClass::ENTITY_REPOSITORY)) {
return true;
}

return $classReflection->isSubclassOf(DoctrineClass::DOCUMENT_REPOSITORY);
}

private function isValidRepositoryObjectType(Type $type): bool
{
if ($type instanceof UnionType) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Fixture;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Repository\DocumentRepository;

final class ReportOnDocumentManager
final class ReportOnDocumentManager extends DocumentRepository
{
public function process(DocumentManager $documentManager)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Fixture;

use Doctrine\ORM\EntityManagerInterface;
use Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Source\RandomEntity;
use Doctrine\ORM\EntityRepository;

final class ReportOnEntityManager
final class ReportOnEntityManager extends EntityRepository
{
public function process(EntityManagerInterface $entityManager)
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

namespace Symplify\PHPStanRules\Tests\Rules\Doctrine\RequireQueryBuilderOnRepositoryRule\Fixture;

use Doctrine\ORM\EntityManagerInterface;

final class SkipNonRepositoryClass
{
public function process(EntityManagerInterface $entityManager)
{
$queryBuilder = $entityManager->createQueryBuilder();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,14 @@ public static function provideData(): Iterator
yield [__DIR__ . '/Fixture/SkipCreateQueryBuilderOnRepository.php', []];
yield [__DIR__ . '/Fixture/SkipDocumentRepository.php', []];
yield [__DIR__ . '/Fixture/SkipConnection.php', []];
yield [__DIR__ . '/Fixture/SkipNonRepositoryClass.php', []];

yield [__DIR__ . '/Fixture/ReportOnEntityManager.php', [
[RequireQueryBuilderOnRepositoryRule::ERROR_MESSAGE, 14],
]];

yield [__DIR__ . '/Fixture/ReportOnDocumentManager.php', [
[RequireQueryBuilderOnRepositoryRule::ERROR_MESSAGE, 13],
[RequireQueryBuilderOnRepositoryRule::ERROR_MESSAGE, 14],
]];
}

Expand Down
Loading