Adds generics annotations

doctrine · May 1, 2020 · 31ff9dd · 31ff9dd
1 parent fdaaa50
commit 31ff9dd
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/lib/Doctrine/Persistence/ManagerRegistry.php b/lib/Doctrine/Persistence/ManagerRegistry.php
@@ -76,6 +76,10 @@ public function getManagerNames();
      * @param string $persistentManagerName The object manager name (null for the default one).
      *
      * @return ObjectRepository
+     *
+     * @template T
+     * @psalm-param class-string<T> $persistentObject
+     * @psalm-return ObjectRepository<T>
      */
     public function getRepository(
         string $persistentObject,

diff --git a/lib/Doctrine/Persistence/ObjectManager.php b/lib/Doctrine/Persistence/ObjectManager.php
@@ -21,6 +21,10 @@ interface ObjectManager
      * @param mixed  $id        The identity of the object to find.
      *
      * @return object|null The found object.
+     *
+     * @template T
+     * @psalm-param class-string<T> $className
+     * @psalm-return T|null
      */
     public function find(string $className, $id) : ?object;
 
@@ -95,6 +99,10 @@ public function flush() : void;
 
     /**
      * Gets the repository for a class.
+     *
+     * @template T
+     * @psalm-param class-string<T> $className
+     * @psalm-return ObjectRepository<T>
      */
     public function getRepository(string $className) : ObjectRepository;
 

diff --git a/lib/Doctrine/Persistence/ObjectRepository.php b/lib/Doctrine/Persistence/ObjectRepository.php
@@ -8,6 +8,8 @@
 
 /**
  * Contract for a Doctrine persistence layer ObjectRepository class to implement.
+ *
+ * @template T
  */
 interface ObjectRepository
 {
@@ -17,13 +19,17 @@ interface ObjectRepository
      * @param mixed $id The identifier.
      *
      * @return object|null The object.
+     *
+     * @psalm-return T|null
      */
     public function find($id) : ?object;
 
     /**
      * Finds all objects in the repository.
      *
      * @return array<int, object> The objects.
+     *
+     * @psalm-return T[]
      */
     public function findAll() : array;
 
@@ -40,6 +46,8 @@ public function findAll() : array;
      * @return array<int, object> The objects.
      *
      * @throws UnexpectedValueException
+     *
+     * @psalm-return T[]
      */
     public function findBy(
         array $criteria,
@@ -54,6 +62,8 @@ public function findBy(
      * @param array<string, mixed> $criteria The criteria.
      *
      * @return object|null The object.
+     *
+     * @psalm-return T|null
      */
     public function findOneBy(array $criteria) : ?object;