Merge release 2.19.5 into 2.20.x

docs/en/cookbook/validation-of-entities.rst

@@ -11,7 +11,7 @@ What we offer are hooks to execute any kind of validation.
 .. note::
 
     You don't need to validate your entities in the lifecycle
-    events. Its only one of many options. Of course you can also
+    events. It is only one of many options. Of course you can also
     perform validations in value setters or any other method of your
     entities that are used in your code.
 

docs/en/reference/association-mapping.rst

@@ -1300,8 +1300,8 @@ This is essentially the same as the following, more verbose, mapping:
              * @var Collection<int, Group>
              */
             #[JoinTable(name: 'User_Group')]
-            #[JoinColumn(name: 'User_id', referencedColumnName: 'id')]
-            #[InverseJoinColumn(name: 'Group_id', referencedColumnName: 'id')]
+            #[JoinColumn(name: 'user_id', referencedColumnName: 'id')]
+            #[InverseJoinColumn(name: 'group_id', referencedColumnName: 'id')]
             #[ManyToMany(targetEntity: Group::class)]
             private Collection $groups;
             // ...
@@ -1333,10 +1333,10 @@ This is essentially the same as the following, more verbose, mapping:
                 <many-to-many field="groups" target-entity="Group">
                     <join-table name="User_Group">
                         <join-columns>
-                            <join-column id="User_id" referenced-column-name="id" />
+                            <join-column id="user_id" referenced-column-name="id" />
                         </join-columns>
                         <inverse-join-columns>
-                            <join-column id="Group_id" referenced-column-name="id" />
+                            <join-column id="group_id" referenced-column-name="id" />
                         </inverse-join-columns>
                     </join-table>
                 </many-to-many>

src/Internal/Hydration/AbstractHydrator.php

@@ -182,29 +182,31 @@ public function toIterable($stmt, ResultSetMapping $resultSetMapping, array $hin
 
         $this->prepare();
 
-        while (true) {
-            $row = $this->statement()->fetchAssociative();
-
-            if ($row === false) {
-                $this->cleanup();
+        try {
+            while (true) {
+                $row = $this->statement()->fetchAssociative();
 
-                break;
-            }
+                if ($row === false) {
+                    break;
+                }
 
-            $result = [];
+                $result = [];
 
-            $this->hydrateRowData($row, $result);
+                $this->hydrateRowData($row, $result);
 
-            $this->cleanupAfterRowIteration();
-            if (count($result) === 1) {
-                if (count($resultSetMapping->indexByMap) === 0) {
-                    yield end($result);
+                $this->cleanupAfterRowIteration();
+                if (count($result) === 1) {
+                    if (count($resultSetMapping->indexByMap) === 0) {
+                        yield end($result);
+                    } else {
+                        yield from $result;
+                    }
                 } else {
-                    yield from $result;
+                    yield $result;
                 }
-            } else {
-                yield $result;
             }
+        } finally {
+            $this->cleanup();
         }
     }
 

src/ORMException.php

@@ -5,11 +5,31 @@
 namespace Doctrine\ORM;
 
 use Doctrine\Common\Cache\Cache as CacheDriver;
-use Doctrine\Persistence\ObjectRepository;
+use Doctrine\ORM\Cache\Exception\InvalidResultCacheDriver;
+use Doctrine\ORM\Cache\Exception\MetadataCacheNotConfigured;
+use Doctrine\ORM\Cache\Exception\MetadataCacheUsesNonPersistentCache;
+use Doctrine\ORM\Cache\Exception\QueryCacheNotConfigured;
+use Doctrine\ORM\Cache\Exception\QueryCacheUsesNonPersistentCache;
+use Doctrine\ORM\Exception\EntityManagerClosed;
+use Doctrine\ORM\Exception\InvalidEntityRepository;
+use Doctrine\ORM\Exception\InvalidHydrationMode;
+use Doctrine\ORM\Exception\MismatchedEventManager;
+use Doctrine\ORM\Exception\MissingIdentifierField;
+use Doctrine\ORM\Exception\MissingMappingDriverImplementation;
+use Doctrine\ORM\Exception\NamedNativeQueryNotFound;
+use Doctrine\ORM\Exception\NamedQueryNotFound;
+use Doctrine\ORM\Exception\ProxyClassesAlwaysRegenerating;
+use Doctrine\ORM\Exception\UnexpectedAssociationValue;
+use Doctrine\ORM\Exception\UnknownEntityNamespace;
+use Doctrine\ORM\Exception\UnrecognizedIdentifierFields;
+use Doctrine\ORM\Persisters\Exception\CantUseInOperatorOnCompositeKeys;
+use Doctrine\ORM\Persisters\Exception\InvalidOrientation;
+use Doctrine\ORM\Persisters\Exception\UnrecognizedField;
+use Doctrine\ORM\Repository\Exception\InvalidFindByCall;
+use Doctrine\ORM\Repository\Exception\InvalidMagicMethodCall;
+use Doctrine\ORM\Tools\Exception\NotSupported;
 use Exception;
 
-use function get_debug_type;
-use function implode;
 use function sprintf;
 
 /**
@@ -26,8 +46,7 @@ class ORMException extends Exception
      */
     public static function missingMappingDriverImpl()
     {
-        return new self("It's a requirement to specify a Metadata Driver and pass it " .
-            'to Doctrine\\ORM\\Configuration::setMetadataDriverImpl().');
+        return MissingMappingDriverImplementation::create();
     }
 
     /**
@@ -39,19 +58,19 @@ public static function missingMappingDriverImpl()
      */
     public static function namedQueryNotFound($queryName)
     {
-        return new self('Could not find a named query by the name "' . $queryName . '"');
+        return NamedQueryNotFound::fromName($queryName);
     }
 
     /**
-     * @deprecated Use Doctrine\ORM\Exception\NamedQueryNotFound
+     * @deprecated Use Doctrine\ORM\Exception\NamedNativeQueryNotFound
      *
      * @param string $nativeQueryName
      *
      * @return ORMException
      */
     public static function namedNativeQueryNotFound($nativeQueryName)
     {
-        return new self('Could not find a named native query by the name "' . $nativeQueryName . '"');
+        return NamedNativeQueryNotFound::fromName($nativeQueryName);
     }
 
     /**
@@ -63,7 +82,7 @@ public static function namedNativeQueryNotFound($nativeQueryName)
      */
     public static function unrecognizedField($field)
     {
-        return new self(sprintf('Unrecognized field: %s', $field));
+        return new UnrecognizedField(sprintf('Unrecognized field: %s', $field));
     }
 
     /**
@@ -78,7 +97,7 @@ public static function unrecognizedField($field)
      */
     public static function unexpectedAssociationValue($class, $association, $given, $expected)
     {
-        return new self(sprintf('Found entity of type %s on association %s#%s, but expecting %s', $given, $class, $association, $expected));
+        return UnexpectedAssociationValue::create($class, $association, $given, $expected);
     }
 
     /**
@@ -91,7 +110,7 @@ public static function unexpectedAssociationValue($class, $association, $given,
      */
     public static function invalidOrientation($className, $field)
     {
-        return new self('Invalid order by orientation specified for ' . $className . '#' . $field);
+        return InvalidOrientation::fromClassNameAndField($className, $field);
     }
 
     /**
@@ -101,7 +120,7 @@ public static function invalidOrientation($className, $field)
      */
     public static function entityManagerClosed()
     {
-        return new self('The EntityManager is closed.');
+        return EntityManagerClosed::create();
     }
 
     /**
@@ -113,7 +132,7 @@ public static function entityManagerClosed()
      */
     public static function invalidHydrationMode($mode)
     {
-        return new self(sprintf("'%s' is an invalid hydration mode.", $mode));
+        return InvalidHydrationMode::fromMode($mode);
     }
 
     /**
@@ -123,7 +142,7 @@ public static function invalidHydrationMode($mode)
      */
     public static function mismatchedEventManager()
     {
-        return new self('Cannot use different EventManager instances for EntityManager and Connection.');
+        return MismatchedEventManager::create();
     }
 
     /**
@@ -135,11 +154,11 @@ public static function mismatchedEventManager()
      */
     public static function findByRequiresParameter($methodName)
     {
-        return new self("You need to pass a parameter to '" . $methodName . "'");
+        return InvalidMagicMethodCall::onMissingParameter($methodName);
     }
 
     /**
-     * @deprecated Doctrine\ORM\Repository\Exception\InvalidFindByCall
+     * @deprecated Doctrine\ORM\Repository\Exception\InvalidMagicMethodCall::becauseFieldNotFoundIn()
      *
      * @param string $entityName
      * @param string $fieldName
@@ -149,10 +168,7 @@ public static function findByRequiresParameter($methodName)
      */
     public static function invalidMagicCall($entityName, $fieldName, $method)
     {
-        return new self(
-            "Entity '" . $entityName . "' has no field '" . $fieldName . "'. " .
-            "You can therefore not call '" . $method . "' on the entities' repository"
-        );
+        return InvalidMagicMethodCall::becauseFieldNotFoundIn($entityName, $fieldName, $method);
     }
 
     /**
@@ -165,10 +181,7 @@ public static function invalidMagicCall($entityName, $fieldName, $method)
      */
     public static function invalidFindByInverseAssociation($entityName, $associationFieldName)
     {
-        return new self(
-            "You cannot search for the association field '" . $entityName . '#' . $associationFieldName . "', " .
-            'because it is the inverse side of an association. Find methods only work on owning side associations.'
-        );
+        return InvalidFindByCall::fromInverseSideUsage($entityName, $associationFieldName);
     }
 
     /**
@@ -178,7 +191,7 @@ public static function invalidFindByInverseAssociation($entityName, $association
      */
     public static function invalidResultCacheDriver()
     {
-        return new self('Invalid result cache driver; it must implement Doctrine\\Common\\Cache\\Cache.');
+        return InvalidResultCacheDriver::create();
     }
 
     /**
@@ -188,7 +201,7 @@ public static function invalidResultCacheDriver()
      */
     public static function notSupported()
     {
-        return new self('This behaviour is (currently) not supported by Doctrine 2');
+        return NotSupported::create();
     }
 
     /**
@@ -198,7 +211,7 @@ public static function notSupported()
      */
     public static function queryCacheNotConfigured()
     {
-        return new self('Query Cache is not configured.');
+        return QueryCacheNotConfigured::create();
     }
 
     /**
@@ -208,7 +221,7 @@ public static function queryCacheNotConfigured()
      */
     public static function metadataCacheNotConfigured()
     {
-        return new self('Class Metadata Cache is not configured.');
+        return MetadataCacheNotConfigured::create();
     }
 
     /**
@@ -218,7 +231,7 @@ public static function metadataCacheNotConfigured()
      */
     public static function queryCacheUsesNonPersistentCache(CacheDriver $cache)
     {
-        return new self('Query Cache uses a non-persistent cache driver, ' . get_debug_type($cache) . '.');
+        return QueryCacheUsesNonPersistentCache::fromDriver($cache);
     }
 
     /**
@@ -228,7 +241,7 @@ public static function queryCacheUsesNonPersistentCache(CacheDriver $cache)
      */
     public static function metadataCacheUsesNonPersistentCache(CacheDriver $cache)
     {
-        return new self('Metadata Cache uses a non-persistent cache driver, ' . get_debug_type($cache) . '.');
+        return MetadataCacheUsesNonPersistentCache::fromDriver($cache);
     }
 
     /**
@@ -238,7 +251,7 @@ public static function metadataCacheUsesNonPersistentCache(CacheDriver $cache)
      */
     public static function proxyClassesAlwaysRegenerating()
     {
-        return new self('Proxy Classes are always regenerating.');
+        return ProxyClassesAlwaysRegenerating::create();
     }
 
     /**
@@ -250,9 +263,7 @@ public static function proxyClassesAlwaysRegenerating()
      */
     public static function unknownEntityNamespace($entityNamespaceAlias)
     {
-        return new self(
-            sprintf("Unknown Entity namespace alias '%s'.", $entityNamespaceAlias)
-        );
+        return UnknownEntityNamespace::fromNamespaceAlias($entityNamespaceAlias);
     }
 
     /**
@@ -264,11 +275,7 @@ public static function unknownEntityNamespace($entityNamespaceAlias)
      */
     public static function invalidEntityRepository($className)
     {
-        return new self(sprintf(
-            "Invalid repository class '%s'. It must be a %s.",
-            $className,
-            ObjectRepository::class
-        ));
+        return InvalidEntityRepository::fromClassName($className);
     }
 
     /**
@@ -281,7 +288,7 @@ public static function invalidEntityRepository($className)
      */
     public static function missingIdentifierField($className, $fieldName)
     {
-        return new self(sprintf('The identifier %s is missing for a query of %s', $fieldName, $className));
+        return MissingIdentifierField::fromFieldAndClass($fieldName, $className);
     }
 
     /**
@@ -294,10 +301,7 @@ public static function missingIdentifierField($className, $fieldName)
      */
     public static function unrecognizedIdentifierFields($className, $fieldNames)
     {
-        return new self(
-            "Unrecognized identifier fields: '" . implode("', '", $fieldNames) . "' " .
-            "are not present on class '" . $className . "'."
-        );
+        return UnrecognizedIdentifierFields::fromClassAndFieldNames($className, $fieldNames);
     }
 
     /**
@@ -307,6 +311,6 @@ public static function unrecognizedIdentifierFields($className, $fieldNames)
      */
     public static function cantUseInOperatorOnCompositeKeys()
     {
-        return new self("Can't use IN operator on entities that have composite keys.");
+        return CantUseInOperatorOnCompositeKeys::create();
     }
 }

src/UnitOfWork.php

@@ -1292,6 +1292,8 @@ private function executeDeletions(): void
         $eventsToDispatch = [];
 
         foreach ($entities as $entity) {
+            $this->removeFromIdentityMap($entity);
+
             $oid       = spl_object_id($entity);
             $class     = $this->em->getClassMetadata(get_class($entity));
             $persister = $this->getEntityPersister($class->name);
@@ -1667,8 +1669,6 @@ public function scheduleForDelete($entity)
             return;
         }
 
-        $this->removeFromIdentityMap($entity);
-
         unset($this->entityUpdates[$oid]);
 
         if (! isset($this->entityDeletions[$oid])) {
@@ -3224,7 +3224,13 @@ public function triggerEagerLoads()
      *
      * @param PersistentCollection[] $collections
      * @param array<string, mixed>   $mapping
-     * @psalm-param array{targetEntity: class-string, sourceEntity: class-string, mappedBy: string, indexBy: string|null} $mapping
+     * @psalm-param array{
+     *     targetEntity: class-string,
+     *     sourceEntity: class-string,
+     *     mappedBy: string,
+     *     indexBy: string|null,
+     *     orderBy: array<string, string>|null
+     * } $mapping
      */
     private function eagerLoadCollections(array $collections, array $mapping): void
     {
@@ -3241,7 +3247,7 @@ private function eagerLoadCollections(array $collections, array $mapping): void
                 $entities[] = $collection->getOwner();
             }
 
-            $found = $this->getEntityPersister($targetEntity)->loadAll([$mappedBy => $entities]);
+            $found = $this->getEntityPersister($targetEntity)->loadAll([$mappedBy => $entities], $mapping['orderBy'] ?? null);
 
             $targetClass    = $this->em->getClassMetadata($targetEntity);
             $targetProperty = $targetClass->getReflectionProperty($mappedBy);