Merge pull request #8734 from VincentLanglet/fixMetadata

Fix metadata constructor inference by phpstan

Author: greg0ire

composer.json

@@ -52,6 +52,7 @@
     "autoload-dev": {
         "psr-4": {
             "Doctrine\\Tests\\": "tests/Doctrine/Tests",
+            "Doctrine\\StaticAnalysis\\": "tests/Doctrine/StaticAnalysis",
             "Doctrine\\Performance\\": "tests/Doctrine/Performance"
         }
     },

lib/Doctrine/ORM/Mapping/ClassMetadata.php

@@ -29,4 +29,16 @@
  */
 class ClassMetadata extends ClassMetadataInfo
 {
+    /**
+     * Repeating the ClassMetadataInfo constructor to infer correctly the template with PHPStan
+     *
+     * @see https://github.com/doctrine/orm/issues/8709
+     *
+     * @param string $entityName The name of the entity class the new instance is used for.
+     * @psalm-param class-string<T> $entityName
+     */
+    public function __construct($entityName, ?NamingStrategy $namingStrategy = null)
+    {
+        parent::__construct($entityName, $namingStrategy);
+    }
 }

phpstan.neon

@@ -4,7 +4,8 @@ includes:
 parameters:
     level: 5
     paths:
-        - %currentWorkingDirectory%/lib
+        - lib
+        - tests/Doctrine/StaticAnalysis
     earlyTerminatingMethodCalls:
         Doctrine\ORM\Query\Parser:
             - syntaxError

psalm.xml

@@ -9,6 +9,7 @@
 >
     <projectFiles>
         <directory name="lib/Doctrine/ORM" />
+        <directory name="tests/Doctrine/StaticAnalysis" />
         <ignoreFiles>
             <directory name="vendor" />
         </ignoreFiles>

tests/Doctrine/StaticAnalysis/Mapping/class-metadata-constructor.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Doctrine\StaticAnalysis\Mapping;
+
+use Doctrine\ORM\Mapping\ClassMetadata;
+
+/**
+ * @template T of object
+ */
+class MetadataGenerator
+{
+    /**
+     * @psalm-param class-string<T> $entityName
+     *
+     * @psalm-return ClassMetadata<T>
+     */
+    public function createMetadata(string $entityName): ClassMetadata
+    {
+        return new ClassMetadata($entityName);
+    }
+}