+ rebase on newer 2.3.x

Vincent Le Henaff · vincent-le-henaff · commit 372a27b9f56c · 2022-11-04T11:13:04.000+01:00
diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Expr.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Expr.php
@@ -19,6 +19,7 @@
 use function is_array;
 use function is_string;
 use function substr;
+use function trigger_deprecation;
 
 /**
  * Fluent interface for building aggregation pipelines.
diff --git a/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/MatchStage.php b/lib/Doctrine/ODM/MongoDB/Aggregation/Stage/MatchStage.php
@@ -11,6 +11,7 @@
 use GeoJson\Geometry\Geometry;
 
 use function func_get_args;
+use function trigger_deprecation;
 
 /**
  * Fluent interface for building aggregation pipelines.
@@ -194,10 +195,10 @@ public function expr(): Expr
     /**
      * Specify $expr criteria for the current field.
      *
-     * @param array|Aggregation\Expr $expression
      * @see https://docs.mongodb.com/manual/reference/operator/query/expr/
-     *
      * @see Expr::aggregationExpression()
+     *
+     * @param array|Aggregation\Expr $expression
      */
     public function aggregationExpression($expression): self
     {
diff --git a/lib/Doctrine/ODM/MongoDB/DocumentManager.php b/lib/Doctrine/ODM/MongoDB/DocumentManager.php
@@ -279,12 +279,10 @@ public function getClassNameResolver(): ClassNameResolver
      * Returns the metadata for a class.
      *
      * @param string $className The class name.
-     * @psalm-param class-string<T> $className
      *
+     * @psalm-param class-string<T> $className
      * @psalm-return ClassMetadata<T>
-     *
      * @template T of object
-     *
      * @psalm-suppress InvalidReturnType, InvalidReturnStatement see https://github.com/vimeo/psalm/issues/5788
      */
     public function getClassMetadata($className): ClassMetadata
@@ -549,11 +547,11 @@ public function unlock(object $document): void
      * Gets the repository for a document class.
      *
      * @param string $className The name of the Document.
-     * @psalm-param class-string<T> $className
      *
      * @return DocumentRepository|GridFSRepository|ViewRepository  The repository.
-     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
      *
+     * @psalm-param class-string<T> $className
+     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
      * @template T of object
      */
     public function getRepository($className)
@@ -567,9 +565,10 @@ public function getRepository($className)
      * database.
      *
      * @param array $options Array of options to be used with batchInsert(), update() and remove()
-     * @psalm-param CommitOptions $options
      *
      * @throws MongoDBException
+     *
+     * @psalm-param CommitOptions $options
      */
     public function flush(array $options = [])
     {
@@ -586,10 +585,9 @@ public function flush(array $options = [])
      * loads itself on first access.
      *
      * @param mixed $identifier
-     * @psalm-param class-string<T> $documentName
      *
+     * @psalm-param class-string<T> $documentName
      * @psalm-return T|(T&GhostObjectInterface<T>)
-     *
      * @template T of object
      */
     public function getReference(string $documentName, $identifier): object
@@ -657,10 +655,9 @@ public function getPartialReference(string $documentName, $identifier): object
      * @param mixed  $id
      * @param int    $lockMode
      * @param int    $lockVersion
-     * @psalm-param class-string<T> $className
      *
+     * @psalm-param class-string<T> $className
      * @psalm-return T|null
-     *
      * @template T of object
      */
     public function find($className, $id, $lockMode = LockMode::NONE, $lockVersion = null): ?object
diff --git a/lib/Doctrine/ODM/MongoDB/Event/PreUpdateEventArgs.php b/lib/Doctrine/ODM/MongoDB/Event/PreUpdateEventArgs.php
@@ -5,7 +5,6 @@
 namespace Doctrine\ODM\MongoDB\Event;
 
 use Doctrine\ODM\MongoDB\DocumentManager;
-use Doctrine\ODM\MongoDB\UnitOfWork;
 use InvalidArgumentException;
 
 use function get_class;
diff --git a/lib/Doctrine/ODM/MongoDB/Hydrator/HydratorFactory.php b/lib/Doctrine/ODM/MongoDB/Hydrator/HydratorFactory.php
@@ -446,9 +446,10 @@ public function hydrate(object \$document, array \$data, array \$hints = array()
      * Hydrate array of MongoDB document data into the given document object.
      *
      * @param array<string, mixed> $data
-     * @psalm-param Hints $hints Any hints to account for during reconstitution/lookup of the document.
      *
      * @return array<string, mixed>
+     *
+     * @psalm-param Hints $hints Any hints to account for during reconstitution/lookup of the document.
      */
     public function hydrate(object $document, array $data, array $hints = []): array
     {
diff --git a/lib/Doctrine/ODM/MongoDB/Hydrator/HydratorInterface.php b/lib/Doctrine/ODM/MongoDB/Hydrator/HydratorInterface.php
@@ -4,8 +4,6 @@
 
 namespace Doctrine\ODM\MongoDB\Hydrator;
 
-use Doctrine\ODM\MongoDB\UnitOfWork;
-
 /**
  * The HydratorInterface defines methods all hydrator need to implement
  *
@@ -17,9 +15,10 @@ interface HydratorInterface
      * Hydrate array of MongoDB document data into the given document object.
      *
      * @param array<string, mixed> $data
-     * @psalm-param Hints $hints
      *
      * @return array<string, mixed>
+     *
+     * @psalm-param Hints $hints
      */
     public function hydrate(object $document, array $data, array $hints = []): array;
 }
diff --git a/lib/Doctrine/ODM/MongoDB/Iterator/CachingIterator.php b/lib/Doctrine/ODM/MongoDB/Iterator/CachingIterator.php
@@ -6,7 +6,6 @@
 
 use Countable;
 use Generator;
-use ReturnTypeWillChange;
 use RuntimeException;
 use Traversable;
 
diff --git a/lib/Doctrine/ODM/MongoDB/Iterator/HydratingIterator.php b/lib/Doctrine/ODM/MongoDB/Iterator/HydratingIterator.php
@@ -8,7 +8,6 @@
 use Doctrine\ODM\MongoDB\UnitOfWork;
 use Generator;
 use Iterator;
-use ReturnTypeWillChange;
 use RuntimeException;
 use Traversable;
 
@@ -42,6 +41,7 @@ final class HydratingIterator implements Iterator
     /**
      * @param Traversable<mixed, TValue> $traversable
      * @param ClassMetadata<TDocument>   $class
+     *
      * @psalm-param Hints $unitOfWorkHints
      */
     public function __construct(Traversable $traversable, UnitOfWork $unitOfWork, ClassMetadata $class, array $unitOfWorkHints = [])
diff --git a/lib/Doctrine/ODM/MongoDB/Iterator/UnrewindableIterator.php b/lib/Doctrine/ODM/MongoDB/Iterator/UnrewindableIterator.php
@@ -6,7 +6,6 @@
 
 use Generator;
 use LogicException;
-use ReturnTypeWillChange;
 use RuntimeException;
 use Traversable;
 
diff --git a/lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php b/lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php
@@ -341,6 +341,7 @@ public function loadMetadataForClass($className, \Doctrine\Persistence\Mapping\C
 
     /**
      * @param ClassMetadata<object> $class
+     *
      * @psalm-param FieldMappingConfig $mapping
      */
     private function addFieldMapping(ClassMetadata $class, array $mapping): void
diff --git a/lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionInterface.php b/lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionInterface.php
@@ -92,9 +92,9 @@ public function setDirty($dirty);
      * Sets the collection's owning document together with the AssociationMapping that
      * describes the association between the owner and the elements of the collection.
      *
-     * @psalm-param FieldMapping $mapping
-     *
      * @return void
+     *
+     * @psalm-param FieldMapping $mapping
      */
     public function setOwner(object $document, array $mapping);
 
@@ -154,15 +154,17 @@ public function getOwner(): ?object;
 
     /**
      * @return array
+     *
      * @psalm-return FieldMapping
      */
     public function getMapping();
 
     /**
      * @return ClassMetadata
-     * @psalm-return ClassMetadata<T>
      *
      * @throws MongoDBException
+     *
+     * @psalm-return ClassMetadata<T>
      */
     public function getTypeClass();
 
diff --git a/lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php b/lib/Doctrine/ODM/MongoDB/PersistentCollection/PersistentCollectionTrait.php
@@ -8,11 +8,9 @@
 use Closure;
 use Doctrine\Common\Collections\Collection as BaseCollection;
 use Doctrine\ODM\MongoDB\DocumentManager;
-use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\MongoDBException;
 use Doctrine\ODM\MongoDB\UnitOfWork;
 use Doctrine\ODM\MongoDB\Utility\CollectionHelper;
-use ReturnTypeWillChange;
 use Traversable;
 
 use function array_combine;
diff --git a/lib/Doctrine/ODM/MongoDB/Proxy/Factory/ProxyFactory.php b/lib/Doctrine/ODM/MongoDB/Proxy/Factory/ProxyFactory.php
@@ -19,10 +19,9 @@ public function generateProxyClasses(array $classes): int;
      * the given identifier.
      *
      * @param mixed $identifier
-     * @psalm-param ClassMetadata<T> $metadata
      *
+     * @psalm-param ClassMetadata<T> $metadata
      * @psalm-return T&GhostObjectInterface<T>
-     *
      * @template T of object
      */
     public function getProxy(ClassMetadata $metadata, $identifier): GhostObjectInterface;
diff --git a/lib/Doctrine/ODM/MongoDB/Proxy/Resolver/ProxyManagerClassNameResolver.php b/lib/Doctrine/ODM/MongoDB/Proxy/Resolver/ProxyManagerClassNameResolver.php
@@ -28,9 +28,7 @@ public function getRealClass(string $class): string
 
     /**
      * @psalm-param class-string<RealClassName>|class-string<ProxyInterface<RealClassName>> $className
-     *
      * @psalm-return class-string<RealClassName>
-     *
      * @psalm-template RealClassName of object
      */
     public function resolveClassName(string $className): string
diff --git a/lib/Doctrine/ODM/MongoDB/Query/Builder.php b/lib/Doctrine/ODM/MongoDB/Query/Builder.php
@@ -26,6 +26,7 @@
 use function is_callable;
 use function is_string;
 use function strtolower;
+use function trigger_deprecation;
 
 /**
  * Query builder for ODM.
diff --git a/lib/Doctrine/ODM/MongoDB/Repository/AbstractRepositoryFactory.php b/lib/Doctrine/ODM/MongoDB/Repository/AbstractRepositoryFactory.php
@@ -27,9 +27,7 @@ abstract class AbstractRepositoryFactory implements RepositoryFactory
 
     /**
      * @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
@@ -51,11 +49,10 @@ public function getRepository(DocumentManager $documentManager, string $document
     /**
      * Create a new repository instance for a document class.
      *
-     * @psalm-param class-string<T> $documentName
-     *
      * @return DocumentRepository|GridFSRepository|ViewRepository
-     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
      *
+     * @psalm-param class-string<T> $documentName
+     * @psalm-return DocumentRepository<T>|GridFSRepository<T>|ViewRepository<T>
      * @template T of object
      */
     protected function createRepository(DocumentManager $documentManager, string $documentName): ObjectRepository
@@ -104,10 +101,10 @@ protected function createRepository(DocumentManager $documentManager, string $do
      * Instantiates requested repository.
      *
      * @param ClassMetadata<T> $metadata
-     * @psalm-param class-string<T> $repositoryClassName
      *
      * @return ObjectRepository<T>
      *
+     * @psalm-param class-string<T> $repositoryClassName
      * @template T of object
      */
     abstract protected function instantiateRepository(string $repositoryClassName, DocumentManager $documentManager, ClassMetadata $metadata): ObjectRepository;
diff --git a/lib/Doctrine/ODM/MongoDB/Repository/DocumentRepository.php b/lib/Doctrine/ODM/MongoDB/Repository/DocumentRepository.php
@@ -61,6 +61,7 @@ class DocumentRepository implements ObjectRepository, Selectable
      * @param DocumentManager $dm            The DocumentManager to use.
      * @param UnitOfWork      $uow           The UnitOfWork to use.
      * @param ClassMetadata   $classMetadata The class metadata.
+     *
      * @psalm-param ClassMetadata<T>   $classMetadata The class metadata.
      */
     public function __construct(DocumentManager $dm, UnitOfWork $uow, ClassMetadata $classMetadata)
@@ -101,10 +102,10 @@ public function clear(): void
      *
      * @param mixed $id Identifier.
      *
-     * @psalm-return T|null
-     *
      * @throws MappingException
      * @throws LockException
+     *
+     * @psalm-return T|null
      */
     public function find($id, int $lockMode = LockMode::NONE, ?int $lockVersion = null): ?object
     {
@@ -181,6 +182,7 @@ public function findBy(array $criteria, ?array $orderBy = null, $limit = null, $
      * @param array<string, mixed>      $criteria
      *
      * @return object|null The object.
+     *
      * @psalm-return T|null
      */
     public function findOneBy(array $criteria, ?array $sort = null): ?object
diff --git a/lib/Doctrine/ODM/MongoDB/Repository/RepositoryFactory.php b/lib/Doctrine/ODM/MongoDB/Repository/RepositoryFactory.php
@@ -16,9 +16,7 @@ interface RepositoryFactory
      * Gets the repository for a document class.
      *
      * @psalm-param class-string<T> $documentName
-     *
      * @psalm-return ObjectRepository<T>
-     *
      * @template T of object
      */
     public function getRepository(DocumentManager $documentManager, string $documentName): ObjectRepository;
diff --git a/lib/Doctrine/ODM/MongoDB/SchemaManager.php b/lib/Doctrine/ODM/MongoDB/SchemaManager.php
diff --git a/lib/Doctrine/ODM/MongoDB/Tools/ResolveTargetDocumentListener.php b/lib/Doctrine/ODM/MongoDB/Tools/ResolveTargetDocumentListener.php
diff --git a/lib/Doctrine/ODM/MongoDB/Types/Type.php b/lib/Doctrine/ODM/MongoDB/Types/Type.php
diff --git a/lib/Doctrine/ODM/MongoDB/UnitOfWork.php b/lib/Doctrine/ODM/MongoDB/UnitOfWork.php
diff --git a/lib/Doctrine/ODM/MongoDB/Utility/LifecycleEventManager.php b/lib/Doctrine/ODM/MongoDB/Utility/LifecycleEventManager.php

Original file line number	Diff line number	Diff line change
`@@ -446,9 +446,10 @@ public function hydrate(object \$document, array \$data, array \$hints = array()`
`446`	`446`	`* Hydrate array of MongoDB document data into the given document object.`
`447`	`447`	`*`
`448`	`448`	`* @param array<string, mixed> $data`
`449`		`- * @psalm-param Hints $hints Any hints to account for during reconstitution/lookup of the document.`
`450`	`449`	`*`
`451`	`450`	`* @return array<string, mixed>`
	`451`	`+ *`
	`452`	`+ * @psalm-param Hints $hints Any hints to account for during reconstitution/lookup of the document.`
`452`	`453`	`*/`
`453`	`454`	`public function hydrate(object $document, array $data, array $hints = []): array`
`454`	`455`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,6 @@`
`4`	`4`
`5`	`5`	`namespace Doctrine\ODM\MongoDB\Hydrator;`
`6`	`6`
`7`		`-use Doctrine\ODM\MongoDB\UnitOfWork;`
`8`		`-`
`9`	`7`	`/**`
`10`	`8`	`* The HydratorInterface defines methods all hydrator need to implement`
`11`	`9`	`*`
`@@ -17,9 +15,10 @@ interface HydratorInterface`
`17`	`15`	`* Hydrate array of MongoDB document data into the given document object.`
`18`	`16`	`*`
`19`	`17`	`* @param array<string, mixed> $data`
`20`		`- * @psalm-param Hints $hints`
`21`	`18`	`*`
`22`	`19`	`* @return array<string, mixed>`
	`20`	`+ *`
	`21`	`+ * @psalm-param Hints $hints`
`23`	`22`	`*/`
`24`	`23`	`public function hydrate(object $document, array $data, array $hints = []): array;`
`25`	`24`	`}`