This extension provides following features:
- DQL validation for parse errors, unknown entity classes and unknown persistent fields. QueryBuilder validation is also supported.
- Recognizes magic
findBy*
,findOneBy*
andcountBy*
methods on EntityRepository. - Validates entity fields in repository
findBy
,findBy*
,findOneBy
,findOneBy*
,count
andcountBy*
method calls. - Interprets
EntityRepository<MyEntity>
correctly in phpDocs for further type inference of methods called on the repository. - Provides correct return for
Doctrine\ORM\EntityManager::getRepository()
. - Provides correct return type for
Doctrine\ORM\EntityManager::find
,getReference
andgetPartialReference
whenFoo::class
entity class name is provided as the first argument - Adds missing
matching
method onDoctrine\Common\Collections\Collection
. This can be turned off by settingparameters.doctrine.allCollectionsSelectable
tofalse
. - Also supports Doctrine ODM.
- Analysis of discrepancies between entity column types and property field types.
To use this extension, require it in Composer:
composer require --dev phpstan/phpstan-doctrine
If you also install phpstan/extension-installer then you're all set!
Manual installation
If you don't want to use phpstan/extension-installer
, include extension.neon in your project's PHPStan config:
includes:
- vendor/phpstan/phpstan-doctrine/extension.neon
If you're interested in DQL/QueryBuilder validation, include also rules.neon
(you will also need to provide the objectManagerLoader
, see below):
includes:
- vendor/phpstan/phpstan-doctrine/rules.neon
If your repositories have a common base class, you can configure it in your phpstan.neon
and PHPStan will see additional methods you define in it:
parameters:
doctrine:
ormRepositoryClass: MyApp\Doctrine\BetterEntityRepository
odmRepositoryClass: MyApp\Doctrine\BetterDocumentRepository
You can opt in for more advanced analysis by providing the object manager from your own application. This will enable DQL validation:
parameters:
doctrine:
objectManagerLoader: tests/object-manager.php
Example for Symfony 4:
// tests/object-manager.php
use App\Kernel;
require __DIR__ . '/../config/bootstrap.php';
$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
$kernel->boot();
return $kernel->getContainer()->get('doctrine')->getManager();
Example for Symfony 5:
// tests/object-manager.php
use App\Kernel;
use Symfony\Component\Dotenv\Dotenv;
require __DIR__ . '/../vendor/autoload.php';
(new Dotenv())->bootEnv(__DIR__ . '/../.env');
$kernel = new Kernel($_SERVER['APP_ENV'], (bool) $_SERVER['APP_DEBUG']);
$kernel->boot();
return $kernel->getContainer()->get('doctrine')->getManager();
If your application uses custom Doctrine types, you can write your own type descriptors to analyse them properly.
Type descriptors implement the interface PHPStan\Type\Doctrine\Descriptors\DoctrineTypeDescriptor
which looks like this:
<?php
public function getType(): string;
public function getWritableToPropertyType(): Type;
public function getWritableToDatabaseType(): Type;
- The
getType()
method simply returns the class name of the custom type. - The
getWritableToPropertyType()
method returns the PHPStan type that the custom type will write into the entity's property field. Basically it is the return type of the custom type'sconvertToPHPValue()
method. - The
getWritableToDatabaseType()
method returns the PHPStan type that can be written from the entity's property field into the custom type. Again, basically it's the allowed type for the custom type'sconvertToDatabaseValue()
's first argument.
Generally, at least for most of Doctrine's native types, these last two methods will return the same type, but it is not always the case. One example would be the datetime
type, which allows you to set any \DateTimeInterface
into to property field, but will always contain the \DateTime
type when loaded from the database.
Type descriptors don't have to deal with nullable types, as these are transparently added/removed from the descriptor's types as needed. Therefore you don't have to return the union type of your custom type and NullType
from the descriptor's methods, even if your custom type allows null
.
If your custom type's convertToPHPValue()
and convertToDatabaseValue()
methods have proper typehints, you don't have to write your own descriptor for it. The PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor
can analyse the typehints and do the rest for you.
When you write a custom type descriptor, you have to let PHPStan know about it. Add something like this into your phpstan.neon
:
services:
-
class: MyCustomTypeDescriptor
tags: [phpstan.doctrine.typeDescriptor]
# in case you are using the ReflectionDescriptor
-
factory: PHPStan\Type\Doctrine\Descriptors\ReflectionDescriptor('MyApp\MyCustomTypeName')
tags: [phpstan.doctrine.typeDescriptor]