Improve phpdoc return type

doctrine · May 22, 2021 · a226867 · a226867
1 parent 0a32d29
commit a226867
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/lib/Doctrine/ODM/MongoDB/DocumentManager.php b/lib/Doctrine/ODM/MongoDB/DocumentManager.php
@@ -16,7 +16,9 @@
 use Doctrine\ODM\MongoDB\Proxy\Resolver\ProxyManagerClassNameResolver;
 use Doctrine\ODM\MongoDB\Query\FilterCollection;
 use Doctrine\ODM\MongoDB\Repository\DocumentRepository;
+use Doctrine\ODM\MongoDB\Repository\GridFSRepository;
 use Doctrine\ODM\MongoDB\Repository\RepositoryFactory;
+use Doctrine\ODM\MongoDB\Repository\ViewRepository;
 use Doctrine\Persistence\ObjectManager;
 use Doctrine\Persistence\ObjectRepository;
 use InvalidArgumentException;
@@ -563,8 +565,8 @@ public function unlock(object $document): void
      * @param string $documentName The name of the Document.
      * @psalm-param class-string<T> $documentName
      *
-     * @return ObjectRepository  The repository.
-     * @psalm-return ObjectRepository<T>
+     * @return ObjectRepository|DocumentRepository|GridFSRepository|ViewRepository  The repository.
+     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
      *
      * @template T of object
      */

diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadataFactory.php b/lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadataFactory.php
@@ -35,6 +35,10 @@
  * to a document database.
  *
  * @internal
+ *
+ * @method ClassMetadata[] getAllMetadata()
+ * @method ClassMetadata[] getLoadedMetadata()
+ * @method ClassMetadata getMetadataFor($className)
  */
 final class ClassMetadataFactory extends AbstractClassMetadataFactory
 {

diff --git a/lib/Doctrine/ODM/MongoDB/Repository/AbstractRepositoryFactory.php b/lib/Doctrine/ODM/MongoDB/Repository/AbstractRepositoryFactory.php
@@ -26,6 +26,13 @@ abstract class AbstractRepositoryFactory implements RepositoryFactory
      */
     private $repositoryList = [];
 
+    /**
+     * @psalm-param class-string<T> $documentName
+     *
+     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
+     *
+     * @template T of object
+     */
     public function getRepository(DocumentManager $documentManager, string $documentName): ObjectRepository
     {
         $metadata = $documentManager->getClassMetadata($documentName);
@@ -45,7 +52,12 @@ public function getRepository(DocumentManager $documentManager, string $document
     /**
      * Create a new repository instance for a document class.
      *
-     * @return ObjectRepository|GridFSRepository|ViewRepository
+     * @psalm-param class-string<T> $documentName
+     *
+     * @return ObjectRepository|DocumentRepository|GridFSRepository|ViewRepository
+     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
+     *
+     * @template T of object
      */
     protected function createRepository(DocumentManager $documentManager, string $documentName): ObjectRepository
     {