Merge pull request #374 from greg0ire/fix-types

Make types compatible with ORM/ODM drivers
doctrine · Jun 20, 2024 · b337726 · b337726
2 parents 53c572a + bce9a5e
commit b337726
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/src/Persistence/Mapping/Driver/FileDriver.php b/src/Persistence/Mapping/Driver/FileDriver.php
@@ -21,15 +21,17 @@
  * classes on demand. This requires the user to adhere to the convention of 1 mapping
  * file per class and the file names of the mapping files must correspond to the full
  * class name, including namespace, with the namespace delimiters '\', replaced by dots '.'.
+ *
+ * @template T
  */
 abstract class FileDriver implements MappingDriver
 {
     /** @var FileLocator */
     protected $locator;
 
     /**
-     * @var ClassMetadata[]|null
-     * @psalm-var array<class-string, ClassMetadata<object>>|null
+     * @var mixed[]|null
+     * @psalm-var array<class-string, T>|null
      */
     protected $classCache;
 
@@ -78,8 +80,7 @@ public function getGlobalBasename()
      *
      * @psalm-param class-string $className
      *
-     * @return ClassMetadata The element of schema meta data.
-     * @psalm-return ClassMetadata<object>
+     * @return T The element of schema meta data.
      *
      * @throws MappingException
      */
@@ -154,8 +155,8 @@ public function getAllClassNames()
      *
      * @param string $file The mapping file to load.
      *
-     * @return ClassMetadata[]
-     * @psalm-return array<class-string, ClassMetadata<object>>
+     * @return mixed[]
+     * @psalm-return array<class-string, T>
      */
     abstract protected function loadMappingFile(string $file);
 

diff --git a/src/Persistence/Mapping/Driver/PHPDriver.php b/src/Persistence/Mapping/Driver/PHPDriver.php
@@ -9,6 +9,8 @@
 /**
  * The PHPDriver includes php files which just populate ClassMetadataInfo
  * instances with plain PHP code.
+ *
+ * @template-extends FileDriver<ClassMetadata<object>>
  */
 class PHPDriver extends FileDriver
 {

diff --git a/tests/Persistence/Mapping/FileDriverTest.php b/tests/Persistence/Mapping/FileDriverTest.php
@@ -197,6 +197,7 @@ private function createTestFileDriver($locator, ?string $fileExtension = null):
     }
 }
 
+/** @template-extends FileDriver<TestClassMetadata<object>> */
 class TestFileDriver extends FileDriver
 {
     /** @var ClassMetadata<object> */

diff --git a/tests/Persistence/Mapping/Fixtures/TestClassMetadata.php b/tests/Persistence/Mapping/Fixtures/TestClassMetadata.php
@@ -9,7 +9,7 @@
 use ReflectionClass;
 
 /**
- * @template T of object
+ * @template-covariant T of object
  * @template-implements ClassMetadata<T>
  */
 final class TestClassMetadata implements ClassMetadata