Add generic types (#2287)

doctrine · Feb 9, 2021 · fe3913c · fe3913c
1 parent 06a7f2f
commit fe3913c
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 1 deletion.
diff --git a/lib/Doctrine/ODM/MongoDB/DocumentManager.php b/lib/Doctrine/ODM/MongoDB/DocumentManager.php
@@ -564,6 +564,11 @@ public function unlock(object $document): void
      * @param string $documentName The name of the Document.
      *
      * @return ObjectRepository  The repository.
+     *
+     * @template T of object
+     * @psalm-param class-string<T> $documentName
+     *
+     * @psalm-return ObjectRepository<T>
      */
     public function getRepository($documentName)
     {
@@ -657,6 +662,11 @@ public function getPartialReference(string $documentName, $identifier): object
      * @param mixed  $id
      * @param int    $lockMode
      * @param int    $lockVersion
+     *
+     * @template T of object
+     * @psalm-param class-string<T> $className
+     *
+     * @psalm-return T|null
      */
     public function find($className, $id, $lockMode = LockMode::NONE, $lockVersion = null): ?object
     {

diff --git a/lib/Doctrine/ODM/MongoDB/Persisters/DocumentPersister.php b/lib/Doctrine/ODM/MongoDB/Persisters/DocumentPersister.php
@@ -66,6 +66,8 @@
  * The DocumentPersister is responsible for persisting documents.
  *
  * @internal
+ *
+ * @template T of object
  */
 final class DocumentPersister
 {
@@ -466,6 +468,10 @@ public function refresh(object $document): void
      *
      * @todo Check identity map? loadById method? Try to guess whether
      *     $criteria is the id?
+     *
+     * @psalm-param T|null $document
+     *
+     * @psalm-return T|null
      */
     public function load($criteria, ?object $document = null, array $hints = [], int $lockMode = 0, ?array $sort = null): ?object
     {
@@ -620,6 +626,10 @@ public function unlock(object $document): void
      * @param array  $hints    Hints for document creation.
      *
      * @return object The filled and managed document object.
+     *
+     * @psalm-param T|null $document
+     *
+     * @psalm-return T
      */
     private function createDocument(array $result, ?object $document = null, array $hints = []): object
     {

diff --git a/lib/Doctrine/ODM/MongoDB/Repository/DocumentRepository.php b/lib/Doctrine/ODM/MongoDB/Repository/DocumentRepository.php
@@ -30,10 +30,17 @@
  *
  * This class is designed for inheritance and users can subclass this class to
  * write their own repositories with business-specific methods to locate documents.
+ *
+ * @template T of object
+ * @template-implements Selectable<int,T>
+ * @template-implements ObjectRepository<T>
  */
 class DocumentRepository implements ObjectRepository, Selectable
 {
-    /** @var string */
+    /**
+     * @var string
+     * @psalm-var class-string<T>
+     */
     protected $documentName;
 
     /** @var DocumentManager */
@@ -227,6 +234,9 @@ public function matching(Criteria $criteria): ArrayCollection
         return new ArrayCollection($iterator->toArray());
     }
 
+    /**
+     * @psalm-return DocumentPersister<T>
+     */
     protected function getDocumentPersister(): DocumentPersister
     {
         return $this->uow->getDocumentPersister($this->documentName);

diff --git a/lib/Doctrine/ODM/MongoDB/Repository/GridFSRepository.php b/lib/Doctrine/ODM/MongoDB/Repository/GridFSRepository.php
@@ -6,6 +6,10 @@
 
 use Doctrine\Persistence\ObjectRepository;
 
+/**
+ * @template T of object
+ * @template-extends ObjectRepository<T>
+ */
 interface GridFSRepository extends ObjectRepository
 {
     /**

diff --git a/lib/Doctrine/ODM/MongoDB/Repository/RepositoryFactory.php b/lib/Doctrine/ODM/MongoDB/Repository/RepositoryFactory.php
@@ -14,6 +14,10 @@ interface RepositoryFactory
 {
     /**
      * Gets the repository for a document class.
+     *
+     * @template T of object
+     * @psalm-param class-string<T> $documentName
+     * @psalm-return ObjectRepository<T>
      */
     public function getRepository(DocumentManager $documentManager, string $documentName): ObjectRepository;
 }
diff --git a/lib/Doctrine/ODM/MongoDB/Repository/ViewRepository.php b/lib/Doctrine/ODM/MongoDB/Repository/ViewRepository.php
@@ -7,6 +7,10 @@
 use Doctrine\ODM\MongoDB\Aggregation\Builder;
 use Doctrine\Persistence\ObjectRepository;
 
+/**
+ * @template T of object
+ * @template-extends ObjectRepository<T>
+ */
 interface ViewRepository extends ObjectRepository
 {
     /**

diff --git a/lib/Doctrine/ODM/MongoDB/UnitOfWork.php b/lib/Doctrine/ODM/MongoDB/UnitOfWork.php
@@ -324,6 +324,10 @@ public function getParentAssociation(object $document): ?array
 
     /**
      * Get the document persister instance for the given document name
+     *
+     * @template T of object
+     * @psalm-param class-string<T> $documentName
+     * @psalm-return Persisters\DocumentPersister<T>
      */
     public function getDocumentPersister(string $documentName): Persisters\DocumentPersister
     {
@@ -2611,6 +2615,11 @@ public function getClassNameForAssociation(array $mapping, $data): string
 
     /**
      * Creates a document. Used for reconstitution of documents during hydration.
+     *
+     * @template T of object
+     * @psalm-param class-string<T> $className
+     * @psalm-param T|null $document
+     * @psalm-return T
      */
     public function getOrCreateDocument(string $className, array $data, array &$hints = [], ?object $document = null): object
     {
@@ -2633,6 +2642,7 @@ public function getOrCreateDocument(string $className, array $data, array &$hint
         }
 
         if (! empty($hints[Query::HINT_READ_ONLY])) {
+            /** @psalm-var T $document */
             $document = $class->newInstance();
             $this->hydratorFactory->hydrate($document, $data, $hints);