vendor/doctrine/orm/lib/Doctrine/ORM/UnitOfWork.php line 1103

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM;
  7. use DateTimeInterface;
  8. use Doctrine\Common\Collections\ArrayCollection;
  9. use Doctrine\Common\Collections\Collection;
  10. use Doctrine\Common\EventManager;
  11. use Doctrine\Common\Proxy\Proxy;
  12. use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
  13. use Doctrine\DBAL\LockMode;
  14. use Doctrine\Deprecations\Deprecation;
  15. use Doctrine\ORM\Cache\Persister\CachedPersister;
  16. use Doctrine\ORM\Event\LifecycleEventArgs;
  17. use Doctrine\ORM\Event\ListenersInvoker;
  18. use Doctrine\ORM\Event\OnFlushEventArgs;
  19. use Doctrine\ORM\Event\PostFlushEventArgs;
  20. use Doctrine\ORM\Event\PreFlushEventArgs;
  21. use Doctrine\ORM\Event\PreUpdateEventArgs;
  22. use Doctrine\ORM\Exception\UnexpectedAssociationValue;
  23. use Doctrine\ORM\Id\AssignedGenerator;
  24. use Doctrine\ORM\Internal\CommitOrderCalculator;
  25. use Doctrine\ORM\Internal\HydrationCompleteHandler;
  26. use Doctrine\ORM\Mapping\ClassMetadata;
  27. use Doctrine\ORM\Mapping\MappingException;
  28. use Doctrine\ORM\Mapping\Reflection\ReflectionPropertiesGetter;
  29. use Doctrine\ORM\Persisters\Collection\CollectionPersister;
  30. use Doctrine\ORM\Persisters\Collection\ManyToManyPersister;
  31. use Doctrine\ORM\Persisters\Collection\OneToManyPersister;
  32. use Doctrine\ORM\Persisters\Entity\BasicEntityPersister;
  33. use Doctrine\ORM\Persisters\Entity\EntityPersister;
  34. use Doctrine\ORM\Persisters\Entity\JoinedSubclassPersister;
  35. use Doctrine\ORM\Persisters\Entity\SingleTablePersister;
  36. use Doctrine\ORM\Utility\IdentifierFlattener;
  37. use Doctrine\Persistence\Mapping\RuntimeReflectionService;
  38. use Doctrine\Persistence\NotifyPropertyChanged;
  39. use Doctrine\Persistence\ObjectManagerAware;
  40. use Doctrine\Persistence\PropertyChangedListener;
  41. use Exception;
  42. use InvalidArgumentException;
  43. use RuntimeException;
  44. use Throwable;
  45. use UnexpectedValueException;
  47. use function array_combine;
  48. use function array_diff_key;
  49. use function array_filter;
  50. use function array_key_exists;
  51. use function array_map;
  52. use function array_merge;
  53. use function array_pop;
  54. use function array_sum;
  55. use function array_values;
  56. use function count;
  57. use function current;
  58. use function get_class;
  59. use function get_debug_type;
  60. use function implode;
  61. use function in_array;
  62. use function is_array;
  63. use function is_object;
  64. use function method_exists;
  65. use function reset;
  66. use function spl_object_id;
  67. use function sprintf;
  69. /**
  70.  * The UnitOfWork is responsible for tracking changes to objects during an
  71.  * "object-level" transaction and for writing out changes to the database
  72.  * in the correct order.
  73.  *
  74.  * Internal note: This class contains highly performance-sensitive code.
  75.  */
  76. class UnitOfWork implements PropertyChangedListener
  77. {
  78.     /**
  79.      * An entity is in MANAGED state when its persistence is managed by an EntityManager.
  80.      */
  81.     public const STATE_MANAGED = 1;
  83.     /**
  84.      * An entity is new if it has just been instantiated (i.e. using the "new" operator)
  85.      * and is not (yet) managed by an EntityManager.
  86.      */
  87.     public const STATE_NEW = 2;
  89.     /**
  90.      * A detached entity is an instance with persistent state and identity that is not
  91.      * (or no longer) associated with an EntityManager (and a UnitOfWork).
  92.      */
  93.     public const STATE_DETACHED = 3;
  95.     /**
  96.      * A removed entity instance is an instance with a persistent identity,
  97.      * associated with an EntityManager, whose persistent state will be deleted
  98.      * on commit.
  99.      */
  100.     public const STATE_REMOVED = 4;
  102.     /**
  103.      * Hint used to collect all primary keys of associated entities during hydration
  104.      * and execute it in a dedicated query afterwards
  105.      *
  106.      * @see https://www.doctrine-project.org/projects/doctrine-orm/en/latest/reference/dql-doctrine-query-language.html#temporarily-change-fetch-mode-in-dql
  107.      */
  108.     public const HINT_DEFEREAGERLOAD = 'deferEagerLoad';
  110.     /**
  111.      * The identity map that holds references to all managed entities that have
  112.      * an identity. The entities are grouped by their class name.
  113.      * Since all classes in a hierarchy must share the same identifier set,
  114.      * we always take the root class name of the hierarchy.
  115.      *
  116.      * @var mixed[]
  117.      * @psalm-var array<class-string, array<string, object|null>>
  118.      */
  119.     private $identityMap = [];
  121.     /**
  122.      * Map of all identifiers of managed entities.
  123.      * Keys are object ids (spl_object_id).
  124.      *
  125.      * @var mixed[]
  126.      * @psalm-var array<int, array<string, mixed>>
  127.      */
  128.     private $entityIdentifiers = [];
  130.     /**
  131.      * Map of the original entity data of managed entities.
  132.      * Keys are object ids (spl_object_id). This is used for calculating changesets
  133.      * at commit time.
  134.      *
  135.      * Internal note: Note that PHPs "copy-on-write" behavior helps a lot with memory usage.
  136.      *                A value will only really be copied if the value in the entity is modified
  137.      *                by the user.
  138.      *
  139.      * @psalm-var array<int, array<string, mixed>>
  140.      */
  141.     private $originalEntityData = [];
  143.     /**
  144.      * Map of entity changes. Keys are object ids (spl_object_id).
  145.      * Filled at the beginning of a commit of the UnitOfWork and cleaned at the end.
  146.      *
  147.      * @psalm-var array<int, array<string, array{mixed, mixed}>>
  148.      */
  149.     private $entityChangeSets = [];
  151.     /**
  152.      * The (cached) states of any known entities.
  153.      * Keys are object ids (spl_object_id).
  154.      *
  155.      * @psalm-var array<int, self::STATE_*>
  156.      */
  157.     private $entityStates = [];
  159.     /**
  160.      * Map of entities that are scheduled for dirty checking at commit time.
  161.      * This is only used for entities with a change tracking policy of DEFERRED_EXPLICIT.
  162.      * Keys are object ids (spl_object_id).
  163.      *
  164.      * @psalm-var array<class-string, array<int, mixed>>
  165.      */
  166.     private $scheduledForSynchronization = [];
  168.     /**
  169.      * A list of all pending entity insertions.
  170.      *
  171.      * @psalm-var array<int, object>
  172.      */
  173.     private $entityInsertions = [];
  175.     /**
  176.      * A list of all pending entity updates.
  177.      *
  178.      * @psalm-var array<int, object>
  179.      */
  180.     private $entityUpdates = [];
  182.     /**
  183.      * Any pending extra updates that have been scheduled by persisters.
  184.      *
  185.      * @psalm-var array<int, array{object, array<string, array{mixed, mixed}>}>
  186.      */
  187.     private $extraUpdates = [];
  189.     /**
  190.      * A list of all pending entity deletions.
  191.      *
  192.      * @psalm-var array<int, object>
  193.      */
  194.     private $entityDeletions = [];
  196.     /**
  197.      * New entities that were discovered through relationships that were not
  198.      * marked as cascade-persist. During flush, this array is populated and
  199.      * then pruned of any entities that were discovered through a valid
  200.      * cascade-persist path. (Leftovers cause an error.)
  201.      *
  202.      * Keys are OIDs, payload is a two-item array describing the association
  203.      * and the entity.
  204.      *
  205.      * @var object[][]|array[][] indexed by respective object spl_object_id()
  206.      */
  207.     private $nonCascadedNewDetectedEntities = [];
  209.     /**
  210.      * All pending collection deletions.
  211.      *
  212.      * @psalm-var array<int, Collection<array-key, object>>
  213.      */
  214.     private $collectionDeletions = [];
  216.     /**
  217.      * All pending collection updates.
  218.      *
  219.      * @psalm-var array<int, Collection<array-key, object>>
  220.      */
  221.     private $collectionUpdates = [];
  223.     /**
  224.      * List of collections visited during changeset calculation on a commit-phase of a UnitOfWork.
  225.      * At the end of the UnitOfWork all these collections will make new snapshots
  226.      * of their data.
  227.      *
  228.      * @psalm-var array<int, Collection<array-key, object>>
  229.      */
  230.     private $visitedCollections = [];
  232.     /**
  233.      * The EntityManager that "owns" this UnitOfWork instance.
  234.      *
  235.      * @var EntityManagerInterface
  236.      */
  237.     private $em;
  239.     /**
  240.      * The entity persister instances used to persist entity instances.
  241.      *
  242.      * @psalm-var array<string, EntityPersister>
  243.      */
  244.     private $persisters = [];
  246.     /**
  247.      * The collection persister instances used to persist collections.
  248.      *
  249.      * @psalm-var array<string, CollectionPersister>
  250.      */
  251.     private $collectionPersisters = [];
  253.     /**
  254.      * The EventManager used for dispatching events.
  255.      *
  256.      * @var EventManager
  257.      */
  258.     private $evm;
  260.     /**
  261.      * The ListenersInvoker used for dispatching events.
  262.      *
  263.      * @var ListenersInvoker
  264.      */
  265.     private $listenersInvoker;
  267.     /**
  268.      * The IdentifierFlattener used for manipulating identifiers
  269.      *
  270.      * @var IdentifierFlattener
  271.      */
  272.     private $identifierFlattener;
  274.     /**
  275.      * Orphaned entities that are scheduled for removal.
  276.      *
  277.      * @psalm-var array<int, object>
  278.      */
  279.     private $orphanRemovals = [];
  281.     /**
  282.      * Read-Only objects are never evaluated
  283.      *
  284.      * @var array<int, true>
  285.      */
  286.     private $readOnlyObjects = [];
  288.     /**
  289.      * Map of Entity Class-Names and corresponding IDs that should eager loaded when requested.
  290.      *
  291.      * @psalm-var array<class-string, array<string, mixed>>
  292.      */
  293.     private $eagerLoadingEntities = [];
  295.     /** @var bool */
  296.     protected $hasCache = false;
  298.     /**
  299.      * Helper for handling completion of hydration
  300.      *
  301.      * @var HydrationCompleteHandler
  302.      */
  303.     private $hydrationCompleteHandler;
  305.     /** @var ReflectionPropertiesGetter */
  306.     private $reflectionPropertiesGetter;
  308.     /**
  309.      * Initializes a new UnitOfWork instance, bound to the given EntityManager.
  310.      */
  311.     public function __construct(EntityManagerInterface $em)
  312.     {
  313.         $this->em                         = $em;
  314.         $this->evm                        = $em->getEventManager();
  315.         $this->listenersInvoker           = new ListenersInvoker($em);
  316.         $this->hasCache                   = $em->getConfiguration()->isSecondLevelCacheEnabled();
  317.         $this->identifierFlattener        = new IdentifierFlattener($this, $em->getMetadataFactory());
  318.         $this->hydrationCompleteHandler   = new HydrationCompleteHandler($this->listenersInvoker, $em);
  319.         $this->reflectionPropertiesGetter = new ReflectionPropertiesGetter(new RuntimeReflectionService());
  320.     }
  322.     /**
  323.      * Commits the UnitOfWork, executing all operations that have been postponed
  324.      * up to this point. The state of all managed entities will be synchronized with
  325.      * the database.
  326.      *
  327.      * The operations are executed in the following order:
  328.      *
  329.      * 1) All entity insertions
  330.      * 2) All entity updates
  331.      * 3) All collection deletions
  332.      * 4) All collection updates
  333.      * 5) All entity deletions
  334.      *
  335.      * @param object|mixed[]|null $entity
  336.      *
  337.      * @return void
  338.      *
  339.      * @throws Exception
  340.      */
  341.     public function commit($entity = null)
  342.     {
  343.         if ($entity !== null) {
  344.             Deprecation::triggerIfCalledFromOutside(
  345.                 'doctrine/orm',
  346.                 'https://github.com/doctrine/orm/issues/8459',
  347.                 'Calling %s() with any arguments to commit specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
  348.                 __METHOD__
  349.             );
  350.         }
  352.         $connection = $this->em->getConnection();
  354.         if ($connection instanceof PrimaryReadReplicaConnection) {
  355.             $connection->ensureConnectedToPrimary();
  356.         }
  358.         // Raise preFlush
  359.         if ($this->evm->hasListeners(Events::preFlush)) {
  360.             $this->evm->dispatchEvent(Events::preFlush, new PreFlushEventArgs($this->em));
  361.         }
  363.         // Compute changes done since last commit.
  364.         if ($entity === null) {
  365.             $this->computeChangeSets();
  366.         } elseif (is_object($entity)) {
  367.             $this->computeSingleEntityChangeSet($entity);
  368.         } elseif (is_array($entity)) {
  369.             foreach ($entity as $object) {
  370.                 $this->computeSingleEntityChangeSet($object);
  371.             }
  372.         }
  374.         if (
  375.             ! ($this->entityInsertions ||
  376.                 $this->entityDeletions ||
  377.                 $this->entityUpdates ||
  378.                 $this->collectionUpdates ||
  379.                 $this->collectionDeletions ||
  380.                 $this->orphanRemovals)
  381.         ) {
  382.             $this->dispatchOnFlushEvent();
  383.             $this->dispatchPostFlushEvent();
  385.             $this->postCommitCleanup($entity);
  387.             return; // Nothing to do.
  388.         }
  390.         $this->assertThatThereAreNoUnintentionallyNonPersistedAssociations();
  392.         if ($this->orphanRemovals) {
  393.             foreach ($this->orphanRemovals as $orphan) {
  394.                 $this->remove($orphan);
  395.             }
  396.         }
  398.         $this->dispatchOnFlushEvent();
  400.         // Now we need a commit order to maintain referential integrity
  401.         $commitOrder = $this->getCommitOrder();
  403.         $conn = $this->em->getConnection();
  404.         $conn->beginTransaction();
  406.         try {
  407.             // Collection deletions (deletions of complete collections)
  408.             foreach ($this->collectionDeletions as $collectionToDelete) {
  409.                 if (! $collectionToDelete instanceof PersistentCollection) {
  410.                     $this->getCollectionPersister($collectionToDelete->getMapping())->delete($collectionToDelete);
  412.                     continue;
  413.                 }
  415.                 // Deferred explicit tracked collections can be removed only when owning relation was persisted
  416.                 $owner = $collectionToDelete->getOwner();
  418.                 if ($this->em->getClassMetadata(get_class($owner))->isChangeTrackingDeferredImplicit() || $this->isScheduledForDirtyCheck($owner)) {
  419.                     $this->getCollectionPersister($collectionToDelete->getMapping())->delete($collectionToDelete);
  420.                 }
  421.             }
  423.             if ($this->entityInsertions) {
  424.                 foreach ($commitOrder as $class) {
  425.                     $this->executeInserts($class);
  426.                 }
  427.             }
  429.             if ($this->entityUpdates) {
  430.                 foreach ($commitOrder as $class) {
  431.                     $this->executeUpdates($class);
  432.                 }
  433.             }
  435.             // Extra updates that were requested by persisters.
  436.             if ($this->extraUpdates) {
  437.                 $this->executeExtraUpdates();
  438.             }
  440.             // Collection updates (deleteRows, updateRows, insertRows)
  441.             foreach ($this->collectionUpdates as $collectionToUpdate) {
  442.                 $this->getCollectionPersister($collectionToUpdate->getMapping())->update($collectionToUpdate);
  443.             }
  445.             // Entity deletions come last and need to be in reverse commit order
  446.             if ($this->entityDeletions) {
  447.                 for ($count = count($commitOrder), $i = $count - 1; $i >= 0 && $this->entityDeletions; --$i) {
  448.                     $this->executeDeletions($commitOrder[$i]);
  449.                 }
  450.             }
  452.             // Commit failed silently
  453.             if ($conn->commit() === false) {
  454.                 $object = is_object($entity) ? $entity : null;
  456.                 throw new OptimisticLockException('Commit failed', $object);
  457.             }
  458.         } catch (Throwable $e) {
  459.             $this->em->close();
  461.             if ($conn->isTransactionActive()) {
  462.                 $conn->rollBack();
  463.             }
  465.             $this->afterTransactionRolledBack();
  467.             throw $e;
  468.         }
  470.         $this->afterTransactionComplete();
  472.         // Take new snapshots from visited collections
  473.         foreach ($this->visitedCollections as $coll) {
  474.             $coll->takeSnapshot();
  475.         }
  477.         $this->dispatchPostFlushEvent();
  479.         $this->postCommitCleanup($entity);
  480.     }
  482.     /**
  483.      * @param object|object[]|null $entity
  484.      */
  485.     private function postCommitCleanup($entity): void
  486.     {
  487.         $this->entityInsertions               =
  488.         $this->entityUpdates                  =
  489.         $this->entityDeletions                =
  490.         $this->extraUpdates                   =
  491.         $this->collectionUpdates              =
  492.         $this->nonCascadedNewDetectedEntities =
  493.         $this->collectionDeletions            =
  494.         $this->visitedCollections             =
  495.         $this->orphanRemovals                 = [];
  497.         if ($entity === null) {
  498.             $this->entityChangeSets = $this->scheduledForSynchronization = [];
  500.             return;
  501.         }
  503.         $entities = is_object($entity)
  504.             ? [$entity]
  505.             : $entity;
  507.         foreach ($entities as $object) {
  508.             $oid = spl_object_id($object);
  510.             $this->clearEntityChangeSet($oid);
  512.             unset($this->scheduledForSynchronization[$this->em->getClassMetadata(get_class($object))->rootEntityName][$oid]);
  513.         }
  514.     }
  516.     /**
  517.      * Computes the changesets of all entities scheduled for insertion.
  518.      */
  519.     private function computeScheduleInsertsChangeSets(): void
  520.     {
  521.         foreach ($this->entityInsertions as $entity) {
  522.             $class = $this->em->getClassMetadata(get_class($entity));
  524.             $this->computeChangeSet($class, $entity);
  525.         }
  526.     }
  528.     /**
  529.      * Only flushes the given entity according to a ruleset that keeps the UoW consistent.
  530.      *
  531.      * 1. All entities scheduled for insertion, (orphan) removals and changes in collections are processed as well!
  532.      * 2. Read Only entities are skipped.
  533.      * 3. Proxies are skipped.
  534.      * 4. Only if entity is properly managed.
  535.      *
  536.      * @param object $entity
  537.      *
  538.      * @throws InvalidArgumentException
  539.      */
  540.     private function computeSingleEntityChangeSet($entity): void
  541.     {
  542.         $state = $this->getEntityState($entity);
  544.         if ($state !== self::STATE_MANAGED && $state !== self::STATE_REMOVED) {
  545.             throw new InvalidArgumentException('Entity has to be managed or scheduled for removal for single computation ' . self::objToStr($entity));
  546.         }
  548.         $class = $this->em->getClassMetadata(get_class($entity));
  550.         if ($state === self::STATE_MANAGED && $class->isChangeTrackingDeferredImplicit()) {
  551.             $this->persist($entity);
  552.         }
  554.         // Compute changes for INSERTed entities first. This must always happen even in this case.
  555.         $this->computeScheduleInsertsChangeSets();
  557.         if ($class->isReadOnly) {
  558.             return;
  559.         }
  561.         // Ignore uninitialized proxy objects
  562.         if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  563.             return;
  564.         }
  566.         // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION OR DELETION are processed here.
  567.         $oid = spl_object_id($entity);
  569.         if (! isset($this->entityInsertions[$oid]) && ! isset($this->entityDeletions[$oid]) && isset($this->entityStates[$oid])) {
  570.             $this->computeChangeSet($class, $entity);
  571.         }
  572.     }
  574.     /**
  575.      * Executes any extra updates that have been scheduled.
  576.      */
  577.     private function executeExtraUpdates(): void
  578.     {
  579.         foreach ($this->extraUpdates as $oid => $update) {
  580.             [$entity, $changeset] = $update;
  582.             $this->entityChangeSets[$oid] = $changeset;
  583.             $this->getEntityPersister(get_class($entity))->update($entity);
  584.         }
  586.         $this->extraUpdates = [];
  587.     }
  589.     /**
  590.      * Gets the changeset for an entity.
  591.      *
  592.      * @param object $entity
  593.      *
  594.      * @return mixed[][]
  595.      * @psalm-return array<string, array{mixed, mixed}|PersistentCollection>
  596.      */
  597.     public function & getEntityChangeSet($entity)
  598.     {
  599.         $oid  = spl_object_id($entity);
  600.         $data = [];
  602.         if (! isset($this->entityChangeSets[$oid])) {
  603.             return $data;
  604.         }
  606.         return $this->entityChangeSets[$oid];
  607.     }
  609.     /**
  610.      * Computes the changes that happened to a single entity.
  611.      *
  612.      * Modifies/populates the following properties:
  613.      *
  614.      * {@link _originalEntityData}
  615.      * If the entity is NEW or MANAGED but not yet fully persisted (only has an id)
  616.      * then it was not fetched from the database and therefore we have no original
  617.      * entity data yet. All of the current entity data is stored as the original entity data.
  618.      *
  619.      * {@link _entityChangeSets}
  620.      * The changes detected on all properties of the entity are stored there.
  621.      * A change is a tuple array where the first entry is the old value and the second
  622.      * entry is the new value of the property. Changesets are used by persisters
  623.      * to INSERT/UPDATE the persistent entity state.
  624.      *
  625.      * {@link _entityUpdates}
  626.      * If the entity is already fully MANAGED (has been fetched from the database before)
  627.      * and any changes to its properties are detected, then a reference to the entity is stored
  628.      * there to mark it for an update.
  629.      *
  630.      * {@link _collectionDeletions}
  631.      * If a PersistentCollection has been de-referenced in a fully MANAGED entity,
  632.      * then this collection is marked for deletion.
  633.      *
  634.      * @param ClassMetadata $class  The class descriptor of the entity.
  635.      * @param object        $entity The entity for which to compute the changes.
  636.      * @psalm-param ClassMetadata<T> $class
  637.      * @psalm-param T $entity
  638.      *
  639.      * @return void
  640.      *
  641.      * @template T of object
  642.      *
  643.      * @ignore
  644.      */
  645.     public function computeChangeSet(ClassMetadata $class, $entity)
  646.     {
  647.         $oid = spl_object_id($entity);
  649.         if (isset($this->readOnlyObjects[$oid])) {
  650.             return;
  651.         }
  653.         if (! $class->isInheritanceTypeNone()) {
  654.             $class = $this->em->getClassMetadata(get_class($entity));
  655.         }
  657.         $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preFlush) & ~ListenersInvoker::INVOKE_MANAGER;
  659.         if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  660.             $this->listenersInvoker->invoke($class, Events::preFlush, $entity, new PreFlushEventArgs($this->em), $invoke);
  661.         }
  663.         $actualData = [];
  665.         foreach ($class->reflFields as $name => $refProp) {
  666.             $value = $refProp->getValue($entity);
  668.             if ($class->isCollectionValuedAssociation($name) && $value !== null) {
  669.                 if ($value instanceof PersistentCollection) {
  670.                     if ($value->getOwner() === $entity) {
  671.                         continue;
  672.                     }
  674.                     $value = new ArrayCollection($value->getValues());
  675.                 }
  677.                 // If $value is not a Collection then use an ArrayCollection.
  678.                 if (! $value instanceof Collection) {
  679.                     $value = new ArrayCollection($value);
  680.                 }
  682.                 $assoc = $class->associationMappings[$name];
  684.                 // Inject PersistentCollection
  685.                 $value = new PersistentCollection(
  686.                     $this->em,
  687.                     $this->em->getClassMetadata($assoc['targetEntity']),
  688.                     $value
  689.                 );
  690.                 $value->setOwner($entity, $assoc);
  691.                 $value->setDirty(! $value->isEmpty());
  693.                 $class->reflFields[$name]->setValue($entity, $value);
  695.                 $actualData[$name] = $value;
  697.                 continue;
  698.             }
  700.             if (( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity()) && ($name !== $class->versionField)) {
  701.                 $actualData[$name] = $value;
  702.             }
  703.         }
  705.         if (! isset($this->originalEntityData[$oid])) {
  706.             // Entity is either NEW or MANAGED but not yet fully persisted (only has an id).
  707.             // These result in an INSERT.
  708.             $this->originalEntityData[$oid] = $actualData;
  709.             $changeSet                      = [];
  711.             foreach ($actualData as $propName => $actualValue) {
  712.                 if (! isset($class->associationMappings[$propName])) {
  713.                     $changeSet[$propName] = [null, $actualValue];
  715.                     continue;
  716.                 }
  718.                 $assoc = $class->associationMappings[$propName];
  720.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  721.                     $changeSet[$propName] = [null, $actualValue];
  722.                 }
  723.             }
  725.             $this->entityChangeSets[$oid] = $changeSet;
  726.         } else {
  727.             // Entity is "fully" MANAGED: it was already fully persisted before
  728.             // and we have a copy of the original data
  729.             $originalData           = $this->originalEntityData[$oid];
  730.             $isChangeTrackingNotify = $class->isChangeTrackingNotify();
  731.             $changeSet              = $isChangeTrackingNotify && isset($this->entityChangeSets[$oid])
  732.                 ? $this->entityChangeSets[$oid]
  733.                 : [];
  735.             foreach ($actualData as $propName => $actualValue) {
  736.                 // skip field, its a partially omitted one!
  737.                 if (! (isset($originalData[$propName]) || array_key_exists($propName, $originalData))) {
  738.                     continue;
  739.                 }
  741.                 $orgValue = $originalData[$propName];
  743.                 // skip if value haven't changed
  744.                 if ($orgValue === $actualValue) {
  745.                     continue;
  746.                 }
  748.                 // if regular field
  749.                 if (! isset($class->associationMappings[$propName])) {
  750.                     if ($isChangeTrackingNotify) {
  751.                         continue;
  752.                     }
  754.                     $changeSet[$propName] = [$orgValue, $actualValue];
  756.                     continue;
  757.                 }
  759.                 $assoc = $class->associationMappings[$propName];
  761.                 // Persistent collection was exchanged with the "originally"
  762.                 // created one. This can only mean it was cloned and replaced
  763.                 // on another entity.
  764.                 if ($actualValue instanceof PersistentCollection) {
  765.                     $owner = $actualValue->getOwner();
  766.                     if ($owner === null) { // cloned
  767.                         $actualValue->setOwner($entity, $assoc);
  768.                     } elseif ($owner !== $entity) { // no clone, we have to fix
  769.                         if (! $actualValue->isInitialized()) {
  770.                             $actualValue->initialize(); // we have to do this otherwise the cols share state
  771.                         }
  773.                         $newValue = clone $actualValue;
  774.                         $newValue->setOwner($entity, $assoc);
  775.                         $class->reflFields[$propName]->setValue($entity, $newValue);
  776.                     }
  777.                 }
  779.                 if ($orgValue instanceof PersistentCollection) {
  780.                     // A PersistentCollection was de-referenced, so delete it.
  781.                     $coid = spl_object_id($orgValue);
  783.                     if (isset($this->collectionDeletions[$coid])) {
  784.                         continue;
  785.                     }
  787.                     $this->collectionDeletions[$coid] = $orgValue;
  788.                     $changeSet[$propName]             = $orgValue; // Signal changeset, to-many assocs will be ignored.
  790.                     continue;
  791.                 }
  793.                 if ($assoc['type'] & ClassMetadata::TO_ONE) {
  794.                     if ($assoc['isOwningSide']) {
  795.                         $changeSet[$propName] = [$orgValue, $actualValue];
  796.                     }
  798.                     if ($orgValue !== null && $assoc['orphanRemoval']) {
  799.                         $this->scheduleOrphanRemoval($orgValue);
  800.                     }
  801.                 }
  802.             }
  804.             if ($changeSet) {
  805.                 $this->entityChangeSets[$oid]   = $changeSet;
  806.                 $this->originalEntityData[$oid] = $actualData;
  807.                 $this->entityUpdates[$oid]      = $entity;
  808.             }
  809.         }
  811.         // Look for changes in associations of the entity
  812.         foreach ($class->associationMappings as $field => $assoc) {
  813.             $val = $class->reflFields[$field]->getValue($entity);
  814.             if ($val === null) {
  815.                 continue;
  816.             }
  818.             $this->computeAssociationChanges($assoc, $val);
  820.             if (
  821.                 ! isset($this->entityChangeSets[$oid]) &&
  822.                 $assoc['isOwningSide'] &&
  823.                 $assoc['type'] === ClassMetadata::MANY_TO_MANY &&
  824.                 $val instanceof PersistentCollection &&
  825.                 $val->isDirty()
  826.             ) {
  827.                 $this->entityChangeSets[$oid]   = [];
  828.                 $this->originalEntityData[$oid] = $actualData;
  829.                 $this->entityUpdates[$oid]      = $entity;
  830.             }
  831.         }
  832.     }
  834.     /**
  835.      * Computes all the changes that have been done to entities and collections
  836.      * since the last commit and stores these changes in the _entityChangeSet map
  837.      * temporarily for access by the persisters, until the UoW commit is finished.
  838.      *
  839.      * @return void
  840.      */
  841.     public function computeChangeSets()
  842.     {
  843.         // Compute changes for INSERTed entities first. This must always happen.
  844.         $this->computeScheduleInsertsChangeSets();
  846.         // Compute changes for other MANAGED entities. Change tracking policies take effect here.
  847.         foreach ($this->identityMap as $className => $entities) {
  848.             $class = $this->em->getClassMetadata($className);
  850.             // Skip class if instances are read-only
  851.             if ($class->isReadOnly) {
  852.                 continue;
  853.             }
  855.             // If change tracking is explicit or happens through notification, then only compute
  856.             // changes on entities of that type that are explicitly marked for synchronization.
  857.             switch (true) {
  858.                 case $class->isChangeTrackingDeferredImplicit():
  859.                     $entitiesToProcess = $entities;
  860.                     break;
  862.                 case isset($this->scheduledForSynchronization[$className]):
  863.                     $entitiesToProcess = $this->scheduledForSynchronization[$className];
  864.                     break;
  866.                 default:
  867.                     $entitiesToProcess = [];
  868.             }
  870.             foreach ($entitiesToProcess as $entity) {
  871.                 // Ignore uninitialized proxy objects
  872.                 if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  873.                     continue;
  874.                 }
  876.                 // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION OR DELETION are processed here.
  877.                 $oid = spl_object_id($entity);
  879.                 if (! isset($this->entityInsertions[$oid]) && ! isset($this->entityDeletions[$oid]) && isset($this->entityStates[$oid])) {
  880.                     $this->computeChangeSet($class, $entity);
  881.                 }
  882.             }
  883.         }
  884.     }
  886.     /**
  887.      * Computes the changes of an association.
  888.      *
  889.      * @param mixed $value The value of the association.
  890.      * @psalm-param array<string, mixed> $assoc The association mapping.
  891.      *
  892.      * @throws ORMInvalidArgumentException
  893.      * @throws ORMException
  894.      */
  895.     private function computeAssociationChanges(array $assoc, $value): void
  896.     {
  897.         if ($value instanceof Proxy && ! $value->__isInitialized()) {
  898.             return;
  899.         }
  901.         if ($value instanceof PersistentCollection && $value->isDirty()) {
  902.             $coid = spl_object_id($value);
  904.             $this->collectionUpdates[$coid]  = $value;
  905.             $this->visitedCollections[$coid] = $value;
  906.         }
  908.         // Look through the entities, and in any of their associations,
  909.         // for transient (new) entities, recursively. ("Persistence by reachability")
  910.         // Unwrap. Uninitialized collections will simply be empty.
  911.         $unwrappedValue = $assoc['type'] & ClassMetadata::TO_ONE ? [$value] : $value->unwrap();
  912.         $targetClass    = $this->em->getClassMetadata($assoc['targetEntity']);
  914.         foreach ($unwrappedValue as $key => $entry) {
  915.             if (! ($entry instanceof $targetClass->name)) {
  916.                 throw ORMInvalidArgumentException::invalidAssociation($targetClass, $assoc, $entry);
  917.             }
  919.             $state = $this->getEntityState($entry, self::STATE_NEW);
  921.             if (! ($entry instanceof $assoc['targetEntity'])) {
  922.                 throw UnexpectedAssociationValue::create(
  923.                     $assoc['sourceEntity'],
  924.                     $assoc['fieldName'],
  925.                     get_debug_type($entry),
  926.                     $assoc['targetEntity']
  927.                 );
  928.             }
  930.             switch ($state) {
  931.                 case self::STATE_NEW:
  932.                     if (! $assoc['isCascadePersist']) {
  933.                         /*
  934.                          * For now just record the details, because this may
  935.                          * not be an issue if we later discover another pathway
  936.                          * through the object-graph where cascade-persistence
  937.                          * is enabled for this object.
  938.                          */
  939.                         $this->nonCascadedNewDetectedEntities[spl_object_id($entry)] = [$assoc, $entry];
  941.                         break;
  942.                     }
  944.                     $this->persistNew($targetClass, $entry);
  945.                     $this->computeChangeSet($targetClass, $entry);
  947.                     break;
  949.                 case self::STATE_REMOVED:
  950.                     // Consume the $value as array (it's either an array or an ArrayAccess)
  951.                     // and remove the element from Collection.
  952.                     if ($assoc['type'] & ClassMetadata::TO_MANY) {
  953.                         unset($value[$key]);
  954.                     }
  956.                     break;
  958.                 case self::STATE_DETACHED:
  959.                     // Can actually not happen right now as we assume STATE_NEW,
  960.                     // so the exception will be raised from the DBAL layer (constraint violation).
  961.                     throw ORMInvalidArgumentException::detachedEntityFoundThroughRelationship($assoc, $entry);
  963.                 default:
  964.                     // MANAGED associated entities are already taken into account
  965.                     // during changeset calculation anyway, since they are in the identity map.
  966.             }
  967.         }
  968.     }
  970.     /**
  971.      * @param object $entity
  972.      * @psalm-param ClassMetadata<T> $class
  973.      * @psalm-param T $entity
  974.      *
  975.      * @template T of object
  976.      */
  977.     private function persistNew(ClassMetadata $class, $entity): void
  978.     {
  979.         $oid    = spl_object_id($entity);
  980.         $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::prePersist);
  982.         if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  983.             $this->listenersInvoker->invoke($class, Events::prePersist, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  984.         }
  986.         $idGen = $class->idGenerator;
  988.         if (! $idGen->isPostInsertGenerator()) {
  989.             $idValue = $idGen->generateId($this->em, $entity);
  991.             if (! $idGen instanceof AssignedGenerator) {
  992.                 $idValue = [$class->getSingleIdentifierFieldName() => $this->convertSingleFieldIdentifierToPHPValue($class, $idValue)];
  994.                 $class->setIdentifierValues($entity, $idValue);
  995.             }
  997.             // Some identifiers may be foreign keys to new entities.
  998.             // In this case, we don't have the value yet and should treat it as if we have a post-insert generator
  999.             if (! $this->hasMissingIdsWhichAreForeignKeys($class, $idValue)) {
  1000.                 $this->entityIdentifiers[$oid] = $idValue;
  1001.             }
  1002.         }
  1004.         $this->entityStates[$oid] = self::STATE_MANAGED;
  1006.         $this->scheduleForInsert($entity);
  1007.     }
  1009.     /**
  1010.      * @param mixed[] $idValue
  1011.      */
  1012.     private function hasMissingIdsWhichAreForeignKeys(ClassMetadata $class, array $idValue): bool
  1013.     {
  1014.         foreach ($idValue as $idField => $idFieldValue) {
  1015.             if ($idFieldValue === null && isset($class->associationMappings[$idField])) {
  1016.                 return true;
  1017.             }
  1018.         }
  1020.         return false;
  1021.     }
  1023.     /**
  1024.      * INTERNAL:
  1025.      * Computes the changeset of an individual entity, independently of the
  1026.      * computeChangeSets() routine that is used at the beginning of a UnitOfWork#commit().
  1027.      *
  1028.      * The passed entity must be a managed entity. If the entity already has a change set
  1029.      * because this method is invoked during a commit cycle then the change sets are added.
  1030.      * whereby changes detected in this method prevail.
  1031.      *
  1032.      * @param ClassMetadata $class  The class descriptor of the entity.
  1033.      * @param object        $entity The entity for which to (re)calculate the change set.
  1034.      * @psalm-param ClassMetadata<T> $class
  1035.      * @psalm-param T $entity
  1036.      *
  1037.      * @return void
  1038.      *
  1039.      * @throws ORMInvalidArgumentException If the passed entity is not MANAGED.
  1040.      *
  1041.      * @template T of object
  1042.      * @ignore
  1043.      */
  1044.     public function recomputeSingleEntityChangeSet(ClassMetadata $class, $entity)
  1045.     {
  1046.         $oid = spl_object_id($entity);
  1048.         if (! isset($this->entityStates[$oid]) || $this->entityStates[$oid] !== self::STATE_MANAGED) {
  1049.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  1050.         }
  1052.         // skip if change tracking is "NOTIFY"
  1053.         if ($class->isChangeTrackingNotify()) {
  1054.             return;
  1055.         }
  1057.         if (! $class->isInheritanceTypeNone()) {
  1058.             $class = $this->em->getClassMetadata(get_class($entity));
  1059.         }
  1061.         $actualData = [];
  1063.         foreach ($class->reflFields as $name => $refProp) {
  1064.             if (
  1065.                 ( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity())
  1066.                 && ($name !== $class->versionField)
  1067.                 && ! $class->isCollectionValuedAssociation($name)
  1068.             ) {
  1069.                 $actualData[$name] = $refProp->getValue($entity);
  1070.             }
  1071.         }
  1073.         if (! isset($this->originalEntityData[$oid])) {
  1074.             throw new RuntimeException('Cannot call recomputeSingleEntityChangeSet before computeChangeSet on an entity.');
  1075.         }
  1077.         $originalData = $this->originalEntityData[$oid];
  1078.         $changeSet    = [];
  1080.         foreach ($actualData as $propName => $actualValue) {
  1081.             $orgValue = $originalData[$propName] ?? null;
  1083.             if ($orgValue !== $actualValue) {
  1084.                 $changeSet[$propName] = [$orgValue, $actualValue];
  1085.             }
  1086.         }
  1088.         if ($changeSet) {
  1089.             if (isset($this->entityChangeSets[$oid])) {
  1090.                 $this->entityChangeSets[$oid] = array_merge($this->entityChangeSets[$oid], $changeSet);
  1091.             } elseif (! isset($this->entityInsertions[$oid])) {
  1092.                 $this->entityChangeSets[$oid] = $changeSet;
  1093.                 $this->entityUpdates[$oid]    = $entity;
  1094.             }
  1096.             $this->originalEntityData[$oid] = $actualData;
  1097.         }
  1098.     }
  1100.     /**
  1101.      * Executes all entity insertions for entities of the specified type.
  1102.      */
  1103.     private function executeInserts(ClassMetadata $class): void
  1104.     {
  1105.         $entities  = [];
  1106.         $className = $class->name;
  1107.         $persister = $this->getEntityPersister($className);
  1108.         $invoke    = $this->listenersInvoker->getSubscribedSystems($class, Events::postPersist);
  1110.         $insertionsForClass = [];
  1112.         foreach ($this->entityInsertions as $oid => $entity) {
  1113.             if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
  1114.                 continue;
  1115.             }
  1117.             $insertionsForClass[$oid] = $entity;
  1119.             $persister->addInsert($entity);
  1121.             unset($this->entityInsertions[$oid]);
  1123.             if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1124.                 $entities[] = $entity;
  1125.             }
  1126.         }
  1128.         $postInsertIds = $persister->executeInserts();
  1130.         if ($postInsertIds) {
  1131.             // Persister returned post-insert IDs
  1132.             foreach ($postInsertIds as $postInsertId) {
  1133.                 $idField = $class->getSingleIdentifierFieldName();
  1134.                 $idValue = $this->convertSingleFieldIdentifierToPHPValue($class, $postInsertId['generatedId']);
  1136.                 $entity = $postInsertId['entity'];
  1137.                 $oid    = spl_object_id($entity);
  1139.                 $class->reflFields[$idField]->setValue($entity, $idValue);
  1141.                 $this->entityIdentifiers[$oid]            = [$idField => $idValue];
  1142.                 $this->entityStates[$oid]                 = self::STATE_MANAGED;
  1143.                 $this->originalEntityData[$oid][$idField] = $idValue;
  1145.                 $this->addToIdentityMap($entity);
  1146.             }
  1147.         } else {
  1148.             foreach ($insertionsForClass as $oid => $entity) {
  1149.                 if (! isset($this->entityIdentifiers[$oid])) {
  1150.                     //entity was not added to identity map because some identifiers are foreign keys to new entities.
  1151.                     //add it now
  1152.                     $this->addToEntityIdentifiersAndEntityMap($class, $oid, $entity);
  1153.                 }
  1154.             }
  1155.         }
  1157.         foreach ($entities as $entity) {
  1158.             $this->listenersInvoker->invoke($class, Events::postPersist, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  1159.         }
  1160.     }
  1162.     /**
  1163.      * @param object $entity
  1164.      * @psalm-param ClassMetadata<T> $class
  1165.      * @psalm-param T $entity
  1166.      *
  1167.      * @template T of object
  1168.      */
  1169.     private function addToEntityIdentifiersAndEntityMap(
  1170.         ClassMetadata $class,
  1171.         int $oid,
  1172.         $entity
  1173.     ): void {
  1174.         $identifier = [];
  1176.         foreach ($class->getIdentifierFieldNames() as $idField) {
  1177.             $origValue = $class->getFieldValue($entity, $idField);
  1179.             $value = null;
  1180.             if (isset($class->associationMappings[$idField])) {
  1181.                 // NOTE: Single Columns as associated identifiers only allowed - this constraint it is enforced.
  1182.                 $value = $this->getSingleIdentifierValue($origValue);
  1183.             }
  1185.             $identifier[$idField]                     = $value ?? $origValue;
  1186.             $this->originalEntityData[$oid][$idField] = $origValue;
  1187.         }
  1189.         $this->entityStates[$oid]      = self::STATE_MANAGED;
  1190.         $this->entityIdentifiers[$oid] = $identifier;
  1192.         $this->addToIdentityMap($entity);
  1193.     }
  1195.     /**
  1196.      * Executes all entity updates for entities of the specified type.
  1197.      */
  1198.     private function executeUpdates(ClassMetadata $class): void
  1199.     {
  1200.         $className        = $class->name;
  1201.         $persister        = $this->getEntityPersister($className);
  1202.         $preUpdateInvoke  = $this->listenersInvoker->getSubscribedSystems($class, Events::preUpdate);
  1203.         $postUpdateInvoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postUpdate);
  1205.         foreach ($this->entityUpdates as $oid => $entity) {
  1206.             if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
  1207.                 continue;
  1208.             }
  1210.             if ($preUpdateInvoke !== ListenersInvoker::INVOKE_NONE) {
  1211.                 $this->listenersInvoker->invoke($class, Events::preUpdate, $entity, new PreUpdateEventArgs($entity, $this->em, $this->getEntityChangeSet($entity)), $preUpdateInvoke);
  1213.                 $this->recomputeSingleEntityChangeSet($class, $entity);
  1214.             }
  1216.             if (! empty($this->entityChangeSets[$oid])) {
  1217.                 $persister->update($entity);
  1218.             }
  1220.             unset($this->entityUpdates[$oid]);
  1222.             if ($postUpdateInvoke !== ListenersInvoker::INVOKE_NONE) {
  1223.                 $this->listenersInvoker->invoke($class, Events::postUpdate, $entity, new LifecycleEventArgs($entity, $this->em), $postUpdateInvoke);
  1224.             }
  1225.         }
  1226.     }
  1228.     /**
  1229.      * Executes all entity deletions for entities of the specified type.
  1230.      */
  1231.     private function executeDeletions(ClassMetadata $class): void
  1232.     {
  1233.         $className = $class->name;
  1234.         $persister = $this->getEntityPersister($className);
  1235.         $invoke    = $this->listenersInvoker->getSubscribedSystems($class, Events::postRemove);
  1237.         foreach ($this->entityDeletions as $oid => $entity) {
  1238.             if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
  1239.                 continue;
  1240.             }
  1242.             $persister->delete($entity);
  1244.             unset(
  1245.                 $this->entityDeletions[$oid],
  1246.                 $this->entityIdentifiers[$oid],
  1247.                 $this->originalEntityData[$oid],
  1248.                 $this->entityStates[$oid]
  1249.             );
  1251.             // Entity with this $oid after deletion treated as NEW, even if the $oid
  1252.             // is obtained by a new entity because the old one went out of scope.
  1253.             //$this->entityStates[$oid] = self::STATE_NEW;
  1254.             if (! $class->isIdentifierNatural()) {
  1255.                 $class->reflFields[$class->identifier[0]]->setValue($entity, null);
  1256.             }
  1258.             if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1259.                 $this->listenersInvoker->invoke($class, Events::postRemove, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  1260.             }
  1261.         }
  1262.     }
  1264.     /**
  1265.      * Gets the commit order.
  1266.      *
  1267.      * @return list<object>
  1268.      */
  1269.     private function getCommitOrder(): array
  1270.     {
  1271.         $calc = $this->getCommitOrderCalculator();
  1273.         // See if there are any new classes in the changeset, that are not in the
  1274.         // commit order graph yet (don't have a node).
  1275.         // We have to inspect changeSet to be able to correctly build dependencies.
  1276.         // It is not possible to use IdentityMap here because post inserted ids
  1277.         // are not yet available.
  1278.         $newNodes = [];
  1280.         foreach (array_merge($this->entityInsertions, $this->entityUpdates, $this->entityDeletions) as $entity) {
  1281.             $class = $this->em->getClassMetadata(get_class($entity));
  1283.             if ($calc->hasNode($class->name)) {
  1284.                 continue;
  1285.             }
  1287.             $calc->addNode($class->name, $class);
  1289.             $newNodes[] = $class;
  1290.         }
  1292.         // Calculate dependencies for new nodes
  1293.         while ($class = array_pop($newNodes)) {
  1294.             foreach ($class->associationMappings as $assoc) {
  1295.                 if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1296.                     continue;
  1297.                 }
  1299.                 $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  1301.                 if (! $calc->hasNode($targetClass->name)) {
  1302.                     $calc->addNode($targetClass->name, $targetClass);
  1304.                     $newNodes[] = $targetClass;
  1305.                 }
  1307.                 $joinColumns = reset($assoc['joinColumns']);
  1309.                 $calc->addDependency($targetClass->name, $class->name, (int) empty($joinColumns['nullable']));
  1311.                 // If the target class has mapped subclasses, these share the same dependency.
  1312.                 if (! $targetClass->subClasses) {
  1313.                     continue;
  1314.                 }
  1316.                 foreach ($targetClass->subClasses as $subClassName) {
  1317.                     $targetSubClass = $this->em->getClassMetadata($subClassName);
  1319.                     if (! $calc->hasNode($subClassName)) {
  1320.                         $calc->addNode($targetSubClass->name, $targetSubClass);
  1322.                         $newNodes[] = $targetSubClass;
  1323.                     }
  1325.                     $calc->addDependency($targetSubClass->name, $class->name, 1);
  1326.                 }
  1327.             }
  1328.         }
  1330.         return $calc->sort();
  1331.     }
  1333.     /**
  1334.      * Schedules an entity for insertion into the database.
  1335.      * If the entity already has an identifier, it will be added to the identity map.
  1336.      *
  1337.      * @param object $entity The entity to schedule for insertion.
  1338.      *
  1339.      * @return void
  1340.      *
  1341.      * @throws ORMInvalidArgumentException
  1342.      * @throws InvalidArgumentException
  1343.      */
  1344.     public function scheduleForInsert($entity)
  1345.     {
  1346.         $oid = spl_object_id($entity);
  1348.         if (isset($this->entityUpdates[$oid])) {
  1349.             throw new InvalidArgumentException('Dirty entity can not be scheduled for insertion.');
  1350.         }
  1352.         if (isset($this->entityDeletions[$oid])) {
  1353.             throw ORMInvalidArgumentException::scheduleInsertForRemovedEntity($entity);
  1354.         }
  1356.         if (isset($this->originalEntityData[$oid]) && ! isset($this->entityInsertions[$oid])) {
  1357.             throw ORMInvalidArgumentException::scheduleInsertForManagedEntity($entity);
  1358.         }
  1360.         if (isset($this->entityInsertions[$oid])) {
  1361.             throw ORMInvalidArgumentException::scheduleInsertTwice($entity);
  1362.         }
  1364.         $this->entityInsertions[$oid] = $entity;
  1366.         if (isset($this->entityIdentifiers[$oid])) {
  1367.             $this->addToIdentityMap($entity);
  1368.         }
  1370.         if ($entity instanceof NotifyPropertyChanged) {
  1371.             $entity->addPropertyChangedListener($this);
  1372.         }
  1373.     }
  1375.     /**
  1376.      * Checks whether an entity is scheduled for insertion.
  1377.      *
  1378.      * @param object $entity
  1379.      *
  1380.      * @return bool
  1381.      */
  1382.     public function isScheduledForInsert($entity)
  1383.     {
  1384.         return isset($this->entityInsertions[spl_object_id($entity)]);
  1385.     }
  1387.     /**
  1388.      * Schedules an entity for being updated.
  1389.      *
  1390.      * @param object $entity The entity to schedule for being updated.
  1391.      *
  1392.      * @return void
  1393.      *
  1394.      * @throws ORMInvalidArgumentException
  1395.      */
  1396.     public function scheduleForUpdate($entity)
  1397.     {
  1398.         $oid = spl_object_id($entity);
  1400.         if (! isset($this->entityIdentifiers[$oid])) {
  1401.             throw ORMInvalidArgumentException::entityHasNoIdentity($entity, 'scheduling for update');
  1402.         }
  1404.         if (isset($this->entityDeletions[$oid])) {
  1405.             throw ORMInvalidArgumentException::entityIsRemoved($entity, 'schedule for update');
  1406.         }
  1408.         if (! isset($this->entityUpdates[$oid]) && ! isset($this->entityInsertions[$oid])) {
  1409.             $this->entityUpdates[$oid] = $entity;
  1410.         }
  1411.     }
  1413.     /**
  1414.      * INTERNAL:
  1415.      * Schedules an extra update that will be executed immediately after the
  1416.      * regular entity updates within the currently running commit cycle.
  1417.      *
  1418.      * Extra updates for entities are stored as (entity, changeset) tuples.
  1419.      *
  1420.      * @param object $entity The entity for which to schedule an extra update.
  1421.      * @psalm-param array<string, array{mixed, mixed}>  $changeset The changeset of the entity (what to update).
  1422.      *
  1423.      * @return void
  1424.      *
  1425.      * @ignore
  1426.      */
  1427.     public function scheduleExtraUpdate($entity, array $changeset)
  1428.     {
  1429.         $oid         = spl_object_id($entity);
  1430.         $extraUpdate = [$entity, $changeset];
  1432.         if (isset($this->extraUpdates[$oid])) {
  1433.             [, $changeset2] = $this->extraUpdates[$oid];
  1435.             $extraUpdate = [$entity, $changeset + $changeset2];
  1436.         }
  1438.         $this->extraUpdates[$oid] = $extraUpdate;
  1439.     }
  1441.     /**
  1442.      * Checks whether an entity is registered as dirty in the unit of work.
  1443.      * Note: Is not very useful currently as dirty entities are only registered
  1444.      * at commit time.
  1445.      *
  1446.      * @param object $entity
  1447.      *
  1448.      * @return bool
  1449.      */
  1450.     public function isScheduledForUpdate($entity)
  1451.     {
  1452.         return isset($this->entityUpdates[spl_object_id($entity)]);
  1453.     }
  1455.     /**
  1456.      * Checks whether an entity is registered to be checked in the unit of work.
  1457.      *
  1458.      * @param object $entity
  1459.      *
  1460.      * @return bool
  1461.      */
  1462.     public function isScheduledForDirtyCheck($entity)
  1463.     {
  1464.         $rootEntityName = $this->em->getClassMetadata(get_class($entity))->rootEntityName;
  1466.         return isset($this->scheduledForSynchronization[$rootEntityName][spl_object_id($entity)]);
  1467.     }
  1469.     /**
  1470.      * INTERNAL:
  1471.      * Schedules an entity for deletion.
  1472.      *
  1473.      * @param object $entity
  1474.      *
  1475.      * @return void
  1476.      */
  1477.     public function scheduleForDelete($entity)
  1478.     {
  1479.         $oid = spl_object_id($entity);
  1481.         if (isset($this->entityInsertions[$oid])) {
  1482.             if ($this->isInIdentityMap($entity)) {
  1483.                 $this->removeFromIdentityMap($entity);
  1484.             }
  1486.             unset($this->entityInsertions[$oid], $this->entityStates[$oid]);
  1488.             return; // entity has not been persisted yet, so nothing more to do.
  1489.         }
  1491.         if (! $this->isInIdentityMap($entity)) {
  1492.             return;
  1493.         }
  1495.         $this->removeFromIdentityMap($entity);
  1497.         unset($this->entityUpdates[$oid]);
  1499.         if (! isset($this->entityDeletions[$oid])) {
  1500.             $this->entityDeletions[$oid] = $entity;
  1501.             $this->entityStates[$oid]    = self::STATE_REMOVED;
  1502.         }
  1503.     }
  1505.     /**
  1506.      * Checks whether an entity is registered as removed/deleted with the unit
  1507.      * of work.
  1508.      *
  1509.      * @param object $entity
  1510.      *
  1511.      * @return bool
  1512.      */
  1513.     public function isScheduledForDelete($entity)
  1514.     {
  1515.         return isset($this->entityDeletions[spl_object_id($entity)]);
  1516.     }
  1518.     /**
  1519.      * Checks whether an entity is scheduled for insertion, update or deletion.
  1520.      *
  1521.      * @param object $entity
  1522.      *
  1523.      * @return bool
  1524.      */
  1525.     public function isEntityScheduled($entity)
  1526.     {
  1527.         $oid = spl_object_id($entity);
  1529.         return isset($this->entityInsertions[$oid])
  1530.             || isset($this->entityUpdates[$oid])
  1531.             || isset($this->entityDeletions[$oid]);
  1532.     }
  1534.     /**
  1535.      * INTERNAL:
  1536.      * Registers an entity in the identity map.
  1537.      * Note that entities in a hierarchy are registered with the class name of
  1538.      * the root entity.
  1539.      *
  1540.      * @param object $entity The entity to register.
  1541.      *
  1542.      * @return bool TRUE if the registration was successful, FALSE if the identity of
  1543.      * the entity in question is already managed.
  1544.      *
  1545.      * @throws ORMInvalidArgumentException
  1546.      *
  1547.      * @ignore
  1548.      */
  1549.     public function addToIdentityMap($entity)
  1550.     {
  1551.         $classMetadata = $this->em->getClassMetadata(get_class($entity));
  1552.         $identifier    = $this->entityIdentifiers[spl_object_id($entity)];
  1554.         if (empty($identifier) || in_array(null, $identifier, true)) {
  1555.             throw ORMInvalidArgumentException::entityWithoutIdentity($classMetadata->name, $entity);
  1556.         }
  1558.         $idHash    = implode(' ', $identifier);
  1559.         $className = $classMetadata->rootEntityName;
  1561.         if (isset($this->identityMap[$className][$idHash])) {
  1562.             return false;
  1563.         }
  1565.         $this->identityMap[$className][$idHash] = $entity;
  1567.         return true;
  1568.     }
  1570.     /**
  1571.      * Gets the state of an entity with regard to the current unit of work.
  1572.      *
  1573.      * @param object   $entity
  1574.      * @param int|null $assume The state to assume if the state is not yet known (not MANAGED or REMOVED).
  1575.      *                         This parameter can be set to improve performance of entity state detection
  1576.      *                         by potentially avoiding a database lookup if the distinction between NEW and DETACHED
  1577.      *                         is either known or does not matter for the caller of the method.
  1578.      * @psalm-param self::STATE_*|null $assume
  1579.      *
  1580.      * @return int The entity state.
  1581.      * @psalm-return self::STATE_*
  1582.      */
  1583.     public function getEntityState($entity, $assume = null)
  1584.     {
  1585.         $oid = spl_object_id($entity);
  1587.         if (isset($this->entityStates[$oid])) {
  1588.             return $this->entityStates[$oid];
  1589.         }
  1591.         if ($assume !== null) {
  1592.             return $assume;
  1593.         }
  1595.         // State can only be NEW or DETACHED, because MANAGED/REMOVED states are known.
  1596.         // Note that you can not remember the NEW or DETACHED state in _entityStates since
  1597.         // the UoW does not hold references to such objects and the object hash can be reused.
  1598.         // More generally because the state may "change" between NEW/DETACHED without the UoW being aware of it.
  1599.         $class = $this->em->getClassMetadata(get_class($entity));
  1600.         $id    = $class->getIdentifierValues($entity);
  1602.         if (! $id) {
  1603.             return self::STATE_NEW;
  1604.         }
  1606.         if ($class->containsForeignIdentifier) {
  1607.             $id = $this->identifierFlattener->flattenIdentifier($class, $id);
  1608.         }
  1610.         switch (true) {
  1611.             case $class->isIdentifierNatural():
  1612.                 // Check for a version field, if available, to avoid a db lookup.
  1613.                 if ($class->isVersioned) {
  1614.                     return $class->getFieldValue($entity, $class->versionField)
  1615.                         ? self::STATE_DETACHED
  1616.                         : self::STATE_NEW;
  1617.                 }
  1619.                 // Last try before db lookup: check the identity map.
  1620.                 if ($this->tryGetById($id, $class->rootEntityName)) {
  1621.                     return self::STATE_DETACHED;
  1622.                 }
  1624.                 // db lookup
  1625.                 if ($this->getEntityPersister($class->name)->exists($entity)) {
  1626.                     return self::STATE_DETACHED;
  1627.                 }
  1629.                 return self::STATE_NEW;
  1631.             case ! $class->idGenerator->isPostInsertGenerator():
  1632.                 // if we have a pre insert generator we can't be sure that having an id
  1633.                 // really means that the entity exists. We have to verify this through
  1634.                 // the last resort: a db lookup
  1636.                 // Last try before db lookup: check the identity map.
  1637.                 if ($this->tryGetById($id, $class->rootEntityName)) {
  1638.                     return self::STATE_DETACHED;
  1639.                 }
  1641.                 // db lookup
  1642.                 if ($this->getEntityPersister($class->name)->exists($entity)) {
  1643.                     return self::STATE_DETACHED;
  1644.                 }
  1646.                 return self::STATE_NEW;
  1648.             default:
  1649.                 return self::STATE_DETACHED;
  1650.         }
  1651.     }
  1653.     /**
  1654.      * INTERNAL:
  1655.      * Removes an entity from the identity map. This effectively detaches the
  1656.      * entity from the persistence management of Doctrine.
  1657.      *
  1658.      * @param object $entity
  1659.      *
  1660.      * @return bool
  1661.      *
  1662.      * @throws ORMInvalidArgumentException
  1663.      *
  1664.      * @ignore
  1665.      */
  1666.     public function removeFromIdentityMap($entity)
  1667.     {
  1668.         $oid           = spl_object_id($entity);
  1669.         $classMetadata = $this->em->getClassMetadata(get_class($entity));
  1670.         $idHash        = implode(' ', $this->entityIdentifiers[$oid]);
  1672.         if ($idHash === '') {
  1673.             throw ORMInvalidArgumentException::entityHasNoIdentity($entity, 'remove from identity map');
  1674.         }
  1676.         $className = $classMetadata->rootEntityName;
  1678.         if (isset($this->identityMap[$className][$idHash])) {
  1679.             unset($this->identityMap[$className][$idHash], $this->readOnlyObjects[$oid]);
  1681.             //$this->entityStates[$oid] = self::STATE_DETACHED;
  1683.             return true;
  1684.         }
  1686.         return false;
  1687.     }
  1689.     /**
  1690.      * INTERNAL:
  1691.      * Gets an entity in the identity map by its identifier hash.
  1692.      *
  1693.      * @param string $idHash
  1694.      * @param string $rootClassName
  1695.      *
  1696.      * @return object
  1697.      *
  1698.      * @ignore
  1699.      */
  1700.     public function getByIdHash($idHash, $rootClassName)
  1701.     {
  1702.         return $this->identityMap[$rootClassName][$idHash];
  1703.     }
  1705.     /**
  1706.      * INTERNAL:
  1707.      * Tries to get an entity by its identifier hash. If no entity is found for
  1708.      * the given hash, FALSE is returned.
  1709.      *
  1710.      * @param mixed  $idHash        (must be possible to cast it to string)
  1711.      * @param string $rootClassName
  1712.      *
  1713.      * @return false|object The found entity or FALSE.
  1714.      *
  1715.      * @ignore
  1716.      */
  1717.     public function tryGetByIdHash($idHash, $rootClassName)
  1718.     {
  1719.         $stringIdHash = (string) $idHash;
  1721.         return $this->identityMap[$rootClassName][$stringIdHash] ?? false;
  1722.     }
  1724.     /**
  1725.      * Checks whether an entity is registered in the identity map of this UnitOfWork.
  1726.      *
  1727.      * @param object $entity
  1728.      *
  1729.      * @return bool
  1730.      */
  1731.     public function isInIdentityMap($entity)
  1732.     {
  1733.         $oid = spl_object_id($entity);
  1735.         if (empty($this->entityIdentifiers[$oid])) {
  1736.             return false;
  1737.         }
  1739.         $classMetadata = $this->em->getClassMetadata(get_class($entity));
  1740.         $idHash        = implode(' ', $this->entityIdentifiers[$oid]);
  1742.         return isset($this->identityMap[$classMetadata->rootEntityName][$idHash]);
  1743.     }
  1745.     /**
  1746.      * INTERNAL:
  1747.      * Checks whether an identifier hash exists in the identity map.
  1748.      *
  1749.      * @param string $idHash
  1750.      * @param string $rootClassName
  1751.      *
  1752.      * @return bool
  1753.      *
  1754.      * @ignore
  1755.      */
  1756.     public function containsIdHash($idHash, $rootClassName)
  1757.     {
  1758.         return isset($this->identityMap[$rootClassName][$idHash]);
  1759.     }
  1761.     /**
  1762.      * Persists an entity as part of the current unit of work.
  1763.      *
  1764.      * @param object $entity The entity to persist.
  1765.      *
  1766.      * @return void
  1767.      */
  1768.     public function persist($entity)
  1769.     {
  1770.         $visited = [];
  1772.         $this->doPersist($entity, $visited);
  1773.     }
  1775.     /**
  1776.      * Persists an entity as part of the current unit of work.
  1777.      *
  1778.      * This method is internally called during persist() cascades as it tracks
  1779.      * the already visited entities to prevent infinite recursions.
  1780.      *
  1781.      * @param object $entity The entity to persist.
  1782.      * @psalm-param array<int, object> $visited The already visited entities.
  1783.      *
  1784.      * @throws ORMInvalidArgumentException
  1785.      * @throws UnexpectedValueException
  1786.      */
  1787.     private function doPersist($entity, array &$visited): void
  1788.     {
  1789.         $oid = spl_object_id($entity);
  1791.         if (isset($visited[$oid])) {
  1792.             return; // Prevent infinite recursion
  1793.         }
  1795.         $visited[$oid] = $entity; // Mark visited
  1797.         $class = $this->em->getClassMetadata(get_class($entity));
  1799.         // We assume NEW, so DETACHED entities result in an exception on flush (constraint violation).
  1800.         // If we would detect DETACHED here we would throw an exception anyway with the same
  1801.         // consequences (not recoverable/programming error), so just assuming NEW here
  1802.         // lets us avoid some database lookups for entities with natural identifiers.
  1803.         $entityState = $this->getEntityState($entity, self::STATE_NEW);
  1805.         switch ($entityState) {
  1806.             case self::STATE_MANAGED:
  1807.                 // Nothing to do, except if policy is "deferred explicit"
  1808.                 if ($class->isChangeTrackingDeferredExplicit()) {
  1809.                     $this->scheduleForDirtyCheck($entity);
  1810.                 }
  1812.                 break;
  1814.             case self::STATE_NEW:
  1815.                 $this->persistNew($class, $entity);
  1816.                 break;
  1818.             case self::STATE_REMOVED:
  1819.                 // Entity becomes managed again
  1820.                 unset($this->entityDeletions[$oid]);
  1821.                 $this->addToIdentityMap($entity);
  1823.                 $this->entityStates[$oid] = self::STATE_MANAGED;
  1825.                 if ($class->isChangeTrackingDeferredExplicit()) {
  1826.                     $this->scheduleForDirtyCheck($entity);
  1827.                 }
  1829.                 break;
  1831.             case self::STATE_DETACHED:
  1832.                 // Can actually not happen right now since we assume STATE_NEW.
  1833.                 throw ORMInvalidArgumentException::detachedEntityCannot($entity, 'persisted');
  1835.             default:
  1836.                 throw new UnexpectedValueException(sprintf(
  1837.                     'Unexpected entity state: %s. %s',
  1838.                     $entityState,
  1839.                     self::objToStr($entity)
  1840.                 ));
  1841.         }
  1843.         $this->cascadePersist($entity, $visited);
  1844.     }
  1846.     /**
  1847.      * Deletes an entity as part of the current unit of work.
  1848.      *
  1849.      * @param object $entity The entity to remove.
  1850.      *
  1851.      * @return void
  1852.      */
  1853.     public function remove($entity)
  1854.     {
  1855.         $visited = [];
  1857.         $this->doRemove($entity, $visited);
  1858.     }
  1860.     /**
  1861.      * Deletes an entity as part of the current unit of work.
  1862.      *
  1863.      * This method is internally called during delete() cascades as it tracks
  1864.      * the already visited entities to prevent infinite recursions.
  1865.      *
  1866.      * @param object $entity The entity to delete.
  1867.      * @psalm-param array<int, object> $visited The map of the already visited entities.
  1868.      *
  1869.      * @throws ORMInvalidArgumentException If the instance is a detached entity.
  1870.      * @throws UnexpectedValueException
  1871.      */
  1872.     private function doRemove($entity, array &$visited): void
  1873.     {
  1874.         $oid = spl_object_id($entity);
  1876.         if (isset($visited[$oid])) {
  1877.             return; // Prevent infinite recursion
  1878.         }
  1880.         $visited[$oid] = $entity; // mark visited
  1882.         // Cascade first, because scheduleForDelete() removes the entity from the identity map, which
  1883.         // can cause problems when a lazy proxy has to be initialized for the cascade operation.
  1884.         $this->cascadeRemove($entity, $visited);
  1886.         $class       = $this->em->getClassMetadata(get_class($entity));
  1887.         $entityState = $this->getEntityState($entity);
  1889.         switch ($entityState) {
  1890.             case self::STATE_NEW:
  1891.             case self::STATE_REMOVED:
  1892.                 // nothing to do
  1893.                 break;
  1895.             case self::STATE_MANAGED:
  1896.                 $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preRemove);
  1898.                 if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1899.                     $this->listenersInvoker->invoke($class, Events::preRemove, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  1900.                 }
  1902.                 $this->scheduleForDelete($entity);
  1903.                 break;
  1905.             case self::STATE_DETACHED:
  1906.                 throw ORMInvalidArgumentException::detachedEntityCannot($entity, 'removed');
  1908.             default:
  1909.                 throw new UnexpectedValueException(sprintf(
  1910.                     'Unexpected entity state: %s. %s',
  1911.                     $entityState,
  1912.                     self::objToStr($entity)
  1913.                 ));
  1914.         }
  1915.     }
  1917.     /**
  1918.      * Merges the state of the given detached entity into this UnitOfWork.
  1919.      *
  1920.      * @deprecated 2.7 This method is being removed from the ORM and won't have any replacement
  1921.      *
  1922.      * @param object $entity
  1923.      *
  1924.      * @return object The managed copy of the entity.
  1925.      *
  1926.      * @throws OptimisticLockException If the entity uses optimistic locking through a version
  1927.      *         attribute and the version check against the managed copy fails.
  1928.      */
  1929.     public function merge($entity)
  1930.     {
  1931.         $visited = [];
  1933.         return $this->doMerge($entity, $visited);
  1934.     }
  1936.     /**
  1937.      * Executes a merge operation on an entity.
  1938.      *
  1939.      * @param object   $entity
  1940.      * @param string[] $assoc
  1941.      * @psalm-param array<int, object> $visited
  1942.      *
  1943.      * @return object The managed copy of the entity.
  1944.      *
  1945.      * @throws OptimisticLockException If the entity uses optimistic locking through a version
  1946.      *         attribute and the version check against the managed copy fails.
  1947.      * @throws ORMInvalidArgumentException If the entity instance is NEW.
  1948.      * @throws EntityNotFoundException if an assigned identifier is used in the entity, but none is provided.
  1949.      */
  1950.     private function doMerge(
  1951.         $entity,
  1952.         array &$visited,
  1953.         $prevManagedCopy = null,
  1954.         array $assoc = []
  1955.     ) {
  1956.         $oid = spl_object_id($entity);
  1958.         if (isset($visited[$oid])) {
  1959.             $managedCopy = $visited[$oid];
  1961.             if ($prevManagedCopy !== null) {
  1962.                 $this->updateAssociationWithMergedEntity($entity, $assoc, $prevManagedCopy, $managedCopy);
  1963.             }
  1965.             return $managedCopy;
  1966.         }
  1968.         $class = $this->em->getClassMetadata(get_class($entity));
  1970.         // First we assume DETACHED, although it can still be NEW but we can avoid
  1971.         // an extra db-roundtrip this way. If it is not MANAGED but has an identity,
  1972.         // we need to fetch it from the db anyway in order to merge.
  1973.         // MANAGED entities are ignored by the merge operation.
  1974.         $managedCopy = $entity;
  1976.         if ($this->getEntityState($entity, self::STATE_DETACHED) !== self::STATE_MANAGED) {
  1977.             // Try to look the entity up in the identity map.
  1978.             $id = $class->getIdentifierValues($entity);
  1980.             // If there is no ID, it is actually NEW.
  1981.             if (! $id) {
  1982.                 $managedCopy = $this->newInstance($class);
  1984.                 $this->mergeEntityStateIntoManagedCopy($entity, $managedCopy);
  1985.                 $this->persistNew($class, $managedCopy);
  1986.             } else {
  1987.                 $flatId = $class->containsForeignIdentifier
  1988.                     ? $this->identifierFlattener->flattenIdentifier($class, $id)
  1989.                     : $id;
  1991.                 $managedCopy = $this->tryGetById($flatId, $class->rootEntityName);
  1993.                 if ($managedCopy) {
  1994.                     // We have the entity in-memory already, just make sure its not removed.
  1995.                     if ($this->getEntityState($managedCopy) === self::STATE_REMOVED) {
  1996.                         throw ORMInvalidArgumentException::entityIsRemoved($managedCopy, 'merge');
  1997.                     }
  1998.                 } else {
  1999.                     // We need to fetch the managed copy in order to merge.
  2000.                     $managedCopy = $this->em->find($class->name, $flatId);
  2001.                 }
  2003.                 if ($managedCopy === null) {
  2004.                     // If the identifier is ASSIGNED, it is NEW, otherwise an error
  2005.                     // since the managed entity was not found.
  2006.                     if (! $class->isIdentifierNatural()) {
  2007.                         throw EntityNotFoundException::fromClassNameAndIdentifier(
  2008.                             $class->getName(),
  2009.                             $this->identifierFlattener->flattenIdentifier($class, $id)
  2010.                         );
  2011.                     }
  2013.                     $managedCopy = $this->newInstance($class);
  2014.                     $class->setIdentifierValues($managedCopy, $id);
  2016.                     $this->mergeEntityStateIntoManagedCopy($entity, $managedCopy);
  2017.                     $this->persistNew($class, $managedCopy);
  2018.                 } else {
  2019.                     $this->ensureVersionMatch($class, $entity, $managedCopy);
  2020.                     $this->mergeEntityStateIntoManagedCopy($entity, $managedCopy);
  2021.                 }
  2022.             }
  2024.             $visited[$oid] = $managedCopy; // mark visited
  2026.             if ($class->isChangeTrackingDeferredExplicit()) {
  2027.                 $this->scheduleForDirtyCheck($entity);
  2028.             }
  2029.         }
  2031.         if ($prevManagedCopy !== null) {
  2032.             $this->updateAssociationWithMergedEntity($entity, $assoc, $prevManagedCopy, $managedCopy);
  2033.         }
  2035.         // Mark the managed copy visited as well
  2036.         $visited[spl_object_id($managedCopy)] = $managedCopy;
  2038.         $this->cascadeMerge($entity, $managedCopy, $visited);
  2040.         return $managedCopy;
  2041.     }
  2043.     /**
  2044.      * @param object $entity
  2045.      * @param object $managedCopy
  2046.      * @psalm-param ClassMetadata<T> $class
  2047.      * @psalm-param T $entity
  2048.      * @psalm-param T $managedCopy
  2049.      *
  2050.      * @throws OptimisticLockException
  2051.      *
  2052.      * @template T of object
  2053.      */
  2054.     private function ensureVersionMatch(
  2055.         ClassMetadata $class,
  2056.         $entity,
  2057.         $managedCopy
  2058.     ): void {
  2059.         if (! ($class->isVersioned && $this->isLoaded($managedCopy) && $this->isLoaded($entity))) {
  2060.             return;
  2061.         }
  2063.         $reflField          = $class->reflFields[$class->versionField];
  2064.         $managedCopyVersion = $reflField->getValue($managedCopy);
  2065.         $entityVersion      = $reflField->getValue($entity);
  2067.         // Throw exception if versions don't match.
  2068.         // phpcs:ignore SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedEqualOperator
  2069.         if ($managedCopyVersion == $entityVersion) {
  2070.             return;
  2071.         }
  2073.         throw OptimisticLockException::lockFailedVersionMismatch($entity, $entityVersion, $managedCopyVersion);
  2074.     }
  2076.     /**
  2077.      * Tests if an entity is loaded - must either be a loaded proxy or not a proxy
  2078.      *
  2079.      * @param object $entity
  2080.      */
  2081.     private function isLoaded($entity): bool
  2082.     {
  2083.         return ! ($entity instanceof Proxy) || $entity->__isInitialized();
  2084.     }
  2086.     /**
  2087.      * Sets/adds associated managed copies into the previous entity's association field
  2088.      *
  2089.      * @param object   $entity
  2090.      * @param string[] $association
  2091.      */
  2092.     private function updateAssociationWithMergedEntity(
  2093.         $entity,
  2094.         array $association,
  2095.         $previousManagedCopy,
  2096.         $managedCopy
  2097.     ): void {
  2098.         $assocField = $association['fieldName'];
  2099.         $prevClass  = $this->em->getClassMetadata(get_class($previousManagedCopy));
  2101.         if ($association['type'] & ClassMetadata::TO_ONE) {
  2102.             $prevClass->reflFields[$assocField]->setValue($previousManagedCopy, $managedCopy);
  2104.             return;
  2105.         }
  2107.         $value   = $prevClass->reflFields[$assocField]->getValue($previousManagedCopy);
  2108.         $value[] = $managedCopy;
  2110.         if ($association['type'] === ClassMetadata::ONE_TO_MANY) {
  2111.             $class = $this->em->getClassMetadata(get_class($entity));
  2113.             $class->reflFields[$association['mappedBy']]->setValue($managedCopy, $previousManagedCopy);
  2114.         }
  2115.     }
  2117.     /**
  2118.      * Detaches an entity from the persistence management. It's persistence will
  2119.      * no longer be managed by Doctrine.
  2120.      *
  2121.      * @param object $entity The entity to detach.
  2122.      *
  2123.      * @return void
  2124.      */
  2125.     public function detach($entity)
  2126.     {
  2127.         $visited = [];
  2129.         $this->doDetach($entity, $visited);
  2130.     }
  2132.     /**
  2133.      * Executes a detach operation on the given entity.
  2134.      *
  2135.      * @param object  $entity
  2136.      * @param mixed[] $visited
  2137.      * @param bool    $noCascade if true, don't cascade detach operation.
  2138.      */
  2139.     private function doDetach(
  2140.         $entity,
  2141.         array &$visited,
  2142.         bool $noCascade = false
  2143.     ): void {
  2144.         $oid = spl_object_id($entity);
  2146.         if (isset($visited[$oid])) {
  2147.             return; // Prevent infinite recursion
  2148.         }
  2150.         $visited[$oid] = $entity; // mark visited
  2152.         switch ($this->getEntityState($entity, self::STATE_DETACHED)) {
  2153.             case self::STATE_MANAGED:
  2154.                 if ($this->isInIdentityMap($entity)) {
  2155.                     $this->removeFromIdentityMap($entity);
  2156.                 }
  2158.                 unset(
  2159.                     $this->entityInsertions[$oid],
  2160.                     $this->entityUpdates[$oid],
  2161.                     $this->entityDeletions[$oid],
  2162.                     $this->entityIdentifiers[$oid],
  2163.                     $this->entityStates[$oid],
  2164.                     $this->originalEntityData[$oid]
  2165.                 );
  2166.                 break;
  2167.             case self::STATE_NEW:
  2168.             case self::STATE_DETACHED:
  2169.                 return;
  2170.         }
  2172.         if (! $noCascade) {
  2173.             $this->cascadeDetach($entity, $visited);
  2174.         }
  2175.     }
  2177.     /**
  2178.      * Refreshes the state of the given entity from the database, overwriting
  2179.      * any local, unpersisted changes.
  2180.      *
  2181.      * @param object $entity The entity to refresh.
  2182.      *
  2183.      * @return void
  2184.      *
  2185.      * @throws InvalidArgumentException If the entity is not MANAGED.
  2186.      */
  2187.     public function refresh($entity)
  2188.     {
  2189.         $visited = [];
  2191.         $this->doRefresh($entity, $visited);
  2192.     }
  2194.     /**
  2195.      * Executes a refresh operation on an entity.
  2196.      *
  2197.      * @param object $entity The entity to refresh.
  2198.      * @psalm-param array<int, object>  $visited The already visited entities during cascades.
  2199.      *
  2200.      * @throws ORMInvalidArgumentException If the entity is not MANAGED.
  2201.      */
  2202.     private function doRefresh($entity, array &$visited): void
  2203.     {
  2204.         $oid = spl_object_id($entity);
  2206.         if (isset($visited[$oid])) {
  2207.             return; // Prevent infinite recursion
  2208.         }
  2210.         $visited[$oid] = $entity; // mark visited
  2212.         $class = $this->em->getClassMetadata(get_class($entity));
  2214.         if ($this->getEntityState($entity) !== self::STATE_MANAGED) {
  2215.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  2216.         }
  2218.         $this->getEntityPersister($class->name)->refresh(
  2219.             array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
  2220.             $entity
  2221.         );
  2223.         $this->cascadeRefresh($entity, $visited);
  2224.     }
  2226.     /**
  2227.      * Cascades a refresh operation to associated entities.
  2228.      *
  2229.      * @param object $entity
  2230.      * @psalm-param array<int, object> $visited
  2231.      */
  2232.     private function cascadeRefresh($entity, array &$visited): void
  2233.     {
  2234.         $class = $this->em->getClassMetadata(get_class($entity));
  2236.         $associationMappings = array_filter(
  2237.             $class->associationMappings,
  2238.             static function ($assoc) {
  2239.                 return $assoc['isCascadeRefresh'];
  2240.             }
  2241.         );
  2243.         foreach ($associationMappings as $assoc) {
  2244.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2246.             switch (true) {
  2247.                 case $relatedEntities instanceof PersistentCollection:
  2248.                     // Unwrap so that foreach() does not initialize
  2249.                     $relatedEntities = $relatedEntities->unwrap();
  2250.                     // break; is commented intentionally!
  2252.                 case $relatedEntities instanceof Collection:
  2253.                 case is_array($relatedEntities):
  2254.                     foreach ($relatedEntities as $relatedEntity) {
  2255.                         $this->doRefresh($relatedEntity, $visited);
  2256.                     }
  2258.                     break;
  2260.                 case $relatedEntities !== null:
  2261.                     $this->doRefresh($relatedEntities, $visited);
  2262.                     break;
  2264.                 default:
  2265.                     // Do nothing
  2266.             }
  2267.         }
  2268.     }
  2270.     /**
  2271.      * Cascades a detach operation to associated entities.
  2272.      *
  2273.      * @param object             $entity
  2274.      * @param array<int, object> $visited
  2275.      */
  2276.     private function cascadeDetach($entity, array &$visited): void
  2277.     {
  2278.         $class = $this->em->getClassMetadata(get_class($entity));
  2280.         $associationMappings = array_filter(
  2281.             $class->associationMappings,
  2282.             static function ($assoc) {
  2283.                 return $assoc['isCascadeDetach'];
  2284.             }
  2285.         );
  2287.         foreach ($associationMappings as $assoc) {
  2288.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2290.             switch (true) {
  2291.                 case $relatedEntities instanceof PersistentCollection:
  2292.                     // Unwrap so that foreach() does not initialize
  2293.                     $relatedEntities = $relatedEntities->unwrap();
  2294.                     // break; is commented intentionally!
  2296.                 case $relatedEntities instanceof Collection:
  2297.                 case is_array($relatedEntities):
  2298.                     foreach ($relatedEntities as $relatedEntity) {
  2299.                         $this->doDetach($relatedEntity, $visited);
  2300.                     }
  2302.                     break;
  2304.                 case $relatedEntities !== null:
  2305.                     $this->doDetach($relatedEntities, $visited);
  2306.                     break;
  2308.                 default:
  2309.                     // Do nothing
  2310.             }
  2311.         }
  2312.     }
  2314.     /**
  2315.      * Cascades a merge operation to associated entities.
  2316.      *
  2317.      * @param object $entity
  2318.      * @param object $managedCopy
  2319.      * @psalm-param array<int, object> $visited
  2320.      */
  2321.     private function cascadeMerge($entity, $managedCopy, array &$visited): void
  2322.     {
  2323.         $class = $this->em->getClassMetadata(get_class($entity));
  2325.         $associationMappings = array_filter(
  2326.             $class->associationMappings,
  2327.             static function ($assoc) {
  2328.                 return $assoc['isCascadeMerge'];
  2329.             }
  2330.         );
  2332.         foreach ($associationMappings as $assoc) {
  2333.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2335.             if ($relatedEntities instanceof Collection) {
  2336.                 if ($relatedEntities === $class->reflFields[$assoc['fieldName']]->getValue($managedCopy)) {
  2337.                     continue;
  2338.                 }
  2340.                 if ($relatedEntities instanceof PersistentCollection) {
  2341.                     // Unwrap so that foreach() does not initialize
  2342.                     $relatedEntities = $relatedEntities->unwrap();
  2343.                 }
  2345.                 foreach ($relatedEntities as $relatedEntity) {
  2346.                     $this->doMerge($relatedEntity, $visited, $managedCopy, $assoc);
  2347.                 }
  2348.             } elseif ($relatedEntities !== null) {
  2349.                 $this->doMerge($relatedEntities, $visited, $managedCopy, $assoc);
  2350.             }
  2351.         }
  2352.     }
  2354.     /**
  2355.      * Cascades the save operation to associated entities.
  2356.      *
  2357.      * @param object $entity
  2358.      * @psalm-param array<int, object> $visited
  2359.      */
  2360.     private function cascadePersist($entity, array &$visited): void
  2361.     {
  2362.         $class = $this->em->getClassMetadata(get_class($entity));
  2364.         $associationMappings = array_filter(
  2365.             $class->associationMappings,
  2366.             static function ($assoc) {
  2367.                 return $assoc['isCascadePersist'];
  2368.             }
  2369.         );
  2371.         foreach ($associationMappings as $assoc) {
  2372.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2374.             switch (true) {
  2375.                 case $relatedEntities instanceof PersistentCollection:
  2376.                     // Unwrap so that foreach() does not initialize
  2377.                     $relatedEntities = $relatedEntities->unwrap();
  2378.                     // break; is commented intentionally!
  2380.                 case $relatedEntities instanceof Collection:
  2381.                 case is_array($relatedEntities):
  2382.                     if (($assoc['type'] & ClassMetadata::TO_MANY) <= 0) {
  2383.                         throw ORMInvalidArgumentException::invalidAssociation(
  2384.                             $this->em->getClassMetadata($assoc['targetEntity']),
  2385.                             $assoc,
  2386.                             $relatedEntities
  2387.                         );
  2388.                     }
  2390.                     foreach ($relatedEntities as $relatedEntity) {
  2391.                         $this->doPersist($relatedEntity, $visited);
  2392.                     }
  2394.                     break;
  2396.                 case $relatedEntities !== null:
  2397.                     if (! $relatedEntities instanceof $assoc['targetEntity']) {
  2398.                         throw ORMInvalidArgumentException::invalidAssociation(
  2399.                             $this->em->getClassMetadata($assoc['targetEntity']),
  2400.                             $assoc,
  2401.                             $relatedEntities
  2402.                         );
  2403.                     }
  2405.                     $this->doPersist($relatedEntities, $visited);
  2406.                     break;
  2408.                 default:
  2409.                     // Do nothing
  2410.             }
  2411.         }
  2412.     }
  2414.     /**
  2415.      * Cascades the delete operation to associated entities.
  2416.      *
  2417.      * @param object $entity
  2418.      * @psalm-param array<int, object> $visited
  2419.      */
  2420.     private function cascadeRemove($entity, array &$visited): void
  2421.     {
  2422.         $class = $this->em->getClassMetadata(get_class($entity));
  2424.         $associationMappings = array_filter(
  2425.             $class->associationMappings,
  2426.             static function ($assoc) {
  2427.                 return $assoc['isCascadeRemove'];
  2428.             }
  2429.         );
  2431.         $entitiesToCascade = [];
  2433.         foreach ($associationMappings as $assoc) {
  2434.             if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  2435.                 $entity->__load();
  2436.             }
  2438.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2440.             switch (true) {
  2441.                 case $relatedEntities instanceof Collection:
  2442.                 case is_array($relatedEntities):
  2443.                     // If its a PersistentCollection initialization is intended! No unwrap!
  2444.                     foreach ($relatedEntities as $relatedEntity) {
  2445.                         $entitiesToCascade[] = $relatedEntity;
  2446.                     }
  2448.                     break;
  2450.                 case $relatedEntities !== null:
  2451.                     $entitiesToCascade[] = $relatedEntities;
  2452.                     break;
  2454.                 default:
  2455.                     // Do nothing
  2456.             }
  2457.         }
  2459.         foreach ($entitiesToCascade as $relatedEntity) {
  2460.             $this->doRemove($relatedEntity, $visited);
  2461.         }
  2462.     }
  2464.     /**
  2465.      * Acquire a lock on the given entity.
  2466.      *
  2467.      * @param object                     $entity
  2468.      * @param int|DateTimeInterface|null $lockVersion
  2469.      * @psalm-param LockMode::* $lockMode
  2470.      *
  2471.      * @throws ORMInvalidArgumentException
  2472.      * @throws TransactionRequiredException
  2473.      * @throws OptimisticLockException
  2474.      */
  2475.     public function lock($entity, int $lockMode, $lockVersion = null): void
  2476.     {
  2477.         if ($this->getEntityState($entity, self::STATE_DETACHED) !== self::STATE_MANAGED) {
  2478.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  2479.         }
  2481.         $class = $this->em->getClassMetadata(get_class($entity));
  2483.         switch (true) {
  2484.             case $lockMode === LockMode::OPTIMISTIC:
  2485.                 if (! $class->isVersioned) {
  2486.                     throw OptimisticLockException::notVersioned($class->name);
  2487.                 }
  2489.                 if ($lockVersion === null) {
  2490.                     return;
  2491.                 }
  2493.                 if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  2494.                     $entity->__load();
  2495.                 }
  2497.                 $entityVersion = $class->reflFields[$class->versionField]->getValue($entity);
  2499.                 // phpcs:ignore SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedNotEqualOperator
  2500.                 if ($entityVersion != $lockVersion) {
  2501.                     throw OptimisticLockException::lockFailedVersionMismatch($entity, $lockVersion, $entityVersion);
  2502.                 }
  2504.                 break;
  2506.             case $lockMode === LockMode::NONE:
  2507.             case $lockMode === LockMode::PESSIMISTIC_READ:
  2508.             case $lockMode === LockMode::PESSIMISTIC_WRITE:
  2509.                 if (! $this->em->getConnection()->isTransactionActive()) {
  2510.                     throw TransactionRequiredException::transactionRequired();
  2511.                 }
  2513.                 $oid = spl_object_id($entity);
  2515.                 $this->getEntityPersister($class->name)->lock(
  2516.                     array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
  2517.                     $lockMode
  2518.                 );
  2519.                 break;
  2521.             default:
  2522.                 // Do nothing
  2523.         }
  2524.     }
  2526.     /**
  2527.      * Gets the CommitOrderCalculator used by the UnitOfWork to order commits.
  2528.      *
  2529.      * @return CommitOrderCalculator
  2530.      */
  2531.     public function getCommitOrderCalculator()
  2532.     {
  2533.         return new Internal\CommitOrderCalculator();
  2534.     }
  2536.     /**
  2537.      * Clears the UnitOfWork.
  2538.      *
  2539.      * @param string|null $entityName if given, only entities of this type will get detached.
  2540.      *
  2541.      * @return void
  2542.      *
  2543.      * @throws ORMInvalidArgumentException if an invalid entity name is given.
  2544.      */
  2545.     public function clear($entityName = null)
  2546.     {
  2547.         if ($entityName === null) {
  2548.             $this->identityMap                    =
  2549.             $this->entityIdentifiers              =
  2550.             $this->originalEntityData             =
  2551.             $this->entityChangeSets               =
  2552.             $this->entityStates                   =
  2553.             $this->scheduledForSynchronization    =
  2554.             $this->entityInsertions               =
  2555.             $this->entityUpdates                  =
  2556.             $this->entityDeletions                =
  2557.             $this->nonCascadedNewDetectedEntities =
  2558.             $this->collectionDeletions            =
  2559.             $this->collectionUpdates              =
  2560.             $this->extraUpdates                   =
  2561.             $this->readOnlyObjects                =
  2562.             $this->visitedCollections             =
  2563.             $this->eagerLoadingEntities           =
  2564.             $this->orphanRemovals                 = [];
  2565.         } else {
  2566.             Deprecation::triggerIfCalledFromOutside(
  2567.                 'doctrine/orm',
  2568.                 'https://github.com/doctrine/orm/issues/8460',
  2569.                 'Calling %s() with any arguments to clear specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
  2570.                 __METHOD__
  2571.             );
  2573.             $this->clearIdentityMapForEntityName($entityName);
  2574.             $this->clearEntityInsertionsForEntityName($entityName);
  2575.         }
  2577.         if ($this->evm->hasListeners(Events::onClear)) {
  2578.             $this->evm->dispatchEvent(Events::onClear, new Event\OnClearEventArgs($this->em, $entityName));
  2579.         }
  2580.     }
  2582.     /**
  2583.      * INTERNAL:
  2584.      * Schedules an orphaned entity for removal. The remove() operation will be
  2585.      * invoked on that entity at the beginning of the next commit of this
  2586.      * UnitOfWork.
  2587.      *
  2588.      * @param object $entity
  2589.      *
  2590.      * @return void
  2591.      *
  2592.      * @ignore
  2593.      */
  2594.     public function scheduleOrphanRemoval($entity)
  2595.     {
  2596.         $this->orphanRemovals[spl_object_id($entity)] = $entity;
  2597.     }
  2599.     /**
  2600.      * INTERNAL:
  2601.      * Cancels a previously scheduled orphan removal.
  2602.      *
  2603.      * @param object $entity
  2604.      *
  2605.      * @return void
  2606.      *
  2607.      * @ignore
  2608.      */
  2609.     public function cancelOrphanRemoval($entity)
  2610.     {
  2611.         unset($this->orphanRemovals[spl_object_id($entity)]);
  2612.     }
  2614.     /**
  2615.      * INTERNAL:
  2616.      * Schedules a complete collection for removal when this UnitOfWork commits.
  2617.      *
  2618.      * @return void
  2619.      */
  2620.     public function scheduleCollectionDeletion(PersistentCollection $coll)
  2621.     {
  2622.         $coid = spl_object_id($coll);
  2624.         // TODO: if $coll is already scheduled for recreation ... what to do?
  2625.         // Just remove $coll from the scheduled recreations?
  2626.         unset($this->collectionUpdates[$coid]);
  2628.         $this->collectionDeletions[$coid] = $coll;
  2629.     }
  2631.     /**
  2632.      * @return bool
  2633.      */
  2634.     public function isCollectionScheduledForDeletion(PersistentCollection $coll)
  2635.     {
  2636.         return isset($this->collectionDeletions[spl_object_id($coll)]);
  2637.     }
  2639.     /**
  2640.      * @return object
  2641.      */
  2642.     private function newInstance(ClassMetadata $class)
  2643.     {
  2644.         $entity = $class->newInstance();
  2646.         if ($entity instanceof ObjectManagerAware) {
  2647.             $entity->injectObjectManager($this->em, $class);
  2648.         }
  2650.         return $entity;
  2651.     }
  2653.     /**
  2654.      * INTERNAL:
  2655.      * Creates an entity. Used for reconstitution of persistent entities.
  2656.      *
  2657.      * Internal note: Highly performance-sensitive method.
  2658.      *
  2659.      * @param string  $className The name of the entity class.
  2660.      * @param mixed[] $data      The data for the entity.
  2661.      * @param mixed[] $hints     Any hints to account for during reconstitution/lookup of the entity.
  2662.      * @psalm-param class-string $className
  2663.      * @psalm-param array<string, mixed> $hints
  2664.      *
  2665.      * @return object The managed entity instance.
  2666.      *
  2667.      * @ignore
  2668.      * @todo Rename: getOrCreateEntity
  2669.      */
  2670.     public function createEntity($className, array $data, &$hints = [])
  2671.     {
  2672.         $class = $this->em->getClassMetadata($className);
  2674.         $id     = $this->identifierFlattener->flattenIdentifier($class, $data);
  2675.         $idHash = implode(' ', $id);
  2677.         if (isset($this->identityMap[$class->rootEntityName][$idHash])) {
  2678.             $entity = $this->identityMap[$class->rootEntityName][$idHash];
  2679.             $oid    = spl_object_id($entity);
  2681.             if (
  2682.                 isset($hints[Query::HINT_REFRESH], $hints[Query::HINT_REFRESH_ENTITY])
  2683.             ) {
  2684.                 $unmanagedProxy = $hints[Query::HINT_REFRESH_ENTITY];
  2685.                 if (
  2686.                     $unmanagedProxy !== $entity
  2687.                     && $unmanagedProxy instanceof Proxy
  2688.                     && $this->isIdentifierEquals($unmanagedProxy, $entity)
  2689.                 ) {
  2690.                     // DDC-1238 - we have a managed instance, but it isn't the provided one.
  2691.                     // Therefore we clear its identifier. Also, we must re-fetch metadata since the
  2692.                     // refreshed object may be anything
  2694.                     foreach ($class->identifier as $fieldName) {
  2695.                         $class->reflFields[$fieldName]->setValue($unmanagedProxy, null);
  2696.                     }
  2698.                     return $unmanagedProxy;
  2699.                 }
  2700.             }
  2702.             if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  2703.                 $entity->__setInitialized(true);
  2705.                 if ($entity instanceof NotifyPropertyChanged) {
  2706.                     $entity->addPropertyChangedListener($this);
  2707.                 }
  2708.             } else {
  2709.                 if (
  2710.                     ! isset($hints[Query::HINT_REFRESH])
  2711.                     || (isset($hints[Query::HINT_REFRESH_ENTITY]) && $hints[Query::HINT_REFRESH_ENTITY] !== $entity)
  2712.                 ) {
  2713.                     return $entity;
  2714.                 }
  2715.             }
  2717.             // inject ObjectManager upon refresh.
  2718.             if ($entity instanceof ObjectManagerAware) {
  2719.                 $entity->injectObjectManager($this->em, $class);
  2720.             }
  2722.             $this->originalEntityData[$oid] = $data;
  2723.         } else {
  2724.             $entity = $this->newInstance($class);
  2725.             $oid    = spl_object_id($entity);
  2727.             $this->entityIdentifiers[$oid]  = $id;
  2728.             $this->entityStates[$oid]       = self::STATE_MANAGED;
  2729.             $this->originalEntityData[$oid] = $data;
  2731.             $this->identityMap[$class->rootEntityName][$idHash] = $entity;
  2733.             if ($entity instanceof NotifyPropertyChanged) {
  2734.                 $entity->addPropertyChangedListener($this);
  2735.             }
  2737.             if (isset($hints[Query::HINT_READ_ONLY])) {
  2738.                 $this->readOnlyObjects[$oid] = true;
  2739.             }
  2740.         }
  2742.         foreach ($data as $field => $value) {
  2743.             if (isset($class->fieldMappings[$field])) {
  2744.                 $class->reflFields[$field]->setValue($entity, $value);
  2745.             }
  2746.         }
  2748.         // Loading the entity right here, if its in the eager loading map get rid of it there.
  2749.         unset($this->eagerLoadingEntities[$class->rootEntityName][$idHash]);
  2751.         if (isset($this->eagerLoadingEntities[$class->rootEntityName]) && ! $this->eagerLoadingEntities[$class->rootEntityName]) {
  2752.             unset($this->eagerLoadingEntities[$class->rootEntityName]);
  2753.         }
  2755.         // Properly initialize any unfetched associations, if partial objects are not allowed.
  2756.         if (isset($hints[Query::HINT_FORCE_PARTIAL_LOAD])) {
  2757.             Deprecation::trigger(
  2758.                 'doctrine/orm',
  2759.                 'https://github.com/doctrine/orm/issues/8471',
  2760.                 'Partial Objects are deprecated (here entity %s)',
  2761.                 $className
  2762.             );
  2764.             return $entity;
  2765.         }
  2767.         foreach ($class->associationMappings as $field => $assoc) {
  2768.             // Check if the association is not among the fetch-joined associations already.
  2769.             if (isset($hints['fetchAlias'], $hints['fetched'][$hints['fetchAlias']][$field])) {
  2770.                 continue;
  2771.             }
  2773.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  2775.             switch (true) {
  2776.                 case $assoc['type'] & ClassMetadata::TO_ONE:
  2777.                     if (! $assoc['isOwningSide']) {
  2778.                         // use the given entity association
  2779.                         if (isset($data[$field]) && is_object($data[$field]) && isset($this->entityStates[spl_object_id($data[$field])])) {
  2780.                             $this->originalEntityData[$oid][$field] = $data[$field];
  2782.                             $class->reflFields[$field]->setValue($entity, $data[$field]);
  2783.                             $targetClass->reflFields[$assoc['mappedBy']]->setValue($data[$field], $entity);
  2785.                             continue 2;
  2786.                         }
  2788.                         // Inverse side of x-to-one can never be lazy
  2789.                         $class->reflFields[$field]->setValue($entity, $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc, $entity));
  2791.                         continue 2;
  2792.                     }
  2794.                     // use the entity association
  2795.                     if (isset($data[$field]) && is_object($data[$field]) && isset($this->entityStates[spl_object_id($data[$field])])) {
  2796.                         $class->reflFields[$field]->setValue($entity, $data[$field]);
  2797.                         $this->originalEntityData[$oid][$field] = $data[$field];
  2799.                         break;
  2800.                     }
  2802.                     $associatedId = [];
  2804.                     // TODO: Is this even computed right in all cases of composite keys?
  2805.                     foreach ($assoc['targetToSourceKeyColumns'] as $targetColumn => $srcColumn) {
  2806.                         $joinColumnValue = $data[$srcColumn] ?? null;
  2808.                         if ($joinColumnValue !== null) {
  2809.                             if ($targetClass->containsForeignIdentifier) {
  2810.                                 $associatedId[$targetClass->getFieldForColumn($targetColumn)] = $joinColumnValue;
  2811.                             } else {
  2812.                                 $associatedId[$targetClass->fieldNames[$targetColumn]] = $joinColumnValue;
  2813.                             }
  2814.                         } elseif (
  2815.                             $targetClass->containsForeignIdentifier
  2816.                             && in_array($targetClass->getFieldForColumn($targetColumn), $targetClass->identifier, true)
  2817.                         ) {
  2818.                             // the missing key is part of target's entity primary key
  2819.                             $associatedId = [];
  2820.                             break;
  2821.                         }
  2822.                     }
  2824.                     if (! $associatedId) {
  2825.                         // Foreign key is NULL
  2826.                         $class->reflFields[$field]->setValue($entity, null);
  2827.                         $this->originalEntityData[$oid][$field] = null;
  2829.                         break;
  2830.                     }
  2832.                     if (! isset($hints['fetchMode'][$class->name][$field])) {
  2833.                         $hints['fetchMode'][$class->name][$field] = $assoc['fetch'];
  2834.                     }
  2836.                     // Foreign key is set
  2837.                     // Check identity map first
  2838.                     // FIXME: Can break easily with composite keys if join column values are in
  2839.                     //        wrong order. The correct order is the one in ClassMetadata#identifier.
  2840.                     $relatedIdHash = implode(' ', $associatedId);
  2842.                     switch (true) {
  2843.                         case isset($this->identityMap[$targetClass->rootEntityName][$relatedIdHash]):
  2844.                             $newValue = $this->identityMap[$targetClass->rootEntityName][$relatedIdHash];
  2846.                             // If this is an uninitialized proxy, we are deferring eager loads,
  2847.                             // this association is marked as eager fetch, and its an uninitialized proxy (wtf!)
  2848.                             // then we can append this entity for eager loading!
  2849.                             if (
  2850.                                 $hints['fetchMode'][$class->name][$field] === ClassMetadata::FETCH_EAGER &&
  2851.                                 isset($hints[self::HINT_DEFEREAGERLOAD]) &&
  2852.                                 ! $targetClass->isIdentifierComposite &&
  2853.                                 $newValue instanceof Proxy &&
  2854.                                 $newValue->__isInitialized() === false
  2855.                             ) {
  2856.                                 $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
  2857.                             }
  2859.                             break;
  2861.                         case $targetClass->subClasses:
  2862.                             // If it might be a subtype, it can not be lazy. There isn't even
  2863.                             // a way to solve this with deferred eager loading, which means putting
  2864.                             // an entity with subclasses at a *-to-one location is really bad! (performance-wise)
  2865.                             $newValue = $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc, $entity, $associatedId);
  2866.                             break;
  2868.                         default:
  2869.                             switch (true) {
  2870.                                 // We are negating the condition here. Other cases will assume it is valid!
  2871.                                 case $hints['fetchMode'][$class->name][$field] !== ClassMetadata::FETCH_EAGER:
  2872.                                     $newValue = $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $associatedId);
  2873.                                     break;
  2875.                                 // Deferred eager load only works for single identifier classes
  2876.                                 case isset($hints[self::HINT_DEFEREAGERLOAD]) && ! $targetClass->isIdentifierComposite:
  2877.                                     // TODO: Is there a faster approach?
  2878.                                     $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
  2880.                                     $newValue = $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $associatedId);
  2881.                                     break;
  2883.                                 default:
  2884.                                     // TODO: This is very imperformant, ignore it?
  2885.                                     $newValue = $this->em->find($assoc['targetEntity'], $associatedId);
  2886.                                     break;
  2887.                             }
  2889.                             if ($newValue === null) {
  2890.                                 break;
  2891.                             }
  2893.                             // PERF: Inlined & optimized code from UnitOfWork#registerManaged()
  2894.                             $newValueOid                                                     = spl_object_id($newValue);
  2895.                             $this->entityIdentifiers[$newValueOid]                           = $associatedId;
  2896.                             $this->identityMap[$targetClass->rootEntityName][$relatedIdHash] = $newValue;
  2898.                             if (
  2899.                                 $newValue instanceof NotifyPropertyChanged &&
  2900.                                 ( ! $newValue instanceof Proxy || $newValue->__isInitialized())
  2901.                             ) {
  2902.                                 $newValue->addPropertyChangedListener($this);
  2903.                             }
  2905.                             $this->entityStates[$newValueOid] = self::STATE_MANAGED;
  2906.                             // make sure that when an proxy is then finally loaded, $this->originalEntityData is set also!
  2907.                             break;
  2908.                     }
  2910.                     $this->originalEntityData[$oid][$field] = $newValue;
  2911.                     $class->reflFields[$field]->setValue($entity, $newValue);
  2913.                     if ($assoc['inversedBy'] && $assoc['type'] & ClassMetadata::ONE_TO_ONE && $newValue !== null) {
  2914.                         $inverseAssoc = $targetClass->associationMappings[$assoc['inversedBy']];
  2915.                         $targetClass->reflFields[$inverseAssoc['fieldName']]->setValue($newValue, $entity);
  2916.                     }
  2918.                     break;
  2920.                 default:
  2921.                     // Ignore if its a cached collection
  2922.                     if (isset($hints[Query::HINT_CACHE_ENABLED]) && $class->getFieldValue($entity, $field) instanceof PersistentCollection) {
  2923.                         break;
  2924.                     }
  2926.                     // use the given collection
  2927.                     if (isset($data[$field]) && $data[$field] instanceof PersistentCollection) {
  2928.                         $data[$field]->setOwner($entity, $assoc);
  2930.                         $class->reflFields[$field]->setValue($entity, $data[$field]);
  2931.                         $this->originalEntityData[$oid][$field] = $data[$field];
  2933.                         break;
  2934.                     }
  2936.                     // Inject collection
  2937.                     $pColl = new PersistentCollection($this->em, $targetClass, new ArrayCollection());
  2938.                     $pColl->setOwner($entity, $assoc);
  2939.                     $pColl->setInitialized(false);
  2941.                     $reflField = $class->reflFields[$field];
  2942.                     $reflField->setValue($entity, $pColl);
  2944.                     if ($assoc['fetch'] === ClassMetadata::FETCH_EAGER) {
  2945.                         $this->loadCollection($pColl);
  2946.                         $pColl->takeSnapshot();
  2947.                     }
  2949.                     $this->originalEntityData[$oid][$field] = $pColl;
  2950.                     break;
  2951.             }
  2952.         }
  2954.         // defer invoking of postLoad event to hydration complete step
  2955.         $this->hydrationCompleteHandler->deferPostLoadInvoking($class, $entity);
  2957.         return $entity;
  2958.     }
  2960.     /**
  2961.      * @return void
  2962.      */
  2963.     public function triggerEagerLoads()
  2964.     {
  2965.         if (! $this->eagerLoadingEntities) {
  2966.             return;
  2967.         }
  2969.         // avoid infinite recursion
  2970.         $eagerLoadingEntities       = $this->eagerLoadingEntities;
  2971.         $this->eagerLoadingEntities = [];
  2973.         foreach ($eagerLoadingEntities as $entityName => $ids) {
  2974.             if (! $ids) {
  2975.                 continue;
  2976.             }
  2978.             $class = $this->em->getClassMetadata($entityName);
  2980.             $this->getEntityPersister($entityName)->loadAll(
  2981.                 array_combine($class->identifier, [array_values($ids)])
  2982.             );
  2983.         }
  2984.     }
  2986.     /**
  2987.      * Initializes (loads) an uninitialized persistent collection of an entity.
  2988.      *
  2989.      * @param PersistentCollection $collection The collection to initialize.
  2990.      *
  2991.      * @return void
  2992.      *
  2993.      * @todo Maybe later move to EntityManager#initialize($proxyOrCollection). See DDC-733.
  2994.      */
  2995.     public function loadCollection(PersistentCollection $collection)
  2996.     {
  2997.         $assoc     = $collection->getMapping();
  2998.         $persister = $this->getEntityPersister($assoc['targetEntity']);
  3000.         switch ($assoc['type']) {
  3001.             case ClassMetadata::ONE_TO_MANY:
  3002.                 $persister->loadOneToManyCollection($assoc, $collection->getOwner(), $collection);
  3003.                 break;
  3005.             case ClassMetadata::MANY_TO_MANY:
  3006.                 $persister->loadManyToManyCollection($assoc, $collection->getOwner(), $collection);
  3007.                 break;
  3008.         }
  3010.         $collection->setInitialized(true);
  3011.     }
  3013.     /**
  3014.      * Gets the identity map of the UnitOfWork.
  3015.      *
  3016.      * @psalm-return array<class-string, array<string, object|null>>
  3017.      */
  3018.     public function getIdentityMap()
  3019.     {
  3020.         return $this->identityMap;
  3021.     }
  3023.     /**
  3024.      * Gets the original data of an entity. The original data is the data that was
  3025.      * present at the time the entity was reconstituted from the database.
  3026.      *
  3027.      * @param object $entity
  3028.      *
  3029.      * @return mixed[]
  3030.      * @psalm-return array<string, mixed>
  3031.      */
  3032.     public function getOriginalEntityData($entity)
  3033.     {
  3034.         $oid = spl_object_id($entity);
  3036.         return $this->originalEntityData[$oid] ?? [];
  3037.     }
  3039.     /**
  3040.      * @param object  $entity
  3041.      * @param mixed[] $data
  3042.      *
  3043.      * @return void
  3044.      *
  3045.      * @ignore
  3046.      */
  3047.     public function setOriginalEntityData($entity, array $data)
  3048.     {
  3049.         $this->originalEntityData[spl_object_id($entity)] = $data;
  3050.     }
  3052.     /**
  3053.      * INTERNAL:
  3054.      * Sets a property value of the original data array of an entity.
  3055.      *
  3056.      * @param int    $oid
  3057.      * @param string $property
  3058.      * @param mixed  $value
  3059.      *
  3060.      * @return void
  3061.      *
  3062.      * @ignore
  3063.      */
  3064.     public function setOriginalEntityProperty($oid, $property, $value)
  3065.     {
  3066.         $this->originalEntityData[$oid][$property] = $value;
  3067.     }
  3069.     /**
  3070.      * Gets the identifier of an entity.
  3071.      * The returned value is always an array of identifier values. If the entity
  3072.      * has a composite identifier then the identifier values are in the same
  3073.      * order as the identifier field names as returned by ClassMetadata#getIdentifierFieldNames().
  3074.      *
  3075.      * @param object $entity
  3076.      *
  3077.      * @return mixed[] The identifier values.
  3078.      */
  3079.     public function getEntityIdentifier($entity)
  3080.     {
  3081.         if (! isset($this->entityIdentifiers[spl_object_id($entity)])) {
  3082.             throw EntityNotFoundException::noIdentifierFound(get_debug_type($entity));
  3083.         }
  3085.         return $this->entityIdentifiers[spl_object_id($entity)];
  3086.     }
  3088.     /**
  3089.      * Processes an entity instance to extract their identifier values.
  3090.      *
  3091.      * @param object $entity The entity instance.
  3092.      *
  3093.      * @return mixed A scalar value.
  3094.      *
  3095.      * @throws ORMInvalidArgumentException
  3096.      */
  3097.     public function getSingleIdentifierValue($entity)
  3098.     {
  3099.         $class = $this->em->getClassMetadata(get_class($entity));
  3101.         if ($class->isIdentifierComposite) {
  3102.             throw ORMInvalidArgumentException::invalidCompositeIdentifier();
  3103.         }
  3105.         $values = $this->isInIdentityMap($entity)
  3106.             ? $this->getEntityIdentifier($entity)
  3107.             : $class->getIdentifierValues($entity);
  3109.         return $values[$class->identifier[0]] ?? null;
  3110.     }
  3112.     /**
  3113.      * Tries to find an entity with the given identifier in the identity map of
  3114.      * this UnitOfWork.
  3115.      *
  3116.      * @param mixed  $id            The entity identifier to look for.
  3117.      * @param string $rootClassName The name of the root class of the mapped entity hierarchy.
  3118.      * @psalm-param class-string $rootClassName
  3119.      *
  3120.      * @return object|false Returns the entity with the specified identifier if it exists in
  3121.      *                      this UnitOfWork, FALSE otherwise.
  3122.      */
  3123.     public function tryGetById($id, $rootClassName)
  3124.     {
  3125.         $idHash = implode(' ', (array) $id);
  3127.         return $this->identityMap[$rootClassName][$idHash] ?? false;
  3128.     }
  3130.     /**
  3131.      * Schedules an entity for dirty-checking at commit-time.
  3132.      *
  3133.      * @param object $entity The entity to schedule for dirty-checking.
  3134.      *
  3135.      * @return void
  3136.      *
  3137.      * @todo Rename: scheduleForSynchronization
  3138.      */
  3139.     public function scheduleForDirtyCheck($entity)
  3140.     {
  3141.         $rootClassName = $this->em->getClassMetadata(get_class($entity))->rootEntityName;
  3143.         $this->scheduledForSynchronization[$rootClassName][spl_object_id($entity)] = $entity;
  3144.     }
  3146.     /**
  3147.      * Checks whether the UnitOfWork has any pending insertions.
  3148.      *
  3149.      * @return bool TRUE if this UnitOfWork has pending insertions, FALSE otherwise.
  3150.      */
  3151.     public function hasPendingInsertions()
  3152.     {
  3153.         return ! empty($this->entityInsertions);
  3154.     }
  3156.     /**
  3157.      * Calculates the size of the UnitOfWork. The size of the UnitOfWork is the
  3158.      * number of entities in the identity map.
  3159.      *
  3160.      * @return int
  3161.      */
  3162.     public function size()
  3163.     {
  3164.         return array_sum(array_map('count', $this->identityMap));
  3165.     }
  3167.     /**
  3168.      * Gets the EntityPersister for an Entity.
  3169.      *
  3170.      * @param string $entityName The name of the Entity.
  3171.      * @psalm-param class-string $entityName
  3172.      *
  3173.      * @return EntityPersister
  3174.      */
  3175.     public function getEntityPersister($entityName)
  3176.     {
  3177.         if (isset($this->persisters[$entityName])) {
  3178.             return $this->persisters[$entityName];
  3179.         }
  3181.         $class = $this->em->getClassMetadata($entityName);
  3183.         switch (true) {
  3184.             case $class->isInheritanceTypeNone():
  3185.                 $persister = new BasicEntityPersister($this->em, $class);
  3186.                 break;
  3188.             case $class->isInheritanceTypeSingleTable():
  3189.                 $persister = new SingleTablePersister($this->em, $class);
  3190.                 break;
  3192.             case $class->isInheritanceTypeJoined():
  3193.                 $persister = new JoinedSubclassPersister($this->em, $class);
  3194.                 break;
  3196.             default:
  3197.                 throw new RuntimeException('No persister found for entity.');
  3198.         }
  3200.         if ($this->hasCache && $class->cache !== null) {
  3201.             $persister = $this->em->getConfiguration()
  3202.                 ->getSecondLevelCacheConfiguration()
  3203.                 ->getCacheFactory()
  3204.                 ->buildCachedEntityPersister($this->em, $persister, $class);
  3205.         }
  3207.         $this->persisters[$entityName] = $persister;
  3209.         return $this->persisters[$entityName];
  3210.     }
  3212.     /**
  3213.      * Gets a collection persister for a collection-valued association.
  3214.      *
  3215.      * @psalm-param array<string, mixed> $association
  3216.      *
  3217.      * @return CollectionPersister
  3218.      */
  3219.     public function getCollectionPersister(array $association)
  3220.     {
  3221.         $role = isset($association['cache'])
  3222.             ? $association['sourceEntity'] . '::' . $association['fieldName']
  3223.             : $association['type'];
  3225.         if (isset($this->collectionPersisters[$role])) {
  3226.             return $this->collectionPersisters[$role];
  3227.         }
  3229.         $persister = $association['type'] === ClassMetadata::ONE_TO_MANY
  3230.             ? new OneToManyPersister($this->em)
  3231.             : new ManyToManyPersister($this->em);
  3233.         if ($this->hasCache && isset($association['cache'])) {
  3234.             $persister = $this->em->getConfiguration()
  3235.                 ->getSecondLevelCacheConfiguration()
  3236.                 ->getCacheFactory()
  3237.                 ->buildCachedCollectionPersister($this->em, $persister, $association);
  3238.         }
  3240.         $this->collectionPersisters[$role] = $persister;
  3242.         return $this->collectionPersisters[$role];
  3243.     }
  3245.     /**
  3246.      * INTERNAL:
  3247.      * Registers an entity as managed.
  3248.      *
  3249.      * @param object  $entity The entity.
  3250.      * @param mixed[] $id     The identifier values.
  3251.      * @param mixed[] $data   The original entity data.
  3252.      *
  3253.      * @return void
  3254.      */
  3255.     public function registerManaged($entity, array $id, array $data)
  3256.     {
  3257.         $oid = spl_object_id($entity);
  3259.         $this->entityIdentifiers[$oid]  = $id;
  3260.         $this->entityStates[$oid]       = self::STATE_MANAGED;
  3261.         $this->originalEntityData[$oid] = $data;
  3263.         $this->addToIdentityMap($entity);
  3265.         if ($entity instanceof NotifyPropertyChanged && ( ! $entity instanceof Proxy || $entity->__isInitialized())) {
  3266.             $entity->addPropertyChangedListener($this);
  3267.         }
  3268.     }
  3270.     /**
  3271.      * INTERNAL:
  3272.      * Clears the property changeset of the entity with the given OID.
  3273.      *
  3274.      * @param int $oid The entity's OID.
  3275.      *
  3276.      * @return void
  3277.      */
  3278.     public function clearEntityChangeSet($oid)
  3279.     {
  3280.         unset($this->entityChangeSets[$oid]);
  3281.     }
  3283.     /* PropertyChangedListener implementation */
  3285.     /**
  3286.      * Notifies this UnitOfWork of a property change in an entity.
  3287.      *
  3288.      * @param object $sender       The entity that owns the property.
  3289.      * @param string $propertyName The name of the property that changed.
  3290.      * @param mixed  $oldValue     The old value of the property.
  3291.      * @param mixed  $newValue     The new value of the property.
  3292.      *
  3293.      * @return void
  3294.      */
  3295.     public function propertyChanged($sender, $propertyName, $oldValue, $newValue)
  3296.     {
  3297.         $oid   = spl_object_id($sender);
  3298.         $class = $this->em->getClassMetadata(get_class($sender));
  3300.         $isAssocField = isset($class->associationMappings[$propertyName]);
  3302.         if (! $isAssocField && ! isset($class->fieldMappings[$propertyName])) {
  3303.             return; // ignore non-persistent fields
  3304.         }
  3306.         // Update changeset and mark entity for synchronization
  3307.         $this->entityChangeSets[$oid][$propertyName] = [$oldValue, $newValue];
  3309.         if (! isset($this->scheduledForSynchronization[$class->rootEntityName][$oid])) {
  3310.             $this->scheduleForDirtyCheck($sender);
  3311.         }
  3312.     }
  3314.     /**
  3315.      * Gets the currently scheduled entity insertions in this UnitOfWork.
  3316.      *
  3317.      * @psalm-return array<int, object>
  3318.      */
  3319.     public function getScheduledEntityInsertions()
  3320.     {
  3321.         return $this->entityInsertions;
  3322.     }
  3324.     /**
  3325.      * Gets the currently scheduled entity updates in this UnitOfWork.
  3326.      *
  3327.      * @psalm-return array<int, object>
  3328.      */
  3329.     public function getScheduledEntityUpdates()
  3330.     {
  3331.         return $this->entityUpdates;
  3332.     }
  3334.     /**
  3335.      * Gets the currently scheduled entity deletions in this UnitOfWork.
  3336.      *
  3337.      * @psalm-return array<int, object>
  3338.      */
  3339.     public function getScheduledEntityDeletions()
  3340.     {
  3341.         return $this->entityDeletions;
  3342.     }
  3344.     /**
  3345.      * Gets the currently scheduled complete collection deletions
  3346.      *
  3347.      * @psalm-return array<int, Collection<array-key, object>>
  3348.      */
  3349.     public function getScheduledCollectionDeletions()
  3350.     {
  3351.         return $this->collectionDeletions;
  3352.     }
  3354.     /**
  3355.      * Gets the currently scheduled collection inserts, updates and deletes.
  3356.      *
  3357.      * @psalm-return array<int, Collection<array-key, object>>
  3358.      */
  3359.     public function getScheduledCollectionUpdates()
  3360.     {
  3361.         return $this->collectionUpdates;
  3362.     }
  3364.     /**
  3365.      * Helper method to initialize a lazy loading proxy or persistent collection.
  3366.      *
  3367.      * @param object $obj
  3368.      *
  3369.      * @return void
  3370.      */
  3371.     public function initializeObject($obj)
  3372.     {
  3373.         if ($obj instanceof Proxy) {
  3374.             $obj->__load();
  3376.             return;
  3377.         }
  3379.         if ($obj instanceof PersistentCollection) {
  3380.             $obj->initialize();
  3381.         }
  3382.     }
  3384.     /**
  3385.      * Helper method to show an object as string.
  3386.      *
  3387.      * @param object $obj
  3388.      */
  3389.     private static function objToStr($obj): string
  3390.     {
  3391.         return method_exists($obj, '__toString') ? (string) $obj : get_debug_type($obj) . '@' . spl_object_id($obj);
  3392.     }
  3394.     /**
  3395.      * Marks an entity as read-only so that it will not be considered for updates during UnitOfWork#commit().
  3396.      *
  3397.      * This operation cannot be undone as some parts of the UnitOfWork now keep gathering information
  3398.      * on this object that might be necessary to perform a correct update.
  3399.      *
  3400.      * @param object $object
  3401.      *
  3402.      * @return void
  3403.      *
  3404.      * @throws ORMInvalidArgumentException
  3405.      */
  3406.     public function markReadOnly($object)
  3407.     {
  3408.         if (! is_object($object) || ! $this->isInIdentityMap($object)) {
  3409.             throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
  3410.         }
  3412.         $this->readOnlyObjects[spl_object_id($object)] = true;
  3413.     }
  3415.     /**
  3416.      * Is this entity read only?
  3417.      *
  3418.      * @param object $object
  3419.      *
  3420.      * @return bool
  3421.      *
  3422.      * @throws ORMInvalidArgumentException
  3423.      */
  3424.     public function isReadOnly($object)
  3425.     {
  3426.         if (! is_object($object)) {
  3427.             throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
  3428.         }
  3430.         return isset($this->readOnlyObjects[spl_object_id($object)]);
  3431.     }
  3433.     /**
  3434.      * Perform whatever processing is encapsulated here after completion of the transaction.
  3435.      */
  3436.     private function afterTransactionComplete(): void
  3437.     {
  3438.         $this->performCallbackOnCachedPersister(static function (CachedPersister $persister) {
  3439.             $persister->afterTransactionComplete();
  3440.         });
  3441.     }
  3443.     /**
  3444.      * Perform whatever processing is encapsulated here after completion of the rolled-back.
  3445.      */
  3446.     private function afterTransactionRolledBack(): void
  3447.     {
  3448.         $this->performCallbackOnCachedPersister(static function (CachedPersister $persister) {
  3449.             $persister->afterTransactionRolledBack();
  3450.         });
  3451.     }
  3453.     /**
  3454.      * Performs an action after the transaction.
  3455.      */
  3456.     private function performCallbackOnCachedPersister(callable $callback): void
  3457.     {
  3458.         if (! $this->hasCache) {
  3459.             return;
  3460.         }
  3462.         foreach (array_merge($this->persisters, $this->collectionPersisters) as $persister) {
  3463.             if ($persister instanceof CachedPersister) {
  3464.                 $callback($persister);
  3465.             }
  3466.         }
  3467.     }
  3469.     private function dispatchOnFlushEvent(): void
  3470.     {
  3471.         if ($this->evm->hasListeners(Events::onFlush)) {
  3472.             $this->evm->dispatchEvent(Events::onFlush, new OnFlushEventArgs($this->em));
  3473.         }
  3474.     }
  3476.     private function dispatchPostFlushEvent(): void
  3477.     {
  3478.         if ($this->evm->hasListeners(Events::postFlush)) {
  3479.             $this->evm->dispatchEvent(Events::postFlush, new PostFlushEventArgs($this->em));
  3480.         }
  3481.     }
  3483.     /**
  3484.      * Verifies if two given entities actually are the same based on identifier comparison
  3485.      *
  3486.      * @param object $entity1
  3487.      * @param object $entity2
  3488.      */
  3489.     private function isIdentifierEquals($entity1, $entity2): bool
  3490.     {
  3491.         if ($entity1 === $entity2) {
  3492.             return true;
  3493.         }
  3495.         $class = $this->em->getClassMetadata(get_class($entity1));
  3497.         if ($class !== $this->em->getClassMetadata(get_class($entity2))) {
  3498.             return false;
  3499.         }
  3501.         $oid1 = spl_object_id($entity1);
  3502.         $oid2 = spl_object_id($entity2);
  3504.         $id1 = $this->entityIdentifiers[$oid1] ?? $this->identifierFlattener->flattenIdentifier($class, $class->getIdentifierValues($entity1));
  3505.         $id2 = $this->entityIdentifiers[$oid2] ?? $this->identifierFlattener->flattenIdentifier($class, $class->getIdentifierValues($entity2));
  3507.         return $id1 === $id2 || implode(' ', $id1) === implode(' ', $id2);
  3508.     }
  3510.     /**
  3511.      * @throws ORMInvalidArgumentException
  3512.      */
  3513.     private function assertThatThereAreNoUnintentionallyNonPersistedAssociations(): void
  3514.     {
  3515.         $entitiesNeedingCascadePersist = array_diff_key($this->nonCascadedNewDetectedEntities, $this->entityInsertions);
  3517.         $this->nonCascadedNewDetectedEntities = [];
  3519.         if ($entitiesNeedingCascadePersist) {
  3520.             throw ORMInvalidArgumentException::newEntitiesFoundThroughRelationships(
  3521.                 array_values($entitiesNeedingCascadePersist)
  3522.             );
  3523.         }
  3524.     }
  3526.     /**
  3527.      * @param object $entity
  3528.      * @param object $managedCopy
  3529.      *
  3530.      * @throws ORMException
  3531.      * @throws OptimisticLockException
  3532.      * @throws TransactionRequiredException
  3533.      */
  3534.     private function mergeEntityStateIntoManagedCopy($entity, $managedCopy): void
  3535.     {
  3536.         if (! $this->isLoaded($entity)) {
  3537.             return;
  3538.         }
  3540.         if (! $this->isLoaded($managedCopy)) {
  3541.             $managedCopy->__load();
  3542.         }
  3544.         $class = $this->em->getClassMetadata(get_class($entity));
  3546.         foreach ($this->reflectionPropertiesGetter->getProperties($class->name) as $prop) {
  3547.             $name = $prop->name;
  3549.             $prop->setAccessible(true);
  3551.             if (! isset($class->associationMappings[$name])) {
  3552.                 if (! $class->isIdentifier($name)) {
  3553.                     $prop->setValue($managedCopy, $prop->getValue($entity));
  3554.                 }
  3555.             } else {
  3556.                 $assoc2 = $class->associationMappings[$name];
  3558.                 if ($assoc2['type'] & ClassMetadata::TO_ONE) {
  3559.                     $other = $prop->getValue($entity);
  3560.                     if ($other === null) {
  3561.                         $prop->setValue($managedCopy, null);
  3562.                     } else {
  3563.                         if ($other instanceof Proxy && ! $other->__isInitialized()) {
  3564.                             // do not merge fields marked lazy that have not been fetched.
  3565.                             continue;
  3566.                         }
  3568.                         if (! $assoc2['isCascadeMerge']) {
  3569.                             if ($this->getEntityState($other) === self::STATE_DETACHED) {
  3570.                                 $targetClass = $this->em->getClassMetadata($assoc2['targetEntity']);
  3571.                                 $relatedId   = $targetClass->getIdentifierValues($other);
  3573.                                 if ($targetClass->subClasses) {
  3574.                                     $other = $this->em->find($targetClass->name, $relatedId);
  3575.                                 } else {
  3576.                                     $other = $this->em->getProxyFactory()->getProxy(
  3577.                                         $assoc2['targetEntity'],
  3578.                                         $relatedId
  3579.                                     );
  3580.                                     $this->registerManaged($other, $relatedId, []);
  3581.                                 }
  3582.                             }
  3584.                             $prop->setValue($managedCopy, $other);
  3585.                         }
  3586.                     }
  3587.                 } else {
  3588.                     $mergeCol = $prop->getValue($entity);
  3590.                     if ($mergeCol instanceof PersistentCollection && ! $mergeCol->isInitialized()) {
  3591.                         // do not merge fields marked lazy that have not been fetched.
  3592.                         // keep the lazy persistent collection of the managed copy.
  3593.                         continue;
  3594.                     }
  3596.                     $managedCol = $prop->getValue($managedCopy);
  3598.                     if (! $managedCol) {
  3599.                         $managedCol = new PersistentCollection(
  3600.                             $this->em,
  3601.                             $this->em->getClassMetadata($assoc2['targetEntity']),
  3602.                             new ArrayCollection()
  3603.                         );
  3604.                         $managedCol->setOwner($managedCopy, $assoc2);
  3605.                         $prop->setValue($managedCopy, $managedCol);
  3606.                     }
  3608.                     if ($assoc2['isCascadeMerge']) {
  3609.                         $managedCol->initialize();
  3611.                         // clear and set dirty a managed collection if its not also the same collection to merge from.
  3612.                         if (! $managedCol->isEmpty() && $managedCol !== $mergeCol) {
  3613.                             $managedCol->unwrap()->clear();
  3614.                             $managedCol->setDirty(true);
  3616.                             if (
  3617.                                 $assoc2['isOwningSide']
  3618.                                 && $assoc2['type'] === ClassMetadata::MANY_TO_MANY
  3619.                                 && $class->isChangeTrackingNotify()
  3620.                             ) {
  3621.                                 $this->scheduleForDirtyCheck($managedCopy);
  3622.                             }
  3623.                         }
  3624.                     }
  3625.                 }
  3626.             }
  3628.             if ($class->isChangeTrackingNotify()) {
  3629.                 // Just treat all properties as changed, there is no other choice.
  3630.                 $this->propertyChanged($managedCopy, $name, null, $prop->getValue($managedCopy));
  3631.             }
  3632.         }
  3633.     }
  3635.     /**
  3636.      * This method called by hydrators, and indicates that hydrator totally completed current hydration cycle.
  3637.      * Unit of work able to fire deferred events, related to loading events here.
  3638.      *
  3639.      * @internal should be called internally from object hydrators
  3640.      *
  3641.      * @return void
  3642.      */
  3643.     public function hydrationComplete()
  3644.     {
  3645.         $this->hydrationCompleteHandler->hydrationComplete();
  3646.     }
  3648.     private function clearIdentityMapForEntityName(string $entityName): void
  3649.     {
  3650.         if (! isset($this->identityMap[$entityName])) {
  3651.             return;
  3652.         }
  3654.         $visited = [];
  3656.         foreach ($this->identityMap[$entityName] as $entity) {
  3657.             $this->doDetach($entity, $visited, false);
  3658.         }
  3659.     }
  3661.     private function clearEntityInsertionsForEntityName(string $entityName): void
  3662.     {
  3663.         foreach ($this->entityInsertions as $hash => $entity) {
  3664.             // note: performance optimization - `instanceof` is much faster than a function call
  3665.             if ($entity instanceof $entityName && get_class($entity) === $entityName) {
  3666.                 unset($this->entityInsertions[$hash]);
  3667.             }
  3668.         }
  3669.     }
  3671.     /**
  3672.      * @param mixed $identifierValue
  3673.      *
  3674.      * @return mixed the identifier after type conversion
  3675.      *
  3676.      * @throws MappingException if the entity has more than a single identifier.
  3677.      */
  3678.     private function convertSingleFieldIdentifierToPHPValue(ClassMetadata $class, $identifierValue)
  3679.     {
  3680.         return $this->em->getConnection()->convertToPHPValue(
  3681.             $identifierValue,
  3682.             $class->getTypeOfField($class->getSingleIdentifierFieldName())
  3683.         );
  3684.     }
  3685. }