feat: improve phpstan level 6 and resolve all errors (#2157)

shakaran · web-flow · commit 1865171ff37d · 2025-12-04T19:25:18.000+01:00
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,10 +1,8 @@
 parameters:
-   level: 5
+   level: 6
+   reportUnmatchedIgnoredErrors: true
    paths:
       - config
       - src
       - tests
    ignoreErrors:
-    # phpstan has no array shape intersection support https://github.com/phpstan/phpstan/issues/12414
-    - message: '#unresolvable type.#'
-      path: src/DataCollector/DoctrineDataCollector.php
diff --git a/src/DataCollector/DoctrineDataCollector.php b/src/DataCollector/DoctrineDataCollector.php
@@ -25,14 +25,6 @@
 use function usort;
 
 /**
- * @phpstan-type QueryType = array{
- *    executionMS: float,
- *    explainable: bool,
- *    sql: string,
- *    params: ?array<array-key, mixed>,
- *    runnable: bool,
- *    types: ?array<array-key, Type|int|string|null>,
- * }
  * @phpstan-type DataType = array{
  *    caches: array{
  *       enabled: bool,
@@ -44,7 +36,14 @@
  *    entities: array<string, array<class-string, array{class: class-string, file: false|string, line: false|int}>>,
  *    errors: array<string, array<class-string, list<string>>>,
  *    managers: list<string>,
- *    queries: array<string, list<QueryType>>,
+ *    queries: array<string, list<array{
+ *       executionMS: float,
+ *       explainable: bool,
+ *       sql: string,
+ *       params: ?array<array-key, mixed>,
+ *       runnable: bool,
+ *       types: ?array<array-key, Type|int|string|null>
+ *    }>>,
  *    entityCounts: array<string, array<class-string, int>>
  * }
  * @psalm-property DataType $data
@@ -57,8 +56,17 @@ class DoctrineDataCollector extends BaseCollector
 
     /**
      * @var mixed[][]|null
-     * @phpstan-var ?array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
-     * @phpstan-ignore property.unusedType
+     * @phpstan-var ?array<string, list<array{
+     *    executionMS: float,
+     *    explainable: bool,
+     *    sql: string,
+     *    params: ?array<array-key, mixed>,
+     *    runnable: bool,
+     *    types: ?array<array-key, Type|int|string|null>,
+     *    count: int,
+     *    index: int,
+     *    executionPercent?: float
+     * }>>
      */
     private array|null $groupedQueries = null;
 
@@ -261,7 +269,17 @@ public function getManagedEntityCountByClass(): array
 
     /**
      * @return string[][]
-     * @phpstan-return array<string, list<QueryType&array{count: int, index: int, executionPercent?: float}>>
+     * @phpstan-return array<string, list<array{
+     *    executionMS: float,
+     *    explainable: bool,
+     *    sql: string,
+     *    params: ?array<array-key, mixed>,
+     *    runnable: bool,
+     *    types: ?array<array-key, Type|int|string|null>,
+     *    count: int,
+     *    index: int,
+     *    executionPercent?: float
+     * }>>
      */
     public function getGroupedQueries(): array
     {
diff --git a/src/Dbal/RegexSchemaAssetFilter.php b/src/Dbal/RegexSchemaAssetFilter.php
@@ -5,6 +5,7 @@
 namespace Doctrine\Bundle\DoctrineBundle\Dbal;
 
 use Doctrine\DBAL\Schema\AbstractAsset;
+use Doctrine\DBAL\Schema\Name;
 
 use function preg_match;
 
@@ -15,6 +16,7 @@ public function __construct(
     ) {
     }
 
+    /** @param string|AbstractAsset<Name> $assetName */
     public function __invoke(string|AbstractAsset $assetName): bool
     {
         if ($assetName instanceof AbstractAsset) {
diff --git a/src/Dbal/SchemaAssetsFilterManager.php b/src/Dbal/SchemaAssetsFilterManager.php
@@ -5,6 +5,7 @@
 namespace Doctrine\Bundle\DoctrineBundle\Dbal;
 
 use Doctrine\DBAL\Schema\AbstractAsset;
+use Doctrine\DBAL\Schema\Name;
 
 /**
  * Manages schema filters passed to Connection::setSchemaAssetsFilter()
@@ -17,6 +18,7 @@ public function __construct(
     ) {
     }
 
+    /** @param string|AbstractAsset<Name> $assetName */
     public function __invoke(string|AbstractAsset $assetName): bool
     {
         foreach ($this->schemaAssetFilters as $schemaAssetFilter) {
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -12,6 +12,7 @@
 use RuntimeException;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
 use Symfony\Component\Config\Definition\Builder\NodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeParentInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\DependencyInjection\Exception\LogicException;
@@ -48,6 +49,7 @@ public function __construct(private bool $debug)
     {
     }
 
+    /** @return TreeBuilder<'array'> */
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('doctrine');
@@ -61,6 +63,8 @@ public function getConfigTreeBuilder(): TreeBuilder
 
     /**
      * Add DBAL section to configuration tree
+     *
+     * @param ArrayNodeDefinition<TreeBuilder<'array'>> $node
      */
     private function addDbalSection(ArrayNodeDefinition $node): void
     {
@@ -153,6 +157,8 @@ private function addDbalSection(ArrayNodeDefinition $node): void
 
     /**
      * Return the dbal connections node
+     *
+     * @return ArrayNodeDefinition<TreeBuilder<'array'>>
      */
     private function getDbalConnectionsNode(): ArrayNodeDefinition
     {
@@ -226,7 +232,11 @@ private function getDbalConnectionsNode(): ArrayNodeDefinition
      * Adds config keys related to params processed by the DBAL drivers
      *
      * These keys are available for replica configurations too.
-     */
+     *
+     * @param ArrayNodeDefinition<TP> $node
+     *
+     * @template TP of NodeParentInterface|null
+     **/
     private function configureDbalDriverNode(ArrayNodeDefinition $node): void
     {
         $node
@@ -354,6 +364,8 @@ private function configureDbalDriverNode(ArrayNodeDefinition $node): void
 
     /**
      * Add the ORM section to configuration tree
+     *
+     * @param ArrayNodeDefinition<TreeBuilder<'array'>> $node
      */
     private function addOrmSection(ArrayNodeDefinition $node): void
     {
@@ -449,6 +461,8 @@ private function addOrmSection(ArrayNodeDefinition $node): void
 
     /**
      * Return ORM target entity resolver node
+     *
+     * @return ArrayNodeDefinition<TreeBuilder<'array'>>
      */
     private function getOrmTargetEntityResolverNode(): NodeDefinition
     {
@@ -466,6 +480,8 @@ private function getOrmTargetEntityResolverNode(): NodeDefinition
 
     /**
      * Return ORM entity listener node
+     *
+     * @return ArrayNodeDefinition<TreeBuilder<'array'>>
      */
     private function getOrmEntityListenersNode(): NodeDefinition
     {
@@ -548,6 +564,8 @@ private function getOrmEntityListenersNode(): NodeDefinition
 
     /**
      * Return ORM entity manager node
+     *
+     * @return ArrayNodeDefinition<TreeBuilder<'array'>>
      */
     private function getOrmEntityManagersNode(): ArrayNodeDefinition
     {
@@ -722,6 +740,8 @@ private function getOrmEntityManagersNode(): ArrayNodeDefinition
 
     /**
      * Return an ORM cache driver node for a given entity manager
+     *
+     * @return ArrayNodeDefinition<TreeBuilder<'array'>>
      */
     private function getOrmCacheDriverNode(string $name): ArrayNodeDefinition
     {
diff --git a/src/DependencyInjection/DoctrineExtension.php b/src/DependencyInjection/DoctrineExtension.php
@@ -218,7 +218,10 @@ private function setMappingDriverConfig(array $mappingConfig, string $mappingNam
      *
      * Returns false when autodetection failed, an array of the completed information otherwise.
      *
-     * @param array<string, mixed> $bundleConfig
+     * @param array<string, mixed>    $bundleConfig
+     * @param ReflectionClass<object> $bundle
+     *
+     * @return array<string, mixed>|false
      */
     private function getMappingDriverBundleConfigDefaults(
         array $bundleConfig,
@@ -1368,6 +1371,8 @@ public function getNamespace(): string
 
     /**
      * {@inheritDoc}
+     *
+     * @param array<string, mixed> $config
      */
     public function getConfiguration(array $config, ContainerBuilder $container): Configuration
     {
diff --git a/src/Mapping/ClassMetadataFactory.php b/src/Mapping/ClassMetadataFactory.php
@@ -14,6 +14,9 @@ class ClassMetadataFactory extends BaseClassMetadataFactory
 {
     /**
      * {@inheritDoc}
+     *
+     * @param ClassMetadata<object> $class
+     * @param ClassMetadata<object> $parent
      */
     protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents): void
     {
diff --git a/src/Mapping/ContainerEntityListenerResolver.php b/src/Mapping/ContainerEntityListenerResolver.php
@@ -46,6 +46,8 @@ public function clear($className = null): void
 
     /**
      * {@inheritDoc}
+     *
+     * @param mixed $object
      */
     public function register($object): void
     {
@@ -60,8 +62,11 @@ public function register($object): void
 
     /**
      * {@inheritDoc}
+     *
+     * @param string $className
+     * @param string $serviceId
      */
-    public function registerService($className, $serviceId)
+    public function registerService($className, $serviceId): void
     {
         $this->serviceIds[$this->normalizeClassName($className)] = $serviceId;
     }
diff --git a/src/Mapping/EntityListenerServiceResolver.php b/src/Mapping/EntityListenerServiceResolver.php
@@ -13,5 +13,5 @@ interface EntityListenerServiceResolver extends EntityListenerResolver
      * @param string $serviceId
      */
     // phpcs:ignore
-    public function registerService($className, $serviceId);
+    public function registerService($className, $serviceId): void;
 }
diff --git a/src/Repository/ContainerRepositoryFactory.php b/src/Repository/ContainerRepositoryFactory.php
@@ -26,7 +26,7 @@
  */
 final class ContainerRepositoryFactory implements RepositoryFactory
 {
-    /** @var array<string, ObjectRepository> */
+    /** @var array<string, ObjectRepository<object>> */
     private array $managedRepositories = [];
 
     /** @param ContainerInterface $container A service locator containing the repositories */
diff --git a/tests/DataCollector/DoctrineDataCollectorTest.php b/tests/DataCollector/DoctrineDataCollectorTest.php
@@ -136,6 +136,7 @@ public function testGetGroupedQueries(): void
         $this->assertSame(1, $groupedQueries['default'][1]['count']);
     }
 
+    /** @return ClassMetadata<object> */
     private function createEntityMetadata(string $entityFQCN): ClassMetadata
     {
         $metadata            = new ClassMetadata($entityFQCN);
diff --git a/tests/DependencyInjection/DoctrineExtensionTest.php b/tests/DependencyInjection/DoctrineExtensionTest.php
@@ -501,6 +501,7 @@ public function testSingleEntityManagerWithDefaultConfiguration(): void
         ]);
     }
 
+    /** @param array<mixed>|null $ormConfiguration */
     #[TestWith([[]])]
     #[TestWith([null])]
     public function testSingleEntityManagerWithEmptyConfiguration(array|null $ormConfiguration): void
diff --git a/tests/DependencyInjection/Fixtures/Bundles/RepositoryServiceBundle/Repository/TestCustomServiceRepoRepository.php b/tests/DependencyInjection/Fixtures/Bundles/RepositoryServiceBundle/Repository/TestCustomServiceRepoRepository.php
@@ -8,6 +8,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use Fixtures\Bundles\RepositoryServiceBundle\Entity\TestCustomServiceRepoEntity;
 
+/** @extends ServiceEntityRepository<TestCustomServiceRepoEntity> */
 class TestCustomServiceRepoRepository extends ServiceEntityRepository
 {
     public function __construct(ManagerRegistry $registry)
diff --git a/tests/DependencyInjection/Fixtures/CustomEntityListenerServiceResolver.php b/tests/DependencyInjection/Fixtures/CustomEntityListenerServiceResolver.php
@@ -31,6 +31,8 @@ public function resolve($className): object
 
     /**
      * {@inheritDoc}
+     *
+     * @param object $object
      */
     public function register($object): void
     {
diff --git a/tests/DependencyInjection/Fixtures/CustomIdGenerator.php b/tests/DependencyInjection/Fixtures/CustomIdGenerator.php
@@ -11,6 +11,8 @@ class CustomIdGenerator extends AbstractIdGenerator
 {
     /**
      * {@inheritDoc}
+     *
+     * @param object $entity
      */
     public function generateId(EntityManagerInterface $em, $entity): int
     {
diff --git a/tests/DependencyInjection/TestFilter.php b/tests/DependencyInjection/TestFilter.php
@@ -13,6 +13,8 @@ class TestFilter extends SQLFilter
      * Gets the SQL query part to add to a query.
      *
      * {@inheritDoc}
+     *
+     * @param string $targetTableAlias
      */
     public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias): string
     {

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`namespace Doctrine\Bundle\DoctrineBundle\Dbal;`
`6`	`6`
`7`	`7`	`use Doctrine\DBAL\Schema\AbstractAsset;`
	`8`	`+use Doctrine\DBAL\Schema\Name;`
`8`	`9`
`9`	`10`	`use function preg_match;`
`10`	`11`
`@@ -15,6 +16,7 @@ public function __construct(`
`15`	`16`	`) {`
`16`	`17`	`}`
`17`	`18`
	`19`	`+ /** @param string\|AbstractAsset<Name> $assetName */`
`18`	`20`	`public function __invoke(string\|AbstractAsset $assetName): bool`
`19`	`21`	`{`
`20`	`22`	`if ($assetName instanceof AbstractAsset) {`
Original file line number	Diff line number	Diff line change
`@@ -218,7 +218,10 @@ private function setMappingDriverConfig(array $mappingConfig, string $mappingNam`
`218`	`218`	`*`
`219`	`219`	`* Returns false when autodetection failed, an array of the completed information otherwise.`
`220`	`220`	`*`
`221`		`- * @param array<string, mixed> $bundleConfig`
	`221`	`+ * @param array<string, mixed> $bundleConfig`
	`222`	`+ * @param ReflectionClass<object> $bundle`
	`223`	`+ *`
	`224`	`+ * @return array<string, mixed>\|false`
`222`	`225`	`*/`
`223`	`226`	`private function getMappingDriverBundleConfigDefaults(`
`224`	`227`	`array $bundleConfig,`
`@@ -1368,6 +1371,8 @@ public function getNamespace(): string`
`1368`	`1371`
`1369`	`1372`	`/**`
`1370`	`1373`	`* {@inheritDoc}`
	`1374`	`+ *`
	`1375`	`+ * @param array<string, mixed> $config`
`1371`	`1376`	`*/`
`1372`	`1377`	`public function getConfiguration(array $config, ContainerBuilder $container): Configuration`
`1373`	`1378`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,9 @@ class ClassMetadataFactory extends BaseClassMetadataFactory`
`14`	`14`	`{`
`15`	`15`	`/**`
`16`	`16`	`* {@inheritDoc}`
	`17`	`+ *`
	`18`	`+ * @param ClassMetadata<object> $class`
	`19`	`+ * @param ClassMetadata<object> $parent`
`17`	`20`	`*/`
`18`	`21`	`protected function doLoadMetadata($class, $parent, $rootEntityFound, array $nonSuperclassParents): void`
`19`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,8 @@ public function clear($className = null): void`
`46`	`46`
`47`	`47`	`/**`
`48`	`48`	`* {@inheritDoc}`
	`49`	`+ *`
	`50`	`+ * @param mixed $object`
`49`	`51`	`*/`
`50`	`52`	`public function register($object): void`
`51`	`53`	`{`
`@@ -60,8 +62,11 @@ public function register($object): void`
`60`	`62`
`61`	`63`	`/**`
`62`	`64`	`* {@inheritDoc}`
	`65`	`+ *`
	`66`	`+ * @param string $className`
	`67`	`+ * @param string $serviceId`
`63`	`68`	`*/`
`64`		`- public function registerService($className, $serviceId)`
	`69`	`+ public function registerService($className, $serviceId): void`
`65`	`70`	`{`
`66`	`71`	`$this->serviceIds[$this->normalizeClassName($className)] = $serviceId;`
`67`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@ interface EntityListenerServiceResolver extends EntityListenerResolver`
`13`	`13`	`* @param string $serviceId`
`14`	`14`	`*/`
`15`	`15`	`// phpcs:ignore`
`16`		`- public function registerService($className, $serviceId);`
	`16`	`+ public function registerService($className, $serviceId): void;`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`*/`
`27`	`27`	`final class ContainerRepositoryFactory implements RepositoryFactory`
`28`	`28`	`{`
`29`		`- /** @var array<string, ObjectRepository> */`
	`29`	`+ /** @var array<string, ObjectRepository<object>> */`
`30`	`30`	`private array $managedRepositories = [];`
`31`	`31`
`32`	`32`	`/** @param ContainerInterface $container A service locator containing the repositories */`