Skip to content

Use doctrine persistence names #38

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.

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

Closed
Closed
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
6 changes: 3 additions & 3 deletions extension.neon
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ services:
tags:
- phpstan.broker.dynamicMethodReturnTypeExtension
-
class: PHPStan\Type\Doctrine\EntityManagerFindDynamicReturnTypeExtension
class: PHPStan\Type\Doctrine\ObjectManagerFindDynamicReturnTypeExtension
tags:
- phpstan.broker.dynamicMethodReturnTypeExtension
-
class: PHPStan\Type\Doctrine\EntityManagerGetRepositoryDynamicReturnTypeExtension
class: PHPStan\Type\Doctrine\ObjectManagerGetRepositoryDynamicReturnTypeExtension
arguments:
repositoryClass: %doctrine.repositoryClass%
tags:
Expand All @@ -26,6 +26,6 @@ services:
tags:
- phpstan.broker.dynamicMethodReturnTypeExtension
-
class: PHPStan\Type\Doctrine\EntityRepositoryDynamicReturnTypeExtension
class: PHPStan\Type\Doctrine\ObjectRepositoryDynamicReturnTypeExtension
tags:
- phpstan.broker.dynamicMethodReturnTypeExtension
4 changes: 4 additions & 0 deletions phpstan.neon
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@ includes:
- vendor/phpstan/phpstan-strict-rules/rules.neon
- vendor/phpstan/phpstan-phpunit/extension.neon
- vendor/phpstan/phpstan-phpunit/rules.neon

parameters:
excludes_analyse:
- */tests/*/data/*
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;

class EntityManagerFindDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
class ObjectManagerFindDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
{

public function getClass(): string
Expand Down Expand Up @@ -43,12 +43,7 @@ public function getTypeFromMethodCall(
return $mixedType;
}

$type = new ObjectType($argType->getValue());
if ($methodReflection->getName() === 'find') {
$type = TypeCombinator::addNull($type);
}

return $type;
return TypeCombinator::addNull(new ObjectType($argType->getValue()));
Copy link

Choose a reason for hiding this comment

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

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
use PHPStan\Type\MixedType;
use PHPStan\Type\Type;

class EntityManagerGetRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
class ObjectManagerGetRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
{

/** @var string */
Expand Down Expand Up @@ -47,7 +47,7 @@ public function getTypeFromMethodCall(
return new MixedType();
}

return new EntityRepositoryType($argType->getValue(), $this->repositoryClass);
return new ObjectRepositoryType($argType->getValue(), $this->repositoryClass);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;

class EntityRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
class ObjectRepositoryDynamicReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
{

public function getClass(): string
{
return 'Doctrine\ORM\EntityRepository';
return 'Doctrine\Common\Persistence\ObjectRepository';
}

public function isMethodSupported(MethodReflection $methodReflection): bool
Expand All @@ -36,7 +36,7 @@ public function getTypeFromMethodCall(
): Type
{
$calledOnType = $scope->getType($methodCall->var);
if (!$calledOnType instanceof EntityRepositoryType) {
if (!$calledOnType instanceof ObjectRepositoryType) {
return new MixedType();
}
$methodName = $methodReflection->getName();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use PHPStan\Type\ObjectType;
use PHPStan\Type\VerbosityLevel;

class EntityRepositoryType extends ObjectType
class ObjectRepositoryType extends ObjectType
{

/** @var string */
Expand Down
37 changes: 37 additions & 0 deletions tests/DoctrineIntegration/ORM/EntityManagerIntegrationTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php declare(strict_types = 1);

namespace PHPStan\DoctrineIntegration\ORM;

use PHPStan\Testing\LevelsTestCase;

final class EntityManagerIntegrationTest extends LevelsTestCase
{

/**
* @return string[][]
*/
public function dataTopics(): array
{
return [
['entityManagerDynamicReturn'],
['entityRepositoryDynamicReturn'],
['entityManagerMergeReturn'],
];
}

public function getDataPath(): string
{
return __DIR__ . '/data';
}

public function getPhpStanExecutablePath(): string
{
return __DIR__ . '/../../../vendor/bin/phpstan';
}

public function getPhpStanConfigPath(): ?string
{
return __DIR__ . '/phpstan.neon';
}

}
72 changes: 72 additions & 0 deletions tests/DoctrineIntegration/ORM/data/entityManagerDynamicReturn.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
<?php declare(strict_types = 1);

namespace PHPStan\DoctrineIntegration\ORM\EntityManagerDynamicReturn;

use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping as ORM;
use RuntimeException;

class Example
{
/**
* @var EntityManagerInterface
*/
private $entityManager;

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

public function findDynamicType(): void
{
$test = $this->entityManager->find(MyEntity::class, 1);

if ($test === null) {
throw new RuntimeException('Sorry, but no...');
}

$test->doSomething();
}

public function getReferenceDynamicType(): void
{
$test = $this->entityManager->getReference(MyEntity::class, 1);

if ($test === null) {
throw new RuntimeException('Sorry, but no...');
}

$test->doSomething();
}

public function getPartialReferenceDynamicType(): void
{
$test = $this->entityManager->getPartialReference(MyEntity::class, 1);

if ($test === null) {
throw new RuntimeException('Sorry, but no...');
}

$test->doSomething();
}
}

/**
* @ORM\Entity()
*/
class MyEntity
{
/**
* @ORM\Id()
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*
* @var int
*/
private $id;

public function doSomething(): void
{
}
}
44 changes: 44 additions & 0 deletions tests/DoctrineIntegration/ORM/data/entityManagerMergeReturn.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?php declare(strict_types = 1);

namespace PHPStan\DoctrineIntegration\ORM\EntityManagerMergeReturn;

use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Mapping as ORM;

class Example
{
/**
* @var EntityManagerInterface
*/
private $entityManager;

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

public function merge(): void
{
$test = $this->entityManager->merge(new MyEntity());
$test->doSomething();
}
}

/**
* @ORM\Entity()
*/
class MyEntity
{
/**
* @ORM\Id()
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*
* @var int
*/
private $id;

public function doSomething(): void
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?php declare(strict_types = 1);

namespace PHPStan\DoctrineIntegration\ORM\EntityRepositoryDynamicReturn;

use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping as ORM;
use RuntimeException;

class Example
{
/**
* @var EntityRepository
*/
private $repository;

public function __construct(EntityManagerInterface $entityManager)
{
$this->repository = $entityManager->getRepository(MyEntity::class);
}

public function findDynamicType(): void
{
$test = $this->repository->find(1);

if ($test === null) {
throw new RuntimeException('Sorry, but no...');
}

$test->doSomething();
}

public function findOneByDynamicType(): void
{
$test = $this->repository->findOneBy(['blah' => 'testing']);

if ($test === null) {
throw new RuntimeException('Sorry, but no...');
}

$test->doSomething();
}

public function findAllDynamicType(): void
{
$items = $this->repository->findAll();

foreach ($items as $test) {
$test->doSomething();
}
}

public function findByDynamicType(): void
{
$items = $this->repository->findBy(['blah' => 'testing']);

foreach ($items as $test) {
$test->doSomething();
}
}
}

/**
* @ORM\Entity()
*/
class MyEntity
{
/**
* @ORM\Id()
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*
* @var int
*/
private $id;

public function doSomething(): void
{
}
}
2 changes: 2 additions & 0 deletions tests/DoctrineIntegration/ORM/phpstan.neon
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
includes:
- ../../../extension.neon