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

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\ORMException;
  23. use Doctrine\ORM\Exception\UnexpectedAssociationValue;
  24. use Doctrine\ORM\Id\AssignedGenerator;
  25. use Doctrine\ORM\Internal\CommitOrderCalculator;
  26. use Doctrine\ORM\Internal\HydrationCompleteHandler;
  27. use Doctrine\ORM\Mapping\ClassMetadata;
  28. use Doctrine\ORM\Mapping\ClassMetadataInfo;
  29. use Doctrine\ORM\Mapping\MappingException;
  30. use Doctrine\ORM\Mapping\Reflection\ReflectionPropertiesGetter;
  31. use Doctrine\ORM\Persisters\Collection\CollectionPersister;
  32. use Doctrine\ORM\Persisters\Collection\ManyToManyPersister;
  33. use Doctrine\ORM\Persisters\Collection\OneToManyPersister;
  34. use Doctrine\ORM\Persisters\Entity\BasicEntityPersister;
  35. use Doctrine\ORM\Persisters\Entity\EntityPersister;
  36. use Doctrine\ORM\Persisters\Entity\JoinedSubclassPersister;
  37. use Doctrine\ORM\Persisters\Entity\SingleTablePersister;
  38. use Doctrine\ORM\Utility\IdentifierFlattener;
  39. use Doctrine\Persistence\Mapping\RuntimeReflectionService;
  40. use Doctrine\Persistence\NotifyPropertyChanged;
  41. use Doctrine\Persistence\ObjectManagerAware;
  42. use Doctrine\Persistence\PropertyChangedListener;
  43. use Exception;
  44. use InvalidArgumentException;
  45. use RuntimeException;
  46. use Throwable;
  47. use UnexpectedValueException;
  49. use function array_combine;
  50. use function array_diff_key;
  51. use function array_filter;
  52. use function array_key_exists;
  53. use function array_map;
  54. use function array_merge;
  55. use function array_pop;
  56. use function array_sum;
  57. use function array_values;
  58. use function assert;
  59. use function count;
  60. use function current;
  61. use function get_class;
  62. use function get_debug_type;
  63. use function implode;
  64. use function in_array;
  65. use function is_array;
  66. use function is_object;
  67. use function method_exists;
  68. use function reset;
  69. use function spl_object_id;
  70. use function sprintf;
  72. /**
  73.  * The UnitOfWork is responsible for tracking changes to objects during an
  74.  * "object-level" transaction and for writing out changes to the database
  75.  * in the correct order.
  76.  *
  77.  * Internal note: This class contains highly performance-sensitive code.
  78.  *
  79.  * @psalm-import-type AssociationMapping from ClassMetadataInfo
  80.  */
  81. class UnitOfWork implements PropertyChangedListener
  82. {
  83.     /**
  84.      * An entity is in MANAGED state when its persistence is managed by an EntityManager.
  85.      */
  86.     public const STATE_MANAGED = 1;
  88.     /**
  89.      * An entity is new if it has just been instantiated (i.e. using the "new" operator)
  90.      * and is not (yet) managed by an EntityManager.
  91.      */
  92.     public const STATE_NEW = 2;
  94.     /**
  95.      * A detached entity is an instance with persistent state and identity that is not
  96.      * (or no longer) associated with an EntityManager (and a UnitOfWork).
  97.      */
  98.     public const STATE_DETACHED = 3;
  100.     /**
  101.      * A removed entity instance is an instance with a persistent identity,
  102.      * associated with an EntityManager, whose persistent state will be deleted
  103.      * on commit.
  104.      */
  105.     public const STATE_REMOVED = 4;
  107.     /**
  108.      * Hint used to collect all primary keys of associated entities during hydration
  109.      * and execute it in a dedicated query afterwards
  110.      *
  111.      * @see https://www.doctrine-project.org/projects/doctrine-orm/en/stable/reference/dql-doctrine-query-language.html#temporarily-change-fetch-mode-in-dql
  112.      */
  113.     public const HINT_DEFEREAGERLOAD = 'deferEagerLoad';
  115.     /**
  116.      * The identity map that holds references to all managed entities that have
  117.      * an identity. The entities are grouped by their class name.
  118.      * Since all classes in a hierarchy must share the same identifier set,
  119.      * we always take the root class name of the hierarchy.
  120.      *
  121.      * @var mixed[]
  122.      * @psalm-var array<class-string, array<string, object|null>>
  123.      */
  124.     private $identityMap = [];
  126.     /**
  127.      * Map of all identifiers of managed entities.
  128.      * Keys are object ids (spl_object_id).
  129.      *
  130.      * @var mixed[]
  131.      * @psalm-var array<int, array<string, mixed>>
  132.      */
  133.     private $entityIdentifiers = [];
  135.     /**
  136.      * Map of the original entity data of managed entities.
  137.      * Keys are object ids (spl_object_id). This is used for calculating changesets
  138.      * at commit time.
  139.      *
  140.      * Internal note: Note that PHPs "copy-on-write" behavior helps a lot with memory usage.
  141.      *                A value will only really be copied if the value in the entity is modified
  142.      *                by the user.
  143.      *
  144.      * @psalm-var array<int, array<string, mixed>>
  145.      */
  146.     private $originalEntityData = [];
  148.     /**
  149.      * Map of entity changes. Keys are object ids (spl_object_id).
  150.      * Filled at the beginning of a commit of the UnitOfWork and cleaned at the end.
  151.      *
  152.      * @psalm-var array<int, array<string, array{mixed, mixed}>>
  153.      */
  154.     private $entityChangeSets = [];
  156.     /**
  157.      * The (cached) states of any known entities.
  158.      * Keys are object ids (spl_object_id).
  159.      *
  160.      * @psalm-var array<int, self::STATE_*>
  161.      */
  162.     private $entityStates = [];
  164.     /**
  165.      * Map of entities that are scheduled for dirty checking at commit time.
  166.      * This is only used for entities with a change tracking policy of DEFERRED_EXPLICIT.
  167.      * Keys are object ids (spl_object_id).
  168.      *
  169.      * @psalm-var array<class-string, array<int, mixed>>
  170.      */
  171.     private $scheduledForSynchronization = [];
  173.     /**
  174.      * A list of all pending entity insertions.
  175.      *
  176.      * @psalm-var array<int, object>
  177.      */
  178.     private $entityInsertions = [];
  180.     /**
  181.      * A list of all pending entity updates.
  182.      *
  183.      * @psalm-var array<int, object>
  184.      */
  185.     private $entityUpdates = [];
  187.     /**
  188.      * Any pending extra updates that have been scheduled by persisters.
  189.      *
  190.      * @psalm-var array<int, array{object, array<string, array{mixed, mixed}>}>
  191.      */
  192.     private $extraUpdates = [];
  194.     /**
  195.      * A list of all pending entity deletions.
  196.      *
  197.      * @psalm-var array<int, object>
  198.      */
  199.     private $entityDeletions = [];
  201.     /**
  202.      * New entities that were discovered through relationships that were not
  203.      * marked as cascade-persist. During flush, this array is populated and
  204.      * then pruned of any entities that were discovered through a valid
  205.      * cascade-persist path. (Leftovers cause an error.)
  206.      *
  207.      * Keys are OIDs, payload is a two-item array describing the association
  208.      * and the entity.
  209.      *
  210.      * @var object[][]|array[][] indexed by respective object spl_object_id()
  211.      */
  212.     private $nonCascadedNewDetectedEntities = [];
  214.     /**
  215.      * All pending collection deletions.
  216.      *
  217.      * @psalm-var array<int, Collection<array-key, object>>
  218.      */
  219.     private $collectionDeletions = [];
  221.     /**
  222.      * All pending collection updates.
  223.      *
  224.      * @psalm-var array<int, Collection<array-key, object>>
  225.      */
  226.     private $collectionUpdates = [];
  228.     /**
  229.      * List of collections visited during changeset calculation on a commit-phase of a UnitOfWork.
  230.      * At the end of the UnitOfWork all these collections will make new snapshots
  231.      * of their data.
  232.      *
  233.      * @psalm-var array<int, Collection<array-key, object>>
  234.      */
  235.     private $visitedCollections = [];
  237.     /**
  238.      * The EntityManager that "owns" this UnitOfWork instance.
  239.      *
  240.      * @var EntityManagerInterface
  241.      */
  242.     private $em;
  244.     /**
  245.      * The entity persister instances used to persist entity instances.
  246.      *
  247.      * @psalm-var array<string, EntityPersister>
  248.      */
  249.     private $persisters = [];
  251.     /**
  252.      * The collection persister instances used to persist collections.
  253.      *
  254.      * @psalm-var array<string, CollectionPersister>
  255.      */
  256.     private $collectionPersisters = [];
  258.     /**
  259.      * The EventManager used for dispatching events.
  260.      *
  261.      * @var EventManager
  262.      */
  263.     private $evm;
  265.     /**
  266.      * The ListenersInvoker used for dispatching events.
  267.      *
  268.      * @var ListenersInvoker
  269.      */
  270.     private $listenersInvoker;
  272.     /**
  273.      * The IdentifierFlattener used for manipulating identifiers
  274.      *
  275.      * @var IdentifierFlattener
  276.      */
  277.     private $identifierFlattener;
  279.     /**
  280.      * Orphaned entities that are scheduled for removal.
  281.      *
  282.      * @psalm-var array<int, object>
  283.      */
  284.     private $orphanRemovals = [];
  286.     /**
  287.      * Read-Only objects are never evaluated
  288.      *
  289.      * @var array<int, true>
  290.      */
  291.     private $readOnlyObjects = [];
  293.     /**
  294.      * Map of Entity Class-Names and corresponding IDs that should eager loaded when requested.
  295.      *
  296.      * @psalm-var array<class-string, array<string, mixed>>
  297.      */
  298.     private $eagerLoadingEntities = [];
  300.     /** @var bool */
  301.     protected $hasCache = false;
  303.     /**
  304.      * Helper for handling completion of hydration
  305.      *
  306.      * @var HydrationCompleteHandler
  307.      */
  308.     private $hydrationCompleteHandler;
  310.     /** @var ReflectionPropertiesGetter */
  311.     private $reflectionPropertiesGetter;
  313.     /**
  314.      * Initializes a new UnitOfWork instance, bound to the given EntityManager.
  315.      */
  316.     public function __construct(EntityManagerInterface $em)
  317.     {
  318.         $this->em                         = $em;
  319.         $this->evm                        = $em->getEventManager();
  320.         $this->listenersInvoker           = new ListenersInvoker($em);
  321.         $this->hasCache                   = $em->getConfiguration()->isSecondLevelCacheEnabled();
  322.         $this->identifierFlattener        = new IdentifierFlattener($this, $em->getMetadataFactory());
  323.         $this->hydrationCompleteHandler   = new HydrationCompleteHandler($this->listenersInvoker, $em);
  324.         $this->reflectionPropertiesGetter = new ReflectionPropertiesGetter(new RuntimeReflectionService());
  325.     }
  327.     /**
  328.      * Commits the UnitOfWork, executing all operations that have been postponed
  329.      * up to this point. The state of all managed entities will be synchronized with
  330.      * the database.
  331.      *
  332.      * The operations are executed in the following order:
  333.      *
  334.      * 1) All entity insertions
  335.      * 2) All entity updates
  336.      * 3) All collection deletions
  337.      * 4) All collection updates
  338.      * 5) All entity deletions
  339.      *
  340.      * @param object|mixed[]|null $entity
  341.      *
  342.      * @return void
  343.      *
  344.      * @throws Exception
  345.      */
  346.     public function commit($entity = null)
  347.     {
  348.         if ($entity !== null) {
  349.             Deprecation::triggerIfCalledFromOutside(
  350.                 'doctrine/orm',
  351.                 'https://github.com/doctrine/orm/issues/8459',
  352.                 'Calling %s() with any arguments to commit specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
  353.                 __METHOD__
  354.             );
  355.         }
  357.         $connection = $this->em->getConnection();
  359.         if ($connection instanceof PrimaryReadReplicaConnection) {
  360.             $connection->ensureConnectedToPrimary();
  361.         }
  363.         // Raise preFlush
  364.         if ($this->evm->hasListeners(Events::preFlush)) {
  365.             $this->evm->dispatchEvent(Events::preFlush, new PreFlushEventArgs($this->em));
  366.         }
  368.         // Compute changes done since last commit.
  369.         if ($entity === null) {
  370.             $this->computeChangeSets();
  371.         } elseif (is_object($entity)) {
  372.             $this->computeSingleEntityChangeSet($entity);
  373.         } elseif (is_array($entity)) {
  374.             foreach ($entity as $object) {
  375.                 $this->computeSingleEntityChangeSet($object);
  376.             }
  377.         }
  379.         if (
  380.             ! ($this->entityInsertions ||
  381.                 $this->entityDeletions ||
  382.                 $this->entityUpdates ||
  383.                 $this->collectionUpdates ||
  384.                 $this->collectionDeletions ||
  385.                 $this->orphanRemovals)
  386.         ) {
  387.             $this->dispatchOnFlushEvent();
  388.             $this->dispatchPostFlushEvent();
  390.             $this->postCommitCleanup($entity);
  392.             return; // Nothing to do.
  393.         }
  395.         $this->assertThatThereAreNoUnintentionallyNonPersistedAssociations();
  397.         if ($this->orphanRemovals) {
  398.             foreach ($this->orphanRemovals as $orphan) {
  399.                 $this->remove($orphan);
  400.             }
  401.         }
  403.         $this->dispatchOnFlushEvent();
  405.         // Now we need a commit order to maintain referential integrity
  406.         $commitOrder = $this->getCommitOrder();
  408.         $conn = $this->em->getConnection();
  409.         $conn->beginTransaction();
  411.         try {
  412.             // Collection deletions (deletions of complete collections)
  413.             foreach ($this->collectionDeletions as $collectionToDelete) {
  414.                 if (! $collectionToDelete instanceof PersistentCollection) {
  415.                     $this->getCollectionPersister($collectionToDelete->getMapping())->delete($collectionToDelete);
  417.                     continue;
  418.                 }
  420.                 // Deferred explicit tracked collections can be removed only when owning relation was persisted
  421.                 $owner = $collectionToDelete->getOwner();
  423.                 if ($this->em->getClassMetadata(get_class($owner))->isChangeTrackingDeferredImplicit() || $this->isScheduledForDirtyCheck($owner)) {
  424.                     $this->getCollectionPersister($collectionToDelete->getMapping())->delete($collectionToDelete);
  425.                 }
  426.             }
  428.             if ($this->entityInsertions) {
  429.                 foreach ($commitOrder as $class) {
  430.                     $this->executeInserts($class);
  431.                 }
  432.             }
  434.             if ($this->entityUpdates) {
  435.                 foreach ($commitOrder as $class) {
  436.                     $this->executeUpdates($class);
  437.                 }
  438.             }
  440.             // Extra updates that were requested by persisters.
  441.             if ($this->extraUpdates) {
  442.                 $this->executeExtraUpdates();
  443.             }
  445.             // Collection updates (deleteRows, updateRows, insertRows)
  446.             foreach ($this->collectionUpdates as $collectionToUpdate) {
  447.                 $this->getCollectionPersister($collectionToUpdate->getMapping())->update($collectionToUpdate);
  448.             }
  450.             // Entity deletions come last and need to be in reverse commit order
  451.             if ($this->entityDeletions) {
  452.                 for ($count = count($commitOrder), $i = $count - 1; $i >= 0 && $this->entityDeletions; --$i) {
  453.                     $this->executeDeletions($commitOrder[$i]);
  454.                 }
  455.             }
  457.             // Commit failed silently
  458.             if ($conn->commit() === false) {
  459.                 $object = is_object($entity) ? $entity : null;
  461.                 throw new OptimisticLockException('Commit failed', $object);
  462.             }
  463.         } catch (Throwable $e) {
  464.             $this->em->close();
  466.             if ($conn->isTransactionActive()) {
  467.                 $conn->rollBack();
  468.             }
  470.             $this->afterTransactionRolledBack();
  472.             throw $e;
  473.         }
  475.         $this->afterTransactionComplete();
  477.         // Take new snapshots from visited collections
  478.         foreach ($this->visitedCollections as $coll) {
  479.             $coll->takeSnapshot();
  480.         }
  482.         $this->dispatchPostFlushEvent();
  484.         $this->postCommitCleanup($entity);
  485.     }
  487.     /**
  488.      * @param object|object[]|null $entity
  489.      */
  490.     private function postCommitCleanup($entity): void
  491.     {
  492.         $this->entityInsertions               =
  493.         $this->entityUpdates                  =
  494.         $this->entityDeletions                =
  495.         $this->extraUpdates                   =
  496.         $this->collectionUpdates              =
  497.         $this->nonCascadedNewDetectedEntities =
  498.         $this->collectionDeletions            =
  499.         $this->visitedCollections             =
  500.         $this->orphanRemovals                 = [];
  502.         if ($entity === null) {
  503.             $this->entityChangeSets = $this->scheduledForSynchronization = [];
  505.             return;
  506.         }
  508.         $entities = is_object($entity)
  509.             ? [$entity]
  510.             : $entity;
  512.         foreach ($entities as $object) {
  513.             $oid = spl_object_id($object);
  515.             $this->clearEntityChangeSet($oid);
  517.             unset($this->scheduledForSynchronization[$this->em->getClassMetadata(get_class($object))->rootEntityName][$oid]);
  518.         }
  519.     }
  521.     /**
  522.      * Computes the changesets of all entities scheduled for insertion.
  523.      */
  524.     private function computeScheduleInsertsChangeSets(): void
  525.     {
  526.         foreach ($this->entityInsertions as $entity) {
  527.             $class = $this->em->getClassMetadata(get_class($entity));
  529.             $this->computeChangeSet($class, $entity);
  530.         }
  531.     }
  533.     /**
  534.      * Only flushes the given entity according to a ruleset that keeps the UoW consistent.
  535.      *
  536.      * 1. All entities scheduled for insertion, (orphan) removals and changes in collections are processed as well!
  537.      * 2. Read Only entities are skipped.
  538.      * 3. Proxies are skipped.
  539.      * 4. Only if entity is properly managed.
  540.      *
  541.      * @param object $entity
  542.      *
  543.      * @throws InvalidArgumentException
  544.      */
  545.     private function computeSingleEntityChangeSet($entity): void
  546.     {
  547.         $state = $this->getEntityState($entity);
  549.         if ($state !== self::STATE_MANAGED && $state !== self::STATE_REMOVED) {
  550.             throw new InvalidArgumentException('Entity has to be managed or scheduled for removal for single computation ' . self::objToStr($entity));
  551.         }
  553.         $class = $this->em->getClassMetadata(get_class($entity));
  555.         if ($state === self::STATE_MANAGED && $class->isChangeTrackingDeferredImplicit()) {
  556.             $this->persist($entity);
  557.         }
  559.         // Compute changes for INSERTed entities first. This must always happen even in this case.
  560.         $this->computeScheduleInsertsChangeSets();
  562.         if ($class->isReadOnly) {
  563.             return;
  564.         }
  566.         // Ignore uninitialized proxy objects
  567.         if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  568.             return;
  569.         }
  571.         // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION OR DELETION are processed here.
  572.         $oid = spl_object_id($entity);
  574.         if (! isset($this->entityInsertions[$oid]) && ! isset($this->entityDeletions[$oid]) && isset($this->entityStates[$oid])) {
  575.             $this->computeChangeSet($class, $entity);
  576.         }
  577.     }
  579.     /**
  580.      * Executes any extra updates that have been scheduled.
  581.      */
  582.     private function executeExtraUpdates(): void
  583.     {
  584.         foreach ($this->extraUpdates as $oid => $update) {
  585.             [$entity, $changeset] = $update;
  587.             $this->entityChangeSets[$oid] = $changeset;
  588.             $this->getEntityPersister(get_class($entity))->update($entity);
  589.         }
  591.         $this->extraUpdates = [];
  592.     }
  594.     /**
  595.      * Gets the changeset for an entity.
  596.      *
  597.      * @param object $entity
  598.      *
  599.      * @return mixed[][]
  600.      * @psalm-return array<string, array{mixed, mixed}|PersistentCollection>
  601.      */
  602.     public function & getEntityChangeSet($entity)
  603.     {
  604.         $oid  = spl_object_id($entity);
  605.         $data = [];
  607.         if (! isset($this->entityChangeSets[$oid])) {
  608.             return $data;
  609.         }
  611.         return $this->entityChangeSets[$oid];
  612.     }
  614.     /**
  615.      * Computes the changes that happened to a single entity.
  616.      *
  617.      * Modifies/populates the following properties:
  618.      *
  619.      * {@link _originalEntityData}
  620.      * If the entity is NEW or MANAGED but not yet fully persisted (only has an id)
  621.      * then it was not fetched from the database and therefore we have no original
  622.      * entity data yet. All of the current entity data is stored as the original entity data.
  623.      *
  624.      * {@link _entityChangeSets}
  625.      * The changes detected on all properties of the entity are stored there.
  626.      * A change is a tuple array where the first entry is the old value and the second
  627.      * entry is the new value of the property. Changesets are used by persisters
  628.      * to INSERT/UPDATE the persistent entity state.
  629.      *
  630.      * {@link _entityUpdates}
  631.      * If the entity is already fully MANAGED (has been fetched from the database before)
  632.      * and any changes to its properties are detected, then a reference to the entity is stored
  633.      * there to mark it for an update.
  634.      *
  635.      * {@link _collectionDeletions}
  636.      * If a PersistentCollection has been de-referenced in a fully MANAGED entity,
  637.      * then this collection is marked for deletion.
  638.      *
  639.      * @param ClassMetadata $class  The class descriptor of the entity.
  640.      * @param object        $entity The entity for which to compute the changes.
  641.      * @psalm-param ClassMetadata<T> $class
  642.      * @psalm-param T $entity
  643.      *
  644.      * @return void
  645.      *
  646.      * @template T of object
  647.      *
  648.      * @ignore
  649.      */
  650.     public function computeChangeSet(ClassMetadata $class, $entity)
  651.     {
  652.         $oid = spl_object_id($entity);
  654.         if (isset($this->readOnlyObjects[$oid])) {
  655.             return;
  656.         }
  658.         if (! $class->isInheritanceTypeNone()) {
  659.             $class = $this->em->getClassMetadata(get_class($entity));
  660.         }
  662.         $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preFlush) & ~ListenersInvoker::INVOKE_MANAGER;
  664.         if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  665.             $this->listenersInvoker->invoke($class, Events::preFlush, $entity, new PreFlushEventArgs($this->em), $invoke);
  666.         }
  668.         $actualData = [];
  670.         foreach ($class->reflFields as $name => $refProp) {
  671.             $value = $refProp->getValue($entity);
  673.             if ($class->isCollectionValuedAssociation($name) && $value !== null) {
  674.                 if ($value instanceof PersistentCollection) {
  675.                     if ($value->getOwner() === $entity) {
  676.                         continue;
  677.                     }
  679.                     $value = new ArrayCollection($value->getValues());
  680.                 }
  682.                 // If $value is not a Collection then use an ArrayCollection.
  683.                 if (! $value instanceof Collection) {
  684.                     $value = new ArrayCollection($value);
  685.                 }
  687.                 $assoc = $class->associationMappings[$name];
  689.                 // Inject PersistentCollection
  690.                 $value = new PersistentCollection(
  691.                     $this->em,
  692.                     $this->em->getClassMetadata($assoc['targetEntity']),
  693.                     $value
  694.                 );
  695.                 $value->setOwner($entity, $assoc);
  696.                 $value->setDirty(! $value->isEmpty());
  698.                 $class->reflFields[$name]->setValue($entity, $value);
  700.                 $actualData[$name] = $value;
  702.                 continue;
  703.             }
  705.             if (( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity()) && ($name !== $class->versionField)) {
  706.                 $actualData[$name] = $value;
  707.             }
  708.         }
  710.         if (! isset($this->originalEntityData[$oid])) {
  711.             // Entity is either NEW or MANAGED but not yet fully persisted (only has an id).
  712.             // These result in an INSERT.
  713.             $this->originalEntityData[$oid] = $actualData;
  714.             $changeSet                      = [];
  716.             foreach ($actualData as $propName => $actualValue) {
  717.                 if (! isset($class->associationMappings[$propName])) {
  718.                     $changeSet[$propName] = [null, $actualValue];
  720.                     continue;
  721.                 }
  723.                 $assoc = $class->associationMappings[$propName];
  725.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  726.                     $changeSet[$propName] = [null, $actualValue];
  727.                 }
  728.             }
  730.             $this->entityChangeSets[$oid] = $changeSet;
  731.         } else {
  732.             // Entity is "fully" MANAGED: it was already fully persisted before
  733.             // and we have a copy of the original data
  734.             $originalData           = $this->originalEntityData[$oid];
  735.             $isChangeTrackingNotify = $class->isChangeTrackingNotify();
  736.             $changeSet              = $isChangeTrackingNotify && isset($this->entityChangeSets[$oid])
  737.                 ? $this->entityChangeSets[$oid]
  738.                 : [];
  740.             foreach ($actualData as $propName => $actualValue) {
  741.                 // skip field, its a partially omitted one!
  742.                 if (! (isset($originalData[$propName]) || array_key_exists($propName, $originalData))) {
  743.                     continue;
  744.                 }
  746.                 $orgValue = $originalData[$propName];
  748.                 // skip if value haven't changed
  749.                 if ($orgValue === $actualValue) {
  750.                     continue;
  751.                 }
  753.                 // if regular field
  754.                 if (! isset($class->associationMappings[$propName])) {
  755.                     if ($isChangeTrackingNotify) {
  756.                         continue;
  757.                     }
  759.                     $changeSet[$propName] = [$orgValue, $actualValue];
  761.                     continue;
  762.                 }
  764.                 $assoc = $class->associationMappings[$propName];
  766.                 // Persistent collection was exchanged with the "originally"
  767.                 // created one. This can only mean it was cloned and replaced
  768.                 // on another entity.
  769.                 if ($actualValue instanceof PersistentCollection) {
  770.                     $owner = $actualValue->getOwner();
  771.                     if ($owner === null) { // cloned
  772.                         $actualValue->setOwner($entity, $assoc);
  773.                     } elseif ($owner !== $entity) { // no clone, we have to fix
  774.                         if (! $actualValue->isInitialized()) {
  775.                             $actualValue->initialize(); // we have to do this otherwise the cols share state
  776.                         }
  778.                         $newValue = clone $actualValue;
  779.                         $newValue->setOwner($entity, $assoc);
  780.                         $class->reflFields[$propName]->setValue($entity, $newValue);
  781.                     }
  782.                 }
  784.                 if ($orgValue instanceof PersistentCollection) {
  785.                     // A PersistentCollection was de-referenced, so delete it.
  786.                     $coid = spl_object_id($orgValue);
  788.                     if (isset($this->collectionDeletions[$coid])) {
  789.                         continue;
  790.                     }
  792.                     $this->collectionDeletions[$coid] = $orgValue;
  793.                     $changeSet[$propName]             = $orgValue; // Signal changeset, to-many assocs will be ignored.
  795.                     continue;
  796.                 }
  798.                 if ($assoc['type'] & ClassMetadata::TO_ONE) {
  799.                     if ($assoc['isOwningSide']) {
  800.                         $changeSet[$propName] = [$orgValue, $actualValue];
  801.                     }
  803.                     if ($orgValue !== null && $assoc['orphanRemoval']) {
  804.                         $this->scheduleOrphanRemoval($orgValue);
  805.                     }
  806.                 }
  807.             }
  809.             if ($changeSet) {
  810.                 $this->entityChangeSets[$oid]   = $changeSet;
  811.                 $this->originalEntityData[$oid] = $actualData;
  812.                 $this->entityUpdates[$oid]      = $entity;
  813.             }
  814.         }
  816.         // Look for changes in associations of the entity
  817.         foreach ($class->associationMappings as $field => $assoc) {
  818.             $val = $class->reflFields[$field]->getValue($entity);
  819.             if ($val === null) {
  820.                 continue;
  821.             }
  823.             $this->computeAssociationChanges($assoc, $val);
  825.             if (
  826.                 ! isset($this->entityChangeSets[$oid]) &&
  827.                 $assoc['isOwningSide'] &&
  828.                 $assoc['type'] === ClassMetadata::MANY_TO_MANY &&
  829.                 $val instanceof PersistentCollection &&
  830.                 $val->isDirty()
  831.             ) {
  832.                 $this->entityChangeSets[$oid]   = [];
  833.                 $this->originalEntityData[$oid] = $actualData;
  834.                 $this->entityUpdates[$oid]      = $entity;
  835.             }
  836.         }
  837.     }
  839.     /**
  840.      * Computes all the changes that have been done to entities and collections
  841.      * since the last commit and stores these changes in the _entityChangeSet map
  842.      * temporarily for access by the persisters, until the UoW commit is finished.
  843.      *
  844.      * @return void
  845.      */
  846.     public function computeChangeSets()
  847.     {
  848.         // Compute changes for INSERTed entities first. This must always happen.
  849.         $this->computeScheduleInsertsChangeSets();
  851.         // Compute changes for other MANAGED entities. Change tracking policies take effect here.
  852.         foreach ($this->identityMap as $className => $entities) {
  853.             $class = $this->em->getClassMetadata($className);
  855.             // Skip class if instances are read-only
  856.             if ($class->isReadOnly) {
  857.                 continue;
  858.             }
  860.             // If change tracking is explicit or happens through notification, then only compute
  861.             // changes on entities of that type that are explicitly marked for synchronization.
  862.             switch (true) {
  863.                 case $class->isChangeTrackingDeferredImplicit():
  864.                     $entitiesToProcess = $entities;
  865.                     break;
  867.                 case isset($this->scheduledForSynchronization[$className]):
  868.                     $entitiesToProcess = $this->scheduledForSynchronization[$className];
  869.                     break;
  871.                 default:
  872.                     $entitiesToProcess = [];
  873.             }
  875.             foreach ($entitiesToProcess as $entity) {
  876.                 // Ignore uninitialized proxy objects
  877.                 if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  878.                     continue;
  879.                 }
  881.                 // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION OR DELETION are processed here.
  882.                 $oid = spl_object_id($entity);
  884.                 if (! isset($this->entityInsertions[$oid]) && ! isset($this->entityDeletions[$oid]) && isset($this->entityStates[$oid])) {
  885.                     $this->computeChangeSet($class, $entity);
  886.                 }
  887.             }
  888.         }
  889.     }
  891.     /**
  892.      * Computes the changes of an association.
  893.      *
  894.      * @param mixed $value The value of the association.
  895.      * @psalm-param array<string, mixed> $assoc The association mapping.
  896.      *
  897.      * @throws ORMInvalidArgumentException
  898.      * @throws ORMException
  899.      */
  900.     private function computeAssociationChanges(array $assoc, $value): void
  901.     {
  902.         if ($value instanceof Proxy && ! $value->__isInitialized()) {
  903.             return;
  904.         }
  906.         if ($value instanceof PersistentCollection && $value->isDirty()) {
  907.             $coid = spl_object_id($value);
  909.             $this->collectionUpdates[$coid]  = $value;
  910.             $this->visitedCollections[$coid] = $value;
  911.         }
  913.         // Look through the entities, and in any of their associations,
  914.         // for transient (new) entities, recursively. ("Persistence by reachability")
  915.         // Unwrap. Uninitialized collections will simply be empty.
  916.         $unwrappedValue = $assoc['type'] & ClassMetadata::TO_ONE ? [$value] : $value->unwrap();
  917.         $targetClass    = $this->em->getClassMetadata($assoc['targetEntity']);
  919.         foreach ($unwrappedValue as $key => $entry) {
  920.             if (! ($entry instanceof $targetClass->name)) {
  921.                 throw ORMInvalidArgumentException::invalidAssociation($targetClass, $assoc, $entry);
  922.             }
  924.             $state = $this->getEntityState($entry, self::STATE_NEW);
  926.             if (! ($entry instanceof $assoc['targetEntity'])) {
  927.                 throw UnexpectedAssociationValue::create(
  928.                     $assoc['sourceEntity'],
  929.                     $assoc['fieldName'],
  930.                     get_debug_type($entry),
  931.                     $assoc['targetEntity']
  932.                 );
  933.             }
  935.             switch ($state) {
  936.                 case self::STATE_NEW:
  937.                     if (! $assoc['isCascadePersist']) {
  938.                         /*
  939.                          * For now just record the details, because this may
  940.                          * not be an issue if we later discover another pathway
  941.                          * through the object-graph where cascade-persistence
  942.                          * is enabled for this object.
  943.                          */
  944.                         $this->nonCascadedNewDetectedEntities[spl_object_id($entry)] = [$assoc, $entry];
  946.                         break;
  947.                     }
  949.                     $this->persistNew($targetClass, $entry);
  950.                     $this->computeChangeSet($targetClass, $entry);
  952.                     break;
  954.                 case self::STATE_REMOVED:
  955.                     // Consume the $value as array (it's either an array or an ArrayAccess)
  956.                     // and remove the element from Collection.
  957.                     if ($assoc['type'] & ClassMetadata::TO_MANY) {
  958.                         unset($value[$key]);
  959.                     }
  961.                     break;
  963.                 case self::STATE_DETACHED:
  964.                     // Can actually not happen right now as we assume STATE_NEW,
  965.                     // so the exception will be raised from the DBAL layer (constraint violation).
  966.                     throw ORMInvalidArgumentException::detachedEntityFoundThroughRelationship($assoc, $entry);
  968.                 default:
  969.                     // MANAGED associated entities are already taken into account
  970.                     // during changeset calculation anyway, since they are in the identity map.
  971.             }
  972.         }
  973.     }
  975.     /**
  976.      * @param object $entity
  977.      * @psalm-param ClassMetadata<T> $class
  978.      * @psalm-param T $entity
  979.      *
  980.      * @template T of object
  981.      */
  982.     private function persistNew(ClassMetadata $class, $entity): void
  983.     {
  984.         $oid    = spl_object_id($entity);
  985.         $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::prePersist);
  987.         if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  988.             $this->listenersInvoker->invoke($class, Events::prePersist, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  989.         }
  991.         $idGen = $class->idGenerator;
  993.         if (! $idGen->isPostInsertGenerator()) {
  994.             $idValue = $idGen->generateId($this->em, $entity);
  996.             if (! $idGen instanceof AssignedGenerator) {
  997.                 $idValue = [$class->getSingleIdentifierFieldName() => $this->convertSingleFieldIdentifierToPHPValue($class, $idValue)];
  999.                 $class->setIdentifierValues($entity, $idValue);
  1000.             }
  1002.             // Some identifiers may be foreign keys to new entities.
  1003.             // In this case, we don't have the value yet and should treat it as if we have a post-insert generator
  1004.             if (! $this->hasMissingIdsWhichAreForeignKeys($class, $idValue)) {
  1005.                 $this->entityIdentifiers[$oid] = $idValue;
  1006.             }
  1007.         }
  1009.         $this->entityStates[$oid] = self::STATE_MANAGED;
  1011.         $this->scheduleForInsert($entity);
  1012.     }
  1014.     /**
  1015.      * @param mixed[] $idValue
  1016.      */
  1017.     private function hasMissingIdsWhichAreForeignKeys(ClassMetadata $class, array $idValue): bool
  1018.     {
  1019.         foreach ($idValue as $idField => $idFieldValue) {
  1020.             if ($idFieldValue === null && isset($class->associationMappings[$idField])) {
  1021.                 return true;
  1022.             }
  1023.         }
  1025.         return false;
  1026.     }
  1028.     /**
  1029.      * INTERNAL:
  1030.      * Computes the changeset of an individual entity, independently of the
  1031.      * computeChangeSets() routine that is used at the beginning of a UnitOfWork#commit().
  1032.      *
  1033.      * The passed entity must be a managed entity. If the entity already has a change set
  1034.      * because this method is invoked during a commit cycle then the change sets are added.
  1035.      * whereby changes detected in this method prevail.
  1036.      *
  1037.      * @param ClassMetadata $class  The class descriptor of the entity.
  1038.      * @param object        $entity The entity for which to (re)calculate the change set.
  1039.      * @psalm-param ClassMetadata<T> $class
  1040.      * @psalm-param T $entity
  1041.      *
  1042.      * @return void
  1043.      *
  1044.      * @throws ORMInvalidArgumentException If the passed entity is not MANAGED.
  1045.      *
  1046.      * @template T of object
  1047.      * @ignore
  1048.      */
  1049.     public function recomputeSingleEntityChangeSet(ClassMetadata $class, $entity)
  1050.     {
  1051.         $oid = spl_object_id($entity);
  1053.         if (! isset($this->entityStates[$oid]) || $this->entityStates[$oid] !== self::STATE_MANAGED) {
  1054.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  1055.         }
  1057.         // skip if change tracking is "NOTIFY"
  1058.         if ($class->isChangeTrackingNotify()) {
  1059.             return;
  1060.         }
  1062.         if (! $class->isInheritanceTypeNone()) {
  1063.             $class = $this->em->getClassMetadata(get_class($entity));
  1064.         }
  1066.         $actualData = [];
  1068.         foreach ($class->reflFields as $name => $refProp) {
  1069.             if (
  1070.                 ( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity())
  1071.                 && ($name !== $class->versionField)
  1072.                 && ! $class->isCollectionValuedAssociation($name)
  1073.             ) {
  1074.                 $actualData[$name] = $refProp->getValue($entity);
  1075.             }
  1076.         }
  1078.         if (! isset($this->originalEntityData[$oid])) {
  1079.             throw new RuntimeException('Cannot call recomputeSingleEntityChangeSet before computeChangeSet on an entity.');
  1080.         }
  1082.         $originalData = $this->originalEntityData[$oid];
  1083.         $changeSet    = [];
  1085.         foreach ($actualData as $propName => $actualValue) {
  1086.             $orgValue = $originalData[$propName] ?? null;
  1088.             if ($orgValue !== $actualValue) {
  1089.                 $changeSet[$propName] = [$orgValue, $actualValue];
  1090.             }
  1091.         }
  1093.         if ($changeSet) {
  1094.             if (isset($this->entityChangeSets[$oid])) {
  1095.                 $this->entityChangeSets[$oid] = array_merge($this->entityChangeSets[$oid], $changeSet);
  1096.             } elseif (! isset($this->entityInsertions[$oid])) {
  1097.                 $this->entityChangeSets[$oid] = $changeSet;
  1098.                 $this->entityUpdates[$oid]    = $entity;
  1099.             }
  1101.             $this->originalEntityData[$oid] = $actualData;
  1102.         }
  1103.     }
  1105.     /**
  1106.      * Executes all entity insertions for entities of the specified type.
  1107.      */
  1108.     private function executeInserts(ClassMetadata $class): void
  1109.     {
  1110.         $entities  = [];
  1111.         $className = $class->name;
  1112.         $persister = $this->getEntityPersister($className);
  1113.         $invoke    = $this->listenersInvoker->getSubscribedSystems($class, Events::postPersist);
  1115.         $insertionsForClass = [];
  1117.         foreach ($this->entityInsertions as $oid => $entity) {
  1118.             if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
  1119.                 continue;
  1120.             }
  1122.             $insertionsForClass[$oid] = $entity;
  1124.             $persister->addInsert($entity);
  1126.             unset($this->entityInsertions[$oid]);
  1128.             if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1129.                 $entities[] = $entity;
  1130.             }
  1131.         }
  1133.         $postInsertIds = $persister->executeInserts();
  1135.         if ($postInsertIds) {
  1136.             // Persister returned post-insert IDs
  1137.             foreach ($postInsertIds as $postInsertId) {
  1138.                 $idField = $class->getSingleIdentifierFieldName();
  1139.                 $idValue = $this->convertSingleFieldIdentifierToPHPValue($class, $postInsertId['generatedId']);
  1141.                 $entity = $postInsertId['entity'];
  1142.                 $oid    = spl_object_id($entity);
  1144.                 $class->reflFields[$idField]->setValue($entity, $idValue);
  1146.                 $this->entityIdentifiers[$oid]            = [$idField => $idValue];
  1147.                 $this->entityStates[$oid]                 = self::STATE_MANAGED;
  1148.                 $this->originalEntityData[$oid][$idField] = $idValue;
  1150.                 $this->addToIdentityMap($entity);
  1151.             }
  1152.         } else {
  1153.             foreach ($insertionsForClass as $oid => $entity) {
  1154.                 if (! isset($this->entityIdentifiers[$oid])) {
  1155.                     //entity was not added to identity map because some identifiers are foreign keys to new entities.
  1156.                     //add it now
  1157.                     $this->addToEntityIdentifiersAndEntityMap($class, $oid, $entity);
  1158.                 }
  1159.             }
  1160.         }
  1162.         foreach ($entities as $entity) {
  1163.             $this->listenersInvoker->invoke($class, Events::postPersist, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  1164.         }
  1165.     }
  1167.     /**
  1168.      * @param object $entity
  1169.      * @psalm-param ClassMetadata<T> $class
  1170.      * @psalm-param T $entity
  1171.      *
  1172.      * @template T of object
  1173.      */
  1174.     private function addToEntityIdentifiersAndEntityMap(
  1175.         ClassMetadata $class,
  1176.         int $oid,
  1177.         $entity
  1178.     ): void {
  1179.         $identifier = [];
  1181.         foreach ($class->getIdentifierFieldNames() as $idField) {
  1182.             $origValue = $class->getFieldValue($entity, $idField);
  1184.             $value = null;
  1185.             if (isset($class->associationMappings[$idField])) {
  1186.                 // NOTE: Single Columns as associated identifiers only allowed - this constraint it is enforced.
  1187.                 $value = $this->getSingleIdentifierValue($origValue);
  1188.             }
  1190.             $identifier[$idField]                     = $value ?? $origValue;
  1191.             $this->originalEntityData[$oid][$idField] = $origValue;
  1192.         }
  1194.         $this->entityStates[$oid]      = self::STATE_MANAGED;
  1195.         $this->entityIdentifiers[$oid] = $identifier;
  1197.         $this->addToIdentityMap($entity);
  1198.     }
  1200.     /**
  1201.      * Executes all entity updates for entities of the specified type.
  1202.      */
  1203.     private function executeUpdates(ClassMetadata $class): void
  1204.     {
  1205.         $className        = $class->name;
  1206.         $persister        = $this->getEntityPersister($className);
  1207.         $preUpdateInvoke  = $this->listenersInvoker->getSubscribedSystems($class, Events::preUpdate);
  1208.         $postUpdateInvoke = $this->listenersInvoker->getSubscribedSystems($class, Events::postUpdate);
  1210.         foreach ($this->entityUpdates as $oid => $entity) {
  1211.             if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
  1212.                 continue;
  1213.             }
  1215.             if ($preUpdateInvoke !== ListenersInvoker::INVOKE_NONE) {
  1216.                 $this->listenersInvoker->invoke($class, Events::preUpdate, $entity, new PreUpdateEventArgs($entity, $this->em, $this->getEntityChangeSet($entity)), $preUpdateInvoke);
  1218.                 $this->recomputeSingleEntityChangeSet($class, $entity);
  1219.             }
  1221.             if (! empty($this->entityChangeSets[$oid])) {
  1222.                 $persister->update($entity);
  1223.             }
  1225.             unset($this->entityUpdates[$oid]);
  1227.             if ($postUpdateInvoke !== ListenersInvoker::INVOKE_NONE) {
  1228.                 $this->listenersInvoker->invoke($class, Events::postUpdate, $entity, new LifecycleEventArgs($entity, $this->em), $postUpdateInvoke);
  1229.             }
  1230.         }
  1231.     }
  1233.     /**
  1234.      * Executes all entity deletions for entities of the specified type.
  1235.      */
  1236.     private function executeDeletions(ClassMetadata $class): void
  1237.     {
  1238.         $className = $class->name;
  1239.         $persister = $this->getEntityPersister($className);
  1240.         $invoke    = $this->listenersInvoker->getSubscribedSystems($class, Events::postRemove);
  1242.         foreach ($this->entityDeletions as $oid => $entity) {
  1243.             if ($this->em->getClassMetadata(get_class($entity))->name !== $className) {
  1244.                 continue;
  1245.             }
  1247.             $persister->delete($entity);
  1249.             unset(
  1250.                 $this->entityDeletions[$oid],
  1251.                 $this->entityIdentifiers[$oid],
  1252.                 $this->originalEntityData[$oid],
  1253.                 $this->entityStates[$oid]
  1254.             );
  1256.             // Entity with this $oid after deletion treated as NEW, even if the $oid
  1257.             // is obtained by a new entity because the old one went out of scope.
  1258.             //$this->entityStates[$oid] = self::STATE_NEW;
  1259.             if (! $class->isIdentifierNatural()) {
  1260.                 $class->reflFields[$class->identifier[0]]->setValue($entity, null);
  1261.             }
  1263.             if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1264.                 $this->listenersInvoker->invoke($class, Events::postRemove, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  1265.             }
  1266.         }
  1267.     }
  1269.     /**
  1270.      * Gets the commit order.
  1271.      *
  1272.      * @return list<object>
  1273.      */
  1274.     private function getCommitOrder(): array
  1275.     {
  1276.         $calc = $this->getCommitOrderCalculator();
  1278.         // See if there are any new classes in the changeset, that are not in the
  1279.         // commit order graph yet (don't have a node).
  1280.         // We have to inspect changeSet to be able to correctly build dependencies.
  1281.         // It is not possible to use IdentityMap here because post inserted ids
  1282.         // are not yet available.
  1283.         $newNodes = [];
  1285.         foreach (array_merge($this->entityInsertions, $this->entityUpdates, $this->entityDeletions) as $entity) {
  1286.             $class = $this->em->getClassMetadata(get_class($entity));
  1288.             if ($calc->hasNode($class->name)) {
  1289.                 continue;
  1290.             }
  1292.             $calc->addNode($class->name, $class);
  1294.             $newNodes[] = $class;
  1295.         }
  1297.         // Calculate dependencies for new nodes
  1298.         while ($class = array_pop($newNodes)) {
  1299.             foreach ($class->associationMappings as $assoc) {
  1300.                 if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1301.                     continue;
  1302.                 }
  1304.                 $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  1306.                 if (! $calc->hasNode($targetClass->name)) {
  1307.                     $calc->addNode($targetClass->name, $targetClass);
  1309.                     $newNodes[] = $targetClass;
  1310.                 }
  1312.                 $joinColumns = reset($assoc['joinColumns']);
  1314.                 $calc->addDependency($targetClass->name, $class->name, (int) empty($joinColumns['nullable']));
  1316.                 // If the target class has mapped subclasses, these share the same dependency.
  1317.                 if (! $targetClass->subClasses) {
  1318.                     continue;
  1319.                 }
  1321.                 foreach ($targetClass->subClasses as $subClassName) {
  1322.                     $targetSubClass = $this->em->getClassMetadata($subClassName);
  1324.                     if (! $calc->hasNode($subClassName)) {
  1325.                         $calc->addNode($targetSubClass->name, $targetSubClass);
  1327.                         $newNodes[] = $targetSubClass;
  1328.                     }
  1330.                     $calc->addDependency($targetSubClass->name, $class->name, 1);
  1331.                 }
  1332.             }
  1333.         }
  1335.         return $calc->sort();
  1336.     }
  1338.     /**
  1339.      * Schedules an entity for insertion into the database.
  1340.      * If the entity already has an identifier, it will be added to the identity map.
  1341.      *
  1342.      * @param object $entity The entity to schedule for insertion.
  1343.      *
  1344.      * @return void
  1345.      *
  1346.      * @throws ORMInvalidArgumentException
  1347.      * @throws InvalidArgumentException
  1348.      */
  1349.     public function scheduleForInsert($entity)
  1350.     {
  1351.         $oid = spl_object_id($entity);
  1353.         if (isset($this->entityUpdates[$oid])) {
  1354.             throw new InvalidArgumentException('Dirty entity can not be scheduled for insertion.');
  1355.         }
  1357.         if (isset($this->entityDeletions[$oid])) {
  1358.             throw ORMInvalidArgumentException::scheduleInsertForRemovedEntity($entity);
  1359.         }
  1361.         if (isset($this->originalEntityData[$oid]) && ! isset($this->entityInsertions[$oid])) {
  1362.             throw ORMInvalidArgumentException::scheduleInsertForManagedEntity($entity);
  1363.         }
  1365.         if (isset($this->entityInsertions[$oid])) {
  1366.             throw ORMInvalidArgumentException::scheduleInsertTwice($entity);
  1367.         }
  1369.         $this->entityInsertions[$oid] = $entity;
  1371.         if (isset($this->entityIdentifiers[$oid])) {
  1372.             $this->addToIdentityMap($entity);
  1373.         }
  1375.         if ($entity instanceof NotifyPropertyChanged) {
  1376.             $entity->addPropertyChangedListener($this);
  1377.         }
  1378.     }
  1380.     /**
  1381.      * Checks whether an entity is scheduled for insertion.
  1382.      *
  1383.      * @param object $entity
  1384.      *
  1385.      * @return bool
  1386.      */
  1387.     public function isScheduledForInsert($entity)
  1388.     {
  1389.         return isset($this->entityInsertions[spl_object_id($entity)]);
  1390.     }
  1392.     /**
  1393.      * Schedules an entity for being updated.
  1394.      *
  1395.      * @param object $entity The entity to schedule for being updated.
  1396.      *
  1397.      * @return void
  1398.      *
  1399.      * @throws ORMInvalidArgumentException
  1400.      */
  1401.     public function scheduleForUpdate($entity)
  1402.     {
  1403.         $oid = spl_object_id($entity);
  1405.         if (! isset($this->entityIdentifiers[$oid])) {
  1406.             throw ORMInvalidArgumentException::entityHasNoIdentity($entity, 'scheduling for update');
  1407.         }
  1409.         if (isset($this->entityDeletions[$oid])) {
  1410.             throw ORMInvalidArgumentException::entityIsRemoved($entity, 'schedule for update');
  1411.         }
  1413.         if (! isset($this->entityUpdates[$oid]) && ! isset($this->entityInsertions[$oid])) {
  1414.             $this->entityUpdates[$oid] = $entity;
  1415.         }
  1416.     }
  1418.     /**
  1419.      * INTERNAL:
  1420.      * Schedules an extra update that will be executed immediately after the
  1421.      * regular entity updates within the currently running commit cycle.
  1422.      *
  1423.      * Extra updates for entities are stored as (entity, changeset) tuples.
  1424.      *
  1425.      * @param object $entity The entity for which to schedule an extra update.
  1426.      * @psalm-param array<string, array{mixed, mixed}>  $changeset The changeset of the entity (what to update).
  1427.      *
  1428.      * @return void
  1429.      *
  1430.      * @ignore
  1431.      */
  1432.     public function scheduleExtraUpdate($entity, array $changeset)
  1433.     {
  1434.         $oid         = spl_object_id($entity);
  1435.         $extraUpdate = [$entity, $changeset];
  1437.         if (isset($this->extraUpdates[$oid])) {
  1438.             [, $changeset2] = $this->extraUpdates[$oid];
  1440.             $extraUpdate = [$entity, $changeset + $changeset2];
  1441.         }
  1443.         $this->extraUpdates[$oid] = $extraUpdate;
  1444.     }
  1446.     /**
  1447.      * Checks whether an entity is registered as dirty in the unit of work.
  1448.      * Note: Is not very useful currently as dirty entities are only registered
  1449.      * at commit time.
  1450.      *
  1451.      * @param object $entity
  1452.      *
  1453.      * @return bool
  1454.      */
  1455.     public function isScheduledForUpdate($entity)
  1456.     {
  1457.         return isset($this->entityUpdates[spl_object_id($entity)]);
  1458.     }
  1460.     /**
  1461.      * Checks whether an entity is registered to be checked in the unit of work.
  1462.      *
  1463.      * @param object $entity
  1464.      *
  1465.      * @return bool
  1466.      */
  1467.     public function isScheduledForDirtyCheck($entity)
  1468.     {
  1469.         $rootEntityName = $this->em->getClassMetadata(get_class($entity))->rootEntityName;
  1471.         return isset($this->scheduledForSynchronization[$rootEntityName][spl_object_id($entity)]);
  1472.     }
  1474.     /**
  1475.      * INTERNAL:
  1476.      * Schedules an entity for deletion.
  1477.      *
  1478.      * @param object $entity
  1479.      *
  1480.      * @return void
  1481.      */
  1482.     public function scheduleForDelete($entity)
  1483.     {
  1484.         $oid = spl_object_id($entity);
  1486.         if (isset($this->entityInsertions[$oid])) {
  1487.             if ($this->isInIdentityMap($entity)) {
  1488.                 $this->removeFromIdentityMap($entity);
  1489.             }
  1491.             unset($this->entityInsertions[$oid], $this->entityStates[$oid]);
  1493.             return; // entity has not been persisted yet, so nothing more to do.
  1494.         }
  1496.         if (! $this->isInIdentityMap($entity)) {
  1497.             return;
  1498.         }
  1500.         $this->removeFromIdentityMap($entity);
  1502.         unset($this->entityUpdates[$oid]);
  1504.         if (! isset($this->entityDeletions[$oid])) {
  1505.             $this->entityDeletions[$oid] = $entity;
  1506.             $this->entityStates[$oid]    = self::STATE_REMOVED;
  1507.         }
  1508.     }
  1510.     /**
  1511.      * Checks whether an entity is registered as removed/deleted with the unit
  1512.      * of work.
  1513.      *
  1514.      * @param object $entity
  1515.      *
  1516.      * @return bool
  1517.      */
  1518.     public function isScheduledForDelete($entity)
  1519.     {
  1520.         return isset($this->entityDeletions[spl_object_id($entity)]);
  1521.     }
  1523.     /**
  1524.      * Checks whether an entity is scheduled for insertion, update or deletion.
  1525.      *
  1526.      * @param object $entity
  1527.      *
  1528.      * @return bool
  1529.      */
  1530.     public function isEntityScheduled($entity)
  1531.     {
  1532.         $oid = spl_object_id($entity);
  1534.         return isset($this->entityInsertions[$oid])
  1535.             || isset($this->entityUpdates[$oid])
  1536.             || isset($this->entityDeletions[$oid]);
  1537.     }
  1539.     /**
  1540.      * INTERNAL:
  1541.      * Registers an entity in the identity map.
  1542.      * Note that entities in a hierarchy are registered with the class name of
  1543.      * the root entity.
  1544.      *
  1545.      * @param object $entity The entity to register.
  1546.      *
  1547.      * @return bool TRUE if the registration was successful, FALSE if the identity of
  1548.      * the entity in question is already managed.
  1549.      *
  1550.      * @throws ORMInvalidArgumentException
  1551.      *
  1552.      * @ignore
  1553.      */
  1554.     public function addToIdentityMap($entity)
  1555.     {
  1556.         $classMetadata = $this->em->getClassMetadata(get_class($entity));
  1557.         $identifier    = $this->entityIdentifiers[spl_object_id($entity)];
  1559.         if (empty($identifier) || in_array(null, $identifier, true)) {
  1560.             throw ORMInvalidArgumentException::entityWithoutIdentity($classMetadata->name, $entity);
  1561.         }
  1563.         $idHash    = implode(' ', $identifier);
  1564.         $className = $classMetadata->rootEntityName;
  1566.         if (isset($this->identityMap[$className][$idHash])) {
  1567.             return false;
  1568.         }
  1570.         $this->identityMap[$className][$idHash] = $entity;
  1572.         return true;
  1573.     }
  1575.     /**
  1576.      * Gets the state of an entity with regard to the current unit of work.
  1577.      *
  1578.      * @param object   $entity
  1579.      * @param int|null $assume The state to assume if the state is not yet known (not MANAGED or REMOVED).
  1580.      *                         This parameter can be set to improve performance of entity state detection
  1581.      *                         by potentially avoiding a database lookup if the distinction between NEW and DETACHED
  1582.      *                         is either known or does not matter for the caller of the method.
  1583.      * @psalm-param self::STATE_*|null $assume
  1584.      *
  1585.      * @return int The entity state.
  1586.      * @psalm-return self::STATE_*
  1587.      */
  1588.     public function getEntityState($entity, $assume = null)
  1589.     {
  1590.         $oid = spl_object_id($entity);
  1592.         if (isset($this->entityStates[$oid])) {
  1593.             return $this->entityStates[$oid];
  1594.         }
  1596.         if ($assume !== null) {
  1597.             return $assume;
  1598.         }
  1600.         // State can only be NEW or DETACHED, because MANAGED/REMOVED states are known.
  1601.         // Note that you can not remember the NEW or DETACHED state in _entityStates since
  1602.         // the UoW does not hold references to such objects and the object hash can be reused.
  1603.         // More generally because the state may "change" between NEW/DETACHED without the UoW being aware of it.
  1604.         $class = $this->em->getClassMetadata(get_class($entity));
  1605.         $id    = $class->getIdentifierValues($entity);
  1607.         if (! $id) {
  1608.             return self::STATE_NEW;
  1609.         }
  1611.         if ($class->containsForeignIdentifier || $class->containsEnumIdentifier) {
  1612.             $id = $this->identifierFlattener->flattenIdentifier($class, $id);
  1613.         }
  1615.         switch (true) {
  1616.             case $class->isIdentifierNatural():
  1617.                 // Check for a version field, if available, to avoid a db lookup.
  1618.                 if ($class->isVersioned) {
  1619.                     assert($class->versionField !== null);
  1621.                     return $class->getFieldValue($entity, $class->versionField)
  1622.                         ? self::STATE_DETACHED
  1623.                         : self::STATE_NEW;
  1624.                 }
  1626.                 // Last try before db lookup: check the identity map.
  1627.                 if ($this->tryGetById($id, $class->rootEntityName)) {
  1628.                     return self::STATE_DETACHED;
  1629.                 }
  1631.                 // db lookup
  1632.                 if ($this->getEntityPersister($class->name)->exists($entity)) {
  1633.                     return self::STATE_DETACHED;
  1634.                 }
  1636.                 return self::STATE_NEW;
  1638.             case ! $class->idGenerator->isPostInsertGenerator():
  1639.                 // if we have a pre insert generator we can't be sure that having an id
  1640.                 // really means that the entity exists. We have to verify this through
  1641.                 // the last resort: a db lookup
  1643.                 // Last try before db lookup: check the identity map.
  1644.                 if ($this->tryGetById($id, $class->rootEntityName)) {
  1645.                     return self::STATE_DETACHED;
  1646.                 }
  1648.                 // db lookup
  1649.                 if ($this->getEntityPersister($class->name)->exists($entity)) {
  1650.                     return self::STATE_DETACHED;
  1651.                 }
  1653.                 return self::STATE_NEW;
  1655.             default:
  1656.                 return self::STATE_DETACHED;
  1657.         }
  1658.     }
  1660.     /**
  1661.      * INTERNAL:
  1662.      * Removes an entity from the identity map. This effectively detaches the
  1663.      * entity from the persistence management of Doctrine.
  1664.      *
  1665.      * @param object $entity
  1666.      *
  1667.      * @return bool
  1668.      *
  1669.      * @throws ORMInvalidArgumentException
  1670.      *
  1671.      * @ignore
  1672.      */
  1673.     public function removeFromIdentityMap($entity)
  1674.     {
  1675.         $oid           = spl_object_id($entity);
  1676.         $classMetadata = $this->em->getClassMetadata(get_class($entity));
  1677.         $idHash        = implode(' ', $this->entityIdentifiers[$oid]);
  1679.         if ($idHash === '') {
  1680.             throw ORMInvalidArgumentException::entityHasNoIdentity($entity, 'remove from identity map');
  1681.         }
  1683.         $className = $classMetadata->rootEntityName;
  1685.         if (isset($this->identityMap[$className][$idHash])) {
  1686.             unset($this->identityMap[$className][$idHash], $this->readOnlyObjects[$oid]);
  1688.             //$this->entityStates[$oid] = self::STATE_DETACHED;
  1690.             return true;
  1691.         }
  1693.         return false;
  1694.     }
  1696.     /**
  1697.      * INTERNAL:
  1698.      * Gets an entity in the identity map by its identifier hash.
  1699.      *
  1700.      * @param string $idHash
  1701.      * @param string $rootClassName
  1702.      *
  1703.      * @return object
  1704.      *
  1705.      * @ignore
  1706.      */
  1707.     public function getByIdHash($idHash, $rootClassName)
  1708.     {
  1709.         return $this->identityMap[$rootClassName][$idHash];
  1710.     }
  1712.     /**
  1713.      * INTERNAL:
  1714.      * Tries to get an entity by its identifier hash. If no entity is found for
  1715.      * the given hash, FALSE is returned.
  1716.      *
  1717.      * @param mixed  $idHash        (must be possible to cast it to string)
  1718.      * @param string $rootClassName
  1719.      *
  1720.      * @return false|object The found entity or FALSE.
  1721.      *
  1722.      * @ignore
  1723.      */
  1724.     public function tryGetByIdHash($idHash, $rootClassName)
  1725.     {
  1726.         $stringIdHash = (string) $idHash;
  1728.         return $this->identityMap[$rootClassName][$stringIdHash] ?? false;
  1729.     }
  1731.     /**
  1732.      * Checks whether an entity is registered in the identity map of this UnitOfWork.
  1733.      *
  1734.      * @param object $entity
  1735.      *
  1736.      * @return bool
  1737.      */
  1738.     public function isInIdentityMap($entity)
  1739.     {
  1740.         $oid = spl_object_id($entity);
  1742.         if (empty($this->entityIdentifiers[$oid])) {
  1743.             return false;
  1744.         }
  1746.         $classMetadata = $this->em->getClassMetadata(get_class($entity));
  1747.         $idHash        = implode(' ', $this->entityIdentifiers[$oid]);
  1749.         return isset($this->identityMap[$classMetadata->rootEntityName][$idHash]);
  1750.     }
  1752.     /**
  1753.      * INTERNAL:
  1754.      * Checks whether an identifier hash exists in the identity map.
  1755.      *
  1756.      * @param string $idHash
  1757.      * @param string $rootClassName
  1758.      *
  1759.      * @return bool
  1760.      *
  1761.      * @ignore
  1762.      */
  1763.     public function containsIdHash($idHash, $rootClassName)
  1764.     {
  1765.         return isset($this->identityMap[$rootClassName][$idHash]);
  1766.     }
  1768.     /**
  1769.      * Persists an entity as part of the current unit of work.
  1770.      *
  1771.      * @param object $entity The entity to persist.
  1772.      *
  1773.      * @return void
  1774.      */
  1775.     public function persist($entity)
  1776.     {
  1777.         $visited = [];
  1779.         $this->doPersist($entity, $visited);
  1780.     }
  1782.     /**
  1783.      * Persists an entity as part of the current unit of work.
  1784.      *
  1785.      * This method is internally called during persist() cascades as it tracks
  1786.      * the already visited entities to prevent infinite recursions.
  1787.      *
  1788.      * @param object $entity The entity to persist.
  1789.      * @psalm-param array<int, object> $visited The already visited entities.
  1790.      *
  1791.      * @throws ORMInvalidArgumentException
  1792.      * @throws UnexpectedValueException
  1793.      */
  1794.     private function doPersist($entity, array &$visited): void
  1795.     {
  1796.         $oid = spl_object_id($entity);
  1798.         if (isset($visited[$oid])) {
  1799.             return; // Prevent infinite recursion
  1800.         }
  1802.         $visited[$oid] = $entity; // Mark visited
  1804.         $class = $this->em->getClassMetadata(get_class($entity));
  1806.         // We assume NEW, so DETACHED entities result in an exception on flush (constraint violation).
  1807.         // If we would detect DETACHED here we would throw an exception anyway with the same
  1808.         // consequences (not recoverable/programming error), so just assuming NEW here
  1809.         // lets us avoid some database lookups for entities with natural identifiers.
  1810.         $entityState = $this->getEntityState($entity, self::STATE_NEW);
  1812.         switch ($entityState) {
  1813.             case self::STATE_MANAGED:
  1814.                 // Nothing to do, except if policy is "deferred explicit"
  1815.                 if ($class->isChangeTrackingDeferredExplicit()) {
  1816.                     $this->scheduleForDirtyCheck($entity);
  1817.                 }
  1819.                 break;
  1821.             case self::STATE_NEW:
  1822.                 $this->persistNew($class, $entity);
  1823.                 break;
  1825.             case self::STATE_REMOVED:
  1826.                 // Entity becomes managed again
  1827.                 unset($this->entityDeletions[$oid]);
  1828.                 $this->addToIdentityMap($entity);
  1830.                 $this->entityStates[$oid] = self::STATE_MANAGED;
  1832.                 if ($class->isChangeTrackingDeferredExplicit()) {
  1833.                     $this->scheduleForDirtyCheck($entity);
  1834.                 }
  1836.                 break;
  1838.             case self::STATE_DETACHED:
  1839.                 // Can actually not happen right now since we assume STATE_NEW.
  1840.                 throw ORMInvalidArgumentException::detachedEntityCannot($entity, 'persisted');
  1842.             default:
  1843.                 throw new UnexpectedValueException(sprintf(
  1844.                     'Unexpected entity state: %s. %s',
  1845.                     $entityState,
  1846.                     self::objToStr($entity)
  1847.                 ));
  1848.         }
  1850.         $this->cascadePersist($entity, $visited);
  1851.     }
  1853.     /**
  1854.      * Deletes an entity as part of the current unit of work.
  1855.      *
  1856.      * @param object $entity The entity to remove.
  1857.      *
  1858.      * @return void
  1859.      */
  1860.     public function remove($entity)
  1861.     {
  1862.         $visited = [];
  1864.         $this->doRemove($entity, $visited);
  1865.     }
  1867.     /**
  1868.      * Deletes an entity as part of the current unit of work.
  1869.      *
  1870.      * This method is internally called during delete() cascades as it tracks
  1871.      * the already visited entities to prevent infinite recursions.
  1872.      *
  1873.      * @param object $entity The entity to delete.
  1874.      * @psalm-param array<int, object> $visited The map of the already visited entities.
  1875.      *
  1876.      * @throws ORMInvalidArgumentException If the instance is a detached entity.
  1877.      * @throws UnexpectedValueException
  1878.      */
  1879.     private function doRemove($entity, array &$visited): void
  1880.     {
  1881.         $oid = spl_object_id($entity);
  1883.         if (isset($visited[$oid])) {
  1884.             return; // Prevent infinite recursion
  1885.         }
  1887.         $visited[$oid] = $entity; // mark visited
  1889.         // Cascade first, because scheduleForDelete() removes the entity from the identity map, which
  1890.         // can cause problems when a lazy proxy has to be initialized for the cascade operation.
  1891.         $this->cascadeRemove($entity, $visited);
  1893.         $class       = $this->em->getClassMetadata(get_class($entity));
  1894.         $entityState = $this->getEntityState($entity);
  1896.         switch ($entityState) {
  1897.             case self::STATE_NEW:
  1898.             case self::STATE_REMOVED:
  1899.                 // nothing to do
  1900.                 break;
  1902.             case self::STATE_MANAGED:
  1903.                 $invoke = $this->listenersInvoker->getSubscribedSystems($class, Events::preRemove);
  1905.                 if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1906.                     $this->listenersInvoker->invoke($class, Events::preRemove, $entity, new LifecycleEventArgs($entity, $this->em), $invoke);
  1907.                 }
  1909.                 $this->scheduleForDelete($entity);
  1910.                 break;
  1912.             case self::STATE_DETACHED:
  1913.                 throw ORMInvalidArgumentException::detachedEntityCannot($entity, 'removed');
  1915.             default:
  1916.                 throw new UnexpectedValueException(sprintf(
  1917.                     'Unexpected entity state: %s. %s',
  1918.                     $entityState,
  1919.                     self::objToStr($entity)
  1920.                 ));
  1921.         }
  1922.     }
  1924.     /**
  1925.      * Merges the state of the given detached entity into this UnitOfWork.
  1926.      *
  1927.      * @deprecated 2.7 This method is being removed from the ORM and won't have any replacement
  1928.      *
  1929.      * @param object $entity
  1930.      *
  1931.      * @return object The managed copy of the entity.
  1932.      *
  1933.      * @throws OptimisticLockException If the entity uses optimistic locking through a version
  1934.      *         attribute and the version check against the managed copy fails.
  1935.      */
  1936.     public function merge($entity)
  1937.     {
  1938.         $visited = [];
  1940.         return $this->doMerge($entity, $visited);
  1941.     }
  1943.     /**
  1944.      * Executes a merge operation on an entity.
  1945.      *
  1946.      * @param object $entity
  1947.      * @psalm-param AssociationMapping|null $assoc
  1948.      * @psalm-param array<int, object> $visited
  1949.      *
  1950.      * @return object The managed copy of the entity.
  1951.      *
  1952.      * @throws OptimisticLockException If the entity uses optimistic locking through a version
  1953.      *         attribute and the version check against the managed copy fails.
  1954.      * @throws ORMInvalidArgumentException If the entity instance is NEW.
  1955.      * @throws EntityNotFoundException if an assigned identifier is used in the entity, but none is provided.
  1956.      */
  1957.     private function doMerge(
  1958.         $entity,
  1959.         array &$visited,
  1960.         $prevManagedCopy = null,
  1961.         ?array $assoc = null
  1962.     ) {
  1963.         $oid = spl_object_id($entity);
  1965.         if (isset($visited[$oid])) {
  1966.             $managedCopy = $visited[$oid];
  1968.             if ($prevManagedCopy !== null) {
  1969.                 $this->updateAssociationWithMergedEntity($entity, $assoc, $prevManagedCopy, $managedCopy);
  1970.             }
  1972.             return $managedCopy;
  1973.         }
  1975.         $class = $this->em->getClassMetadata(get_class($entity));
  1977.         // First we assume DETACHED, although it can still be NEW but we can avoid
  1978.         // an extra db-roundtrip this way. If it is not MANAGED but has an identity,
  1979.         // we need to fetch it from the db anyway in order to merge.
  1980.         // MANAGED entities are ignored by the merge operation.
  1981.         $managedCopy = $entity;
  1983.         if ($this->getEntityState($entity, self::STATE_DETACHED) !== self::STATE_MANAGED) {
  1984.             // Try to look the entity up in the identity map.
  1985.             $id = $class->getIdentifierValues($entity);
  1987.             // If there is no ID, it is actually NEW.
  1988.             if (! $id) {
  1989.                 $managedCopy = $this->newInstance($class);
  1991.                 $this->mergeEntityStateIntoManagedCopy($entity, $managedCopy);
  1992.                 $this->persistNew($class, $managedCopy);
  1993.             } else {
  1994.                 $flatId = $class->containsForeignIdentifier || $class->containsEnumIdentifier
  1995.                     ? $this->identifierFlattener->flattenIdentifier($class, $id)
  1996.                     : $id;
  1998.                 $managedCopy = $this->tryGetById($flatId, $class->rootEntityName);
  2000.                 if ($managedCopy) {
  2001.                     // We have the entity in-memory already, just make sure its not removed.
  2002.                     if ($this->getEntityState($managedCopy) === self::STATE_REMOVED) {
  2003.                         throw ORMInvalidArgumentException::entityIsRemoved($managedCopy, 'merge');
  2004.                     }
  2005.                 } else {
  2006.                     // We need to fetch the managed copy in order to merge.
  2007.                     $managedCopy = $this->em->find($class->name, $flatId);
  2008.                 }
  2010.                 if ($managedCopy === null) {
  2011.                     // If the identifier is ASSIGNED, it is NEW, otherwise an error
  2012.                     // since the managed entity was not found.
  2013.                     if (! $class->isIdentifierNatural()) {
  2014.                         throw EntityNotFoundException::fromClassNameAndIdentifier(
  2015.                             $class->getName(),
  2016.                             $this->identifierFlattener->flattenIdentifier($class, $id)
  2017.                         );
  2018.                     }
  2020.                     $managedCopy = $this->newInstance($class);
  2021.                     $class->setIdentifierValues($managedCopy, $id);
  2023.                     $this->mergeEntityStateIntoManagedCopy($entity, $managedCopy);
  2024.                     $this->persistNew($class, $managedCopy);
  2025.                 } else {
  2026.                     $this->ensureVersionMatch($class, $entity, $managedCopy);
  2027.                     $this->mergeEntityStateIntoManagedCopy($entity, $managedCopy);
  2028.                 }
  2029.             }
  2031.             $visited[$oid] = $managedCopy; // mark visited
  2033.             if ($class->isChangeTrackingDeferredExplicit()) {
  2034.                 $this->scheduleForDirtyCheck($entity);
  2035.             }
  2036.         }
  2038.         if ($prevManagedCopy !== null) {
  2039.             $this->updateAssociationWithMergedEntity($entity, $assoc, $prevManagedCopy, $managedCopy);
  2040.         }
  2042.         // Mark the managed copy visited as well
  2043.         $visited[spl_object_id($managedCopy)] = $managedCopy;
  2045.         $this->cascadeMerge($entity, $managedCopy, $visited);
  2047.         return $managedCopy;
  2048.     }
  2050.     /**
  2051.      * @param object $entity
  2052.      * @param object $managedCopy
  2053.      * @psalm-param ClassMetadata<T> $class
  2054.      * @psalm-param T $entity
  2055.      * @psalm-param T $managedCopy
  2056.      *
  2057.      * @throws OptimisticLockException
  2058.      *
  2059.      * @template T of object
  2060.      */
  2061.     private function ensureVersionMatch(
  2062.         ClassMetadata $class,
  2063.         $entity,
  2064.         $managedCopy
  2065.     ): void {
  2066.         if (! ($class->isVersioned && $this->isLoaded($managedCopy) && $this->isLoaded($entity))) {
  2067.             return;
  2068.         }
  2070.         assert($class->versionField !== null);
  2071.         $reflField          = $class->reflFields[$class->versionField];
  2072.         $managedCopyVersion = $reflField->getValue($managedCopy);
  2073.         $entityVersion      = $reflField->getValue($entity);
  2075.         // Throw exception if versions don't match.
  2076.         // phpcs:ignore SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedEqualOperator
  2077.         if ($managedCopyVersion == $entityVersion) {
  2078.             return;
  2079.         }
  2081.         throw OptimisticLockException::lockFailedVersionMismatch($entity, $entityVersion, $managedCopyVersion);
  2082.     }
  2084.     /**
  2085.      * Tests if an entity is loaded - must either be a loaded proxy or not a proxy
  2086.      *
  2087.      * @param object $entity
  2088.      */
  2089.     private function isLoaded($entity): bool
  2090.     {
  2091.         return ! ($entity instanceof Proxy) || $entity->__isInitialized();
  2092.     }
  2094.     /**
  2095.      * Sets/adds associated managed copies into the previous entity's association field
  2096.      *
  2097.      * @param object $entity
  2098.      * @psalm-param AssociationMapping $association
  2099.      */
  2100.     private function updateAssociationWithMergedEntity(
  2101.         $entity,
  2102.         array $association,
  2103.         $previousManagedCopy,
  2104.         $managedCopy
  2105.     ): void {
  2106.         $assocField = $association['fieldName'];
  2107.         $prevClass  = $this->em->getClassMetadata(get_class($previousManagedCopy));
  2109.         if ($association['type'] & ClassMetadata::TO_ONE) {
  2110.             $prevClass->reflFields[$assocField]->setValue($previousManagedCopy, $managedCopy);
  2112.             return;
  2113.         }
  2115.         $value   = $prevClass->reflFields[$assocField]->getValue($previousManagedCopy);
  2116.         $value[] = $managedCopy;
  2118.         if ($association['type'] === ClassMetadata::ONE_TO_MANY) {
  2119.             $class = $this->em->getClassMetadata(get_class($entity));
  2121.             $class->reflFields[$association['mappedBy']]->setValue($managedCopy, $previousManagedCopy);
  2122.         }
  2123.     }
  2125.     /**
  2126.      * Detaches an entity from the persistence management. It's persistence will
  2127.      * no longer be managed by Doctrine.
  2128.      *
  2129.      * @param object $entity The entity to detach.
  2130.      *
  2131.      * @return void
  2132.      */
  2133.     public function detach($entity)
  2134.     {
  2135.         $visited = [];
  2137.         $this->doDetach($entity, $visited);
  2138.     }
  2140.     /**
  2141.      * Executes a detach operation on the given entity.
  2142.      *
  2143.      * @param object  $entity
  2144.      * @param mixed[] $visited
  2145.      * @param bool    $noCascade if true, don't cascade detach operation.
  2146.      */
  2147.     private function doDetach(
  2148.         $entity,
  2149.         array &$visited,
  2150.         bool $noCascade = false
  2151.     ): void {
  2152.         $oid = spl_object_id($entity);
  2154.         if (isset($visited[$oid])) {
  2155.             return; // Prevent infinite recursion
  2156.         }
  2158.         $visited[$oid] = $entity; // mark visited
  2160.         switch ($this->getEntityState($entity, self::STATE_DETACHED)) {
  2161.             case self::STATE_MANAGED:
  2162.                 if ($this->isInIdentityMap($entity)) {
  2163.                     $this->removeFromIdentityMap($entity);
  2164.                 }
  2166.                 unset(
  2167.                     $this->entityInsertions[$oid],
  2168.                     $this->entityUpdates[$oid],
  2169.                     $this->entityDeletions[$oid],
  2170.                     $this->entityIdentifiers[$oid],
  2171.                     $this->entityStates[$oid],
  2172.                     $this->originalEntityData[$oid]
  2173.                 );
  2174.                 break;
  2175.             case self::STATE_NEW:
  2176.             case self::STATE_DETACHED:
  2177.                 return;
  2178.         }
  2180.         if (! $noCascade) {
  2181.             $this->cascadeDetach($entity, $visited);
  2182.         }
  2183.     }
  2185.     /**
  2186.      * Refreshes the state of the given entity from the database, overwriting
  2187.      * any local, unpersisted changes.
  2188.      *
  2189.      * @param object $entity The entity to refresh.
  2190.      *
  2191.      * @return void
  2192.      *
  2193.      * @throws InvalidArgumentException If the entity is not MANAGED.
  2194.      */
  2195.     public function refresh($entity)
  2196.     {
  2197.         $visited = [];
  2199.         $this->doRefresh($entity, $visited);
  2200.     }
  2202.     /**
  2203.      * Executes a refresh operation on an entity.
  2204.      *
  2205.      * @param object $entity The entity to refresh.
  2206.      * @psalm-param array<int, object>  $visited The already visited entities during cascades.
  2207.      *
  2208.      * @throws ORMInvalidArgumentException If the entity is not MANAGED.
  2209.      */
  2210.     private function doRefresh($entity, array &$visited): void
  2211.     {
  2212.         $oid = spl_object_id($entity);
  2214.         if (isset($visited[$oid])) {
  2215.             return; // Prevent infinite recursion
  2216.         }
  2218.         $visited[$oid] = $entity; // mark visited
  2220.         $class = $this->em->getClassMetadata(get_class($entity));
  2222.         if ($this->getEntityState($entity) !== self::STATE_MANAGED) {
  2223.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  2224.         }
  2226.         $this->getEntityPersister($class->name)->refresh(
  2227.             array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
  2228.             $entity
  2229.         );
  2231.         $this->cascadeRefresh($entity, $visited);
  2232.     }
  2234.     /**
  2235.      * Cascades a refresh operation to associated entities.
  2236.      *
  2237.      * @param object $entity
  2238.      * @psalm-param array<int, object> $visited
  2239.      */
  2240.     private function cascadeRefresh($entity, array &$visited): void
  2241.     {
  2242.         $class = $this->em->getClassMetadata(get_class($entity));
  2244.         $associationMappings = array_filter(
  2245.             $class->associationMappings,
  2246.             static function ($assoc) {
  2247.                 return $assoc['isCascadeRefresh'];
  2248.             }
  2249.         );
  2251.         foreach ($associationMappings as $assoc) {
  2252.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2254.             switch (true) {
  2255.                 case $relatedEntities instanceof PersistentCollection:
  2256.                     // Unwrap so that foreach() does not initialize
  2257.                     $relatedEntities = $relatedEntities->unwrap();
  2258.                     // break; is commented intentionally!
  2260.                 case $relatedEntities instanceof Collection:
  2261.                 case is_array($relatedEntities):
  2262.                     foreach ($relatedEntities as $relatedEntity) {
  2263.                         $this->doRefresh($relatedEntity, $visited);
  2264.                     }
  2266.                     break;
  2268.                 case $relatedEntities !== null:
  2269.                     $this->doRefresh($relatedEntities, $visited);
  2270.                     break;
  2272.                 default:
  2273.                     // Do nothing
  2274.             }
  2275.         }
  2276.     }
  2278.     /**
  2279.      * Cascades a detach operation to associated entities.
  2280.      *
  2281.      * @param object             $entity
  2282.      * @param array<int, object> $visited
  2283.      */
  2284.     private function cascadeDetach($entity, array &$visited): void
  2285.     {
  2286.         $class = $this->em->getClassMetadata(get_class($entity));
  2288.         $associationMappings = array_filter(
  2289.             $class->associationMappings,
  2290.             static function ($assoc) {
  2291.                 return $assoc['isCascadeDetach'];
  2292.             }
  2293.         );
  2295.         foreach ($associationMappings as $assoc) {
  2296.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2298.             switch (true) {
  2299.                 case $relatedEntities instanceof PersistentCollection:
  2300.                     // Unwrap so that foreach() does not initialize
  2301.                     $relatedEntities = $relatedEntities->unwrap();
  2302.                     // break; is commented intentionally!
  2304.                 case $relatedEntities instanceof Collection:
  2305.                 case is_array($relatedEntities):
  2306.                     foreach ($relatedEntities as $relatedEntity) {
  2307.                         $this->doDetach($relatedEntity, $visited);
  2308.                     }
  2310.                     break;
  2312.                 case $relatedEntities !== null:
  2313.                     $this->doDetach($relatedEntities, $visited);
  2314.                     break;
  2316.                 default:
  2317.                     // Do nothing
  2318.             }
  2319.         }
  2320.     }
  2322.     /**
  2323.      * Cascades a merge operation to associated entities.
  2324.      *
  2325.      * @param object $entity
  2326.      * @param object $managedCopy
  2327.      * @psalm-param array<int, object> $visited
  2328.      */
  2329.     private function cascadeMerge($entity, $managedCopy, array &$visited): void
  2330.     {
  2331.         $class = $this->em->getClassMetadata(get_class($entity));
  2333.         $associationMappings = array_filter(
  2334.             $class->associationMappings,
  2335.             static function ($assoc) {
  2336.                 return $assoc['isCascadeMerge'];
  2337.             }
  2338.         );
  2340.         foreach ($associationMappings as $assoc) {
  2341.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2343.             if ($relatedEntities instanceof Collection) {
  2344.                 if ($relatedEntities === $class->reflFields[$assoc['fieldName']]->getValue($managedCopy)) {
  2345.                     continue;
  2346.                 }
  2348.                 if ($relatedEntities instanceof PersistentCollection) {
  2349.                     // Unwrap so that foreach() does not initialize
  2350.                     $relatedEntities = $relatedEntities->unwrap();
  2351.                 }
  2353.                 foreach ($relatedEntities as $relatedEntity) {
  2354.                     $this->doMerge($relatedEntity, $visited, $managedCopy, $assoc);
  2355.                 }
  2356.             } elseif ($relatedEntities !== null) {
  2357.                 $this->doMerge($relatedEntities, $visited, $managedCopy, $assoc);
  2358.             }
  2359.         }
  2360.     }
  2362.     /**
  2363.      * Cascades the save operation to associated entities.
  2364.      *
  2365.      * @param object $entity
  2366.      * @psalm-param array<int, object> $visited
  2367.      */
  2368.     private function cascadePersist($entity, array &$visited): void
  2369.     {
  2370.         $class = $this->em->getClassMetadata(get_class($entity));
  2372.         $associationMappings = array_filter(
  2373.             $class->associationMappings,
  2374.             static function ($assoc) {
  2375.                 return $assoc['isCascadePersist'];
  2376.             }
  2377.         );
  2379.         foreach ($associationMappings as $assoc) {
  2380.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2382.             switch (true) {
  2383.                 case $relatedEntities instanceof PersistentCollection:
  2384.                     // Unwrap so that foreach() does not initialize
  2385.                     $relatedEntities = $relatedEntities->unwrap();
  2386.                     // break; is commented intentionally!
  2388.                 case $relatedEntities instanceof Collection:
  2389.                 case is_array($relatedEntities):
  2390.                     if (($assoc['type'] & ClassMetadata::TO_MANY) <= 0) {
  2391.                         throw ORMInvalidArgumentException::invalidAssociation(
  2392.                             $this->em->getClassMetadata($assoc['targetEntity']),
  2393.                             $assoc,
  2394.                             $relatedEntities
  2395.                         );
  2396.                     }
  2398.                     foreach ($relatedEntities as $relatedEntity) {
  2399.                         $this->doPersist($relatedEntity, $visited);
  2400.                     }
  2402.                     break;
  2404.                 case $relatedEntities !== null:
  2405.                     if (! $relatedEntities instanceof $assoc['targetEntity']) {
  2406.                         throw ORMInvalidArgumentException::invalidAssociation(
  2407.                             $this->em->getClassMetadata($assoc['targetEntity']),
  2408.                             $assoc,
  2409.                             $relatedEntities
  2410.                         );
  2411.                     }
  2413.                     $this->doPersist($relatedEntities, $visited);
  2414.                     break;
  2416.                 default:
  2417.                     // Do nothing
  2418.             }
  2419.         }
  2420.     }
  2422.     /**
  2423.      * Cascades the delete operation to associated entities.
  2424.      *
  2425.      * @param object $entity
  2426.      * @psalm-param array<int, object> $visited
  2427.      */
  2428.     private function cascadeRemove($entity, array &$visited): void
  2429.     {
  2430.         $class = $this->em->getClassMetadata(get_class($entity));
  2432.         $associationMappings = array_filter(
  2433.             $class->associationMappings,
  2434.             static function ($assoc) {
  2435.                 return $assoc['isCascadeRemove'];
  2436.             }
  2437.         );
  2439.         $entitiesToCascade = [];
  2441.         foreach ($associationMappings as $assoc) {
  2442.             if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  2443.                 $entity->__load();
  2444.             }
  2446.             $relatedEntities = $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2448.             switch (true) {
  2449.                 case $relatedEntities instanceof Collection:
  2450.                 case is_array($relatedEntities):
  2451.                     // If its a PersistentCollection initialization is intended! No unwrap!
  2452.                     foreach ($relatedEntities as $relatedEntity) {
  2453.                         $entitiesToCascade[] = $relatedEntity;
  2454.                     }
  2456.                     break;
  2458.                 case $relatedEntities !== null:
  2459.                     $entitiesToCascade[] = $relatedEntities;
  2460.                     break;
  2462.                 default:
  2463.                     // Do nothing
  2464.             }
  2465.         }
  2467.         foreach ($entitiesToCascade as $relatedEntity) {
  2468.             $this->doRemove($relatedEntity, $visited);
  2469.         }
  2470.     }
  2472.     /**
  2473.      * Acquire a lock on the given entity.
  2474.      *
  2475.      * @param object                     $entity
  2476.      * @param int|DateTimeInterface|null $lockVersion
  2477.      * @psalm-param LockMode::* $lockMode
  2478.      *
  2479.      * @throws ORMInvalidArgumentException
  2480.      * @throws TransactionRequiredException
  2481.      * @throws OptimisticLockException
  2482.      */
  2483.     public function lock($entity, int $lockMode, $lockVersion = null): void
  2484.     {
  2485.         if ($this->getEntityState($entity, self::STATE_DETACHED) !== self::STATE_MANAGED) {
  2486.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  2487.         }
  2489.         $class = $this->em->getClassMetadata(get_class($entity));
  2491.         switch (true) {
  2492.             case $lockMode === LockMode::OPTIMISTIC:
  2493.                 if (! $class->isVersioned) {
  2494.                     throw OptimisticLockException::notVersioned($class->name);
  2495.                 }
  2497.                 if ($lockVersion === null) {
  2498.                     return;
  2499.                 }
  2501.                 if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  2502.                     $entity->__load();
  2503.                 }
  2505.                 assert($class->versionField !== null);
  2506.                 $entityVersion = $class->reflFields[$class->versionField]->getValue($entity);
  2508.                 // phpcs:ignore SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedNotEqualOperator
  2509.                 if ($entityVersion != $lockVersion) {
  2510.                     throw OptimisticLockException::lockFailedVersionMismatch($entity, $lockVersion, $entityVersion);
  2511.                 }
  2513.                 break;
  2515.             case $lockMode === LockMode::NONE:
  2516.             case $lockMode === LockMode::PESSIMISTIC_READ:
  2517.             case $lockMode === LockMode::PESSIMISTIC_WRITE:
  2518.                 if (! $this->em->getConnection()->isTransactionActive()) {
  2519.                     throw TransactionRequiredException::transactionRequired();
  2520.                 }
  2522.                 $oid = spl_object_id($entity);
  2524.                 $this->getEntityPersister($class->name)->lock(
  2525.                     array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
  2526.                     $lockMode
  2527.                 );
  2528.                 break;
  2530.             default:
  2531.                 // Do nothing
  2532.         }
  2533.     }
  2535.     /**
  2536.      * Gets the CommitOrderCalculator used by the UnitOfWork to order commits.
  2537.      *
  2538.      * @return CommitOrderCalculator
  2539.      */
  2540.     public function getCommitOrderCalculator()
  2541.     {
  2542.         return new Internal\CommitOrderCalculator();
  2543.     }
  2545.     /**
  2546.      * Clears the UnitOfWork.
  2547.      *
  2548.      * @param string|null $entityName if given, only entities of this type will get detached.
  2549.      *
  2550.      * @return void
  2551.      *
  2552.      * @throws ORMInvalidArgumentException if an invalid entity name is given.
  2553.      */
  2554.     public function clear($entityName = null)
  2555.     {
  2556.         if ($entityName === null) {
  2557.             $this->identityMap                    =
  2558.             $this->entityIdentifiers              =
  2559.             $this->originalEntityData             =
  2560.             $this->entityChangeSets               =
  2561.             $this->entityStates                   =
  2562.             $this->scheduledForSynchronization    =
  2563.             $this->entityInsertions               =
  2564.             $this->entityUpdates                  =
  2565.             $this->entityDeletions                =
  2566.             $this->nonCascadedNewDetectedEntities =
  2567.             $this->collectionDeletions            =
  2568.             $this->collectionUpdates              =
  2569.             $this->extraUpdates                   =
  2570.             $this->readOnlyObjects                =
  2571.             $this->visitedCollections             =
  2572.             $this->eagerLoadingEntities           =
  2573.             $this->orphanRemovals                 = [];
  2574.         } else {
  2575.             Deprecation::triggerIfCalledFromOutside(
  2576.                 'doctrine/orm',
  2577.                 'https://github.com/doctrine/orm/issues/8460',
  2578.                 'Calling %s() with any arguments to clear specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
  2579.                 __METHOD__
  2580.             );
  2582.             $this->clearIdentityMapForEntityName($entityName);
  2583.             $this->clearEntityInsertionsForEntityName($entityName);
  2584.         }
  2586.         if ($this->evm->hasListeners(Events::onClear)) {
  2587.             $this->evm->dispatchEvent(Events::onClear, new Event\OnClearEventArgs($this->em, $entityName));
  2588.         }
  2589.     }
  2591.     /**
  2592.      * INTERNAL:
  2593.      * Schedules an orphaned entity for removal. The remove() operation will be
  2594.      * invoked on that entity at the beginning of the next commit of this
  2595.      * UnitOfWork.
  2596.      *
  2597.      * @param object $entity
  2598.      *
  2599.      * @return void
  2600.      *
  2601.      * @ignore
  2602.      */
  2603.     public function scheduleOrphanRemoval($entity)
  2604.     {
  2605.         $this->orphanRemovals[spl_object_id($entity)] = $entity;
  2606.     }
  2608.     /**
  2609.      * INTERNAL:
  2610.      * Cancels a previously scheduled orphan removal.
  2611.      *
  2612.      * @param object $entity
  2613.      *
  2614.      * @return void
  2615.      *
  2616.      * @ignore
  2617.      */
  2618.     public function cancelOrphanRemoval($entity)
  2619.     {
  2620.         unset($this->orphanRemovals[spl_object_id($entity)]);
  2621.     }
  2623.     /**
  2624.      * INTERNAL:
  2625.      * Schedules a complete collection for removal when this UnitOfWork commits.
  2626.      *
  2627.      * @return void
  2628.      */
  2629.     public function scheduleCollectionDeletion(PersistentCollection $coll)
  2630.     {
  2631.         $coid = spl_object_id($coll);
  2633.         // TODO: if $coll is already scheduled for recreation ... what to do?
  2634.         // Just remove $coll from the scheduled recreations?
  2635.         unset($this->collectionUpdates[$coid]);
  2637.         $this->collectionDeletions[$coid] = $coll;
  2638.     }
  2640.     /**
  2641.      * @return bool
  2642.      */
  2643.     public function isCollectionScheduledForDeletion(PersistentCollection $coll)
  2644.     {
  2645.         return isset($this->collectionDeletions[spl_object_id($coll)]);
  2646.     }
  2648.     /**
  2649.      * @return object
  2650.      */
  2651.     private function newInstance(ClassMetadata $class)
  2652.     {
  2653.         $entity = $class->newInstance();
  2655.         if ($entity instanceof ObjectManagerAware) {
  2656.             $entity->injectObjectManager($this->em, $class);
  2657.         }
  2659.         return $entity;
  2660.     }
  2662.     /**
  2663.      * INTERNAL:
  2664.      * Creates an entity. Used for reconstitution of persistent entities.
  2665.      *
  2666.      * Internal note: Highly performance-sensitive method.
  2667.      *
  2668.      * @param string  $className The name of the entity class.
  2669.      * @param mixed[] $data      The data for the entity.
  2670.      * @param mixed[] $hints     Any hints to account for during reconstitution/lookup of the entity.
  2671.      * @psalm-param class-string $className
  2672.      * @psalm-param array<string, mixed> $hints
  2673.      *
  2674.      * @return object The managed entity instance.
  2675.      *
  2676.      * @ignore
  2677.      * @todo Rename: getOrCreateEntity
  2678.      */
  2679.     public function createEntity($className, array $data, &$hints = [])
  2680.     {
  2681.         $class = $this->em->getClassMetadata($className);
  2683.         $id     = $this->identifierFlattener->flattenIdentifier($class, $data);
  2684.         $idHash = implode(' ', $id);
  2686.         if (isset($this->identityMap[$class->rootEntityName][$idHash])) {
  2687.             $entity = $this->identityMap[$class->rootEntityName][$idHash];
  2688.             $oid    = spl_object_id($entity);
  2690.             if (
  2691.                 isset($hints[Query::HINT_REFRESH], $hints[Query::HINT_REFRESH_ENTITY])
  2692.             ) {
  2693.                 $unmanagedProxy = $hints[Query::HINT_REFRESH_ENTITY];
  2694.                 if (
  2695.                     $unmanagedProxy !== $entity
  2696.                     && $unmanagedProxy instanceof Proxy
  2697.                     && $this->isIdentifierEquals($unmanagedProxy, $entity)
  2698.                 ) {
  2699.                     // DDC-1238 - we have a managed instance, but it isn't the provided one.
  2700.                     // Therefore we clear its identifier. Also, we must re-fetch metadata since the
  2701.                     // refreshed object may be anything
  2703.                     foreach ($class->identifier as $fieldName) {
  2704.                         $class->reflFields[$fieldName]->setValue($unmanagedProxy, null);
  2705.                     }
  2707.                     return $unmanagedProxy;
  2708.                 }
  2709.             }
  2711.             if ($entity instanceof Proxy && ! $entity->__isInitialized()) {
  2712.                 $entity->__setInitialized(true);
  2714.                 if ($entity instanceof NotifyPropertyChanged) {
  2715.                     $entity->addPropertyChangedListener($this);
  2716.                 }
  2717.             } else {
  2718.                 if (
  2719.                     ! isset($hints[Query::HINT_REFRESH])
  2720.                     || (isset($hints[Query::HINT_REFRESH_ENTITY]) && $hints[Query::HINT_REFRESH_ENTITY] !== $entity)
  2721.                 ) {
  2722.                     return $entity;
  2723.                 }
  2724.             }
  2726.             // inject ObjectManager upon refresh.
  2727.             if ($entity instanceof ObjectManagerAware) {
  2728.                 $entity->injectObjectManager($this->em, $class);
  2729.             }
  2731.             $this->originalEntityData[$oid] = $data;
  2732.         } else {
  2733.             $entity = $this->newInstance($class);
  2734.             $oid    = spl_object_id($entity);
  2736.             $this->entityIdentifiers[$oid]  = $id;
  2737.             $this->entityStates[$oid]       = self::STATE_MANAGED;
  2738.             $this->originalEntityData[$oid] = $data;
  2740.             $this->identityMap[$class->rootEntityName][$idHash] = $entity;
  2742.             if ($entity instanceof NotifyPropertyChanged) {
  2743.                 $entity->addPropertyChangedListener($this);
  2744.             }
  2746.             if (isset($hints[Query::HINT_READ_ONLY])) {
  2747.                 $this->readOnlyObjects[$oid] = true;
  2748.             }
  2749.         }
  2751.         foreach ($data as $field => $value) {
  2752.             if (isset($class->fieldMappings[$field])) {
  2753.                 $class->reflFields[$field]->setValue($entity, $value);
  2754.             }
  2755.         }
  2757.         // Loading the entity right here, if its in the eager loading map get rid of it there.
  2758.         unset($this->eagerLoadingEntities[$class->rootEntityName][$idHash]);
  2760.         if (isset($this->eagerLoadingEntities[$class->rootEntityName]) && ! $this->eagerLoadingEntities[$class->rootEntityName]) {
  2761.             unset($this->eagerLoadingEntities[$class->rootEntityName]);
  2762.         }
  2764.         // Properly initialize any unfetched associations, if partial objects are not allowed.
  2765.         if (isset($hints[Query::HINT_FORCE_PARTIAL_LOAD])) {
  2766.             Deprecation::trigger(
  2767.                 'doctrine/orm',
  2768.                 'https://github.com/doctrine/orm/issues/8471',
  2769.                 'Partial Objects are deprecated (here entity %s)',
  2770.                 $className
  2771.             );
  2773.             return $entity;
  2774.         }
  2776.         foreach ($class->associationMappings as $field => $assoc) {
  2777.             // Check if the association is not among the fetch-joined associations already.
  2778.             if (isset($hints['fetchAlias'], $hints['fetched'][$hints['fetchAlias']][$field])) {
  2779.                 continue;
  2780.             }
  2782.             $targetClass = $this->em->getClassMetadata($assoc['targetEntity']);
  2784.             switch (true) {
  2785.                 case $assoc['type'] & ClassMetadata::TO_ONE:
  2786.                     if (! $assoc['isOwningSide']) {
  2787.                         // use the given entity association
  2788.                         if (isset($data[$field]) && is_object($data[$field]) && isset($this->entityStates[spl_object_id($data[$field])])) {
  2789.                             $this->originalEntityData[$oid][$field] = $data[$field];
  2791.                             $class->reflFields[$field]->setValue($entity, $data[$field]);
  2792.                             $targetClass->reflFields[$assoc['mappedBy']]->setValue($data[$field], $entity);
  2794.                             continue 2;
  2795.                         }
  2797.                         // Inverse side of x-to-one can never be lazy
  2798.                         $class->reflFields[$field]->setValue($entity, $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc, $entity));
  2800.                         continue 2;
  2801.                     }
  2803.                     // use the entity association
  2804.                     if (isset($data[$field]) && is_object($data[$field]) && isset($this->entityStates[spl_object_id($data[$field])])) {
  2805.                         $class->reflFields[$field]->setValue($entity, $data[$field]);
  2806.                         $this->originalEntityData[$oid][$field] = $data[$field];
  2808.                         break;
  2809.                     }
  2811.                     $associatedId = [];
  2813.                     // TODO: Is this even computed right in all cases of composite keys?
  2814.                     foreach ($assoc['targetToSourceKeyColumns'] as $targetColumn => $srcColumn) {
  2815.                         $joinColumnValue = $data[$srcColumn] ?? null;
  2817.                         if ($joinColumnValue !== null) {
  2818.                             if ($targetClass->containsForeignIdentifier) {
  2819.                                 $associatedId[$targetClass->getFieldForColumn($targetColumn)] = $joinColumnValue;
  2820.                             } else {
  2821.                                 $associatedId[$targetClass->fieldNames[$targetColumn]] = $joinColumnValue;
  2822.                             }
  2823.                         } elseif (
  2824.                             $targetClass->containsForeignIdentifier
  2825.                             && in_array($targetClass->getFieldForColumn($targetColumn), $targetClass->identifier, true)
  2826.                         ) {
  2827.                             // the missing key is part of target's entity primary key
  2828.                             $associatedId = [];
  2829.                             break;
  2830.                         }
  2831.                     }
  2833.                     if (! $associatedId) {
  2834.                         // Foreign key is NULL
  2835.                         $class->reflFields[$field]->setValue($entity, null);
  2836.                         $this->originalEntityData[$oid][$field] = null;
  2838.                         break;
  2839.                     }
  2841.                     if (! isset($hints['fetchMode'][$class->name][$field])) {
  2842.                         $hints['fetchMode'][$class->name][$field] = $assoc['fetch'];
  2843.                     }
  2845.                     // Foreign key is set
  2846.                     // Check identity map first
  2847.                     // FIXME: Can break easily with composite keys if join column values are in
  2848.                     //        wrong order. The correct order is the one in ClassMetadata#identifier.
  2849.                     $relatedIdHash = implode(' ', $associatedId);
  2851.                     switch (true) {
  2852.                         case isset($this->identityMap[$targetClass->rootEntityName][$relatedIdHash]):
  2853.                             $newValue = $this->identityMap[$targetClass->rootEntityName][$relatedIdHash];
  2855.                             // If this is an uninitialized proxy, we are deferring eager loads,
  2856.                             // this association is marked as eager fetch, and its an uninitialized proxy (wtf!)
  2857.                             // then we can append this entity for eager loading!
  2858.                             if (
  2859.                                 $hints['fetchMode'][$class->name][$field] === ClassMetadata::FETCH_EAGER &&
  2860.                                 isset($hints[self::HINT_DEFEREAGERLOAD]) &&
  2861.                                 ! $targetClass->isIdentifierComposite &&
  2862.                                 $newValue instanceof Proxy &&
  2863.                                 $newValue->__isInitialized() === false
  2864.                             ) {
  2865.                                 $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
  2866.                             }
  2868.                             break;
  2870.                         case $targetClass->subClasses:
  2871.                             // If it might be a subtype, it can not be lazy. There isn't even
  2872.                             // a way to solve this with deferred eager loading, which means putting
  2873.                             // an entity with subclasses at a *-to-one location is really bad! (performance-wise)
  2874.                             $newValue = $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc, $entity, $associatedId);
  2875.                             break;
  2877.                         default:
  2878.                             switch (true) {
  2879.                                 // We are negating the condition here. Other cases will assume it is valid!
  2880.                                 case $hints['fetchMode'][$class->name][$field] !== ClassMetadata::FETCH_EAGER:
  2881.                                     $newValue = $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $associatedId);
  2882.                                     break;
  2884.                                 // Deferred eager load only works for single identifier classes
  2885.                                 case isset($hints[self::HINT_DEFEREAGERLOAD]) && ! $targetClass->isIdentifierComposite:
  2886.                                     // TODO: Is there a faster approach?
  2887.                                     $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
  2889.                                     $newValue = $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $associatedId);
  2890.                                     break;
  2892.                                 default:
  2893.                                     // TODO: This is very imperformant, ignore it?
  2894.                                     $newValue = $this->em->find($assoc['targetEntity'], $associatedId);
  2895.                                     break;
  2896.                             }
  2898.                             if ($newValue === null) {
  2899.                                 break;
  2900.                             }
  2902.                             // PERF: Inlined & optimized code from UnitOfWork#registerManaged()
  2903.                             $newValueOid                                                     = spl_object_id($newValue);
  2904.                             $this->entityIdentifiers[$newValueOid]                           = $associatedId;
  2905.                             $this->identityMap[$targetClass->rootEntityName][$relatedIdHash] = $newValue;
  2907.                             if (
  2908.                                 $newValue instanceof NotifyPropertyChanged &&
  2909.                                 ( ! $newValue instanceof Proxy || $newValue->__isInitialized())
  2910.                             ) {
  2911.                                 $newValue->addPropertyChangedListener($this);
  2912.                             }
  2914.                             $this->entityStates[$newValueOid] = self::STATE_MANAGED;
  2915.                             // make sure that when an proxy is then finally loaded, $this->originalEntityData is set also!
  2916.                             break;
  2917.                     }
  2919.                     $this->originalEntityData[$oid][$field] = $newValue;
  2920.                     $class->reflFields[$field]->setValue($entity, $newValue);
  2922.                     if ($assoc['inversedBy'] && $assoc['type'] & ClassMetadata::ONE_TO_ONE && $newValue !== null) {
  2923.                         $inverseAssoc = $targetClass->associationMappings[$assoc['inversedBy']];
  2924.                         $targetClass->reflFields[$inverseAssoc['fieldName']]->setValue($newValue, $entity);
  2925.                     }
  2927.                     break;
  2929.                 default:
  2930.                     // Ignore if its a cached collection
  2931.                     if (isset($hints[Query::HINT_CACHE_ENABLED]) && $class->getFieldValue($entity, $field) instanceof PersistentCollection) {
  2932.                         break;
  2933.                     }
  2935.                     // use the given collection
  2936.                     if (isset($data[$field]) && $data[$field] instanceof PersistentCollection) {
  2937.                         $data[$field]->setOwner($entity, $assoc);
  2939.                         $class->reflFields[$field]->setValue($entity, $data[$field]);
  2940.                         $this->originalEntityData[$oid][$field] = $data[$field];
  2942.                         break;
  2943.                     }
  2945.                     // Inject collection
  2946.                     $pColl = new PersistentCollection($this->em, $targetClass, new ArrayCollection());
  2947.                     $pColl->setOwner($entity, $assoc);
  2948.                     $pColl->setInitialized(false);
  2950.                     $reflField = $class->reflFields[$field];
  2951.                     $reflField->setValue($entity, $pColl);
  2953.                     if ($assoc['fetch'] === ClassMetadata::FETCH_EAGER) {
  2954.                         $this->loadCollection($pColl);
  2955.                         $pColl->takeSnapshot();
  2956.                     }
  2958.                     $this->originalEntityData[$oid][$field] = $pColl;
  2959.                     break;
  2960.             }
  2961.         }
  2963.         // defer invoking of postLoad event to hydration complete step
  2964.         $this->hydrationCompleteHandler->deferPostLoadInvoking($class, $entity);
  2966.         return $entity;
  2967.     }
  2969.     /**
  2970.      * @return void
  2971.      */
  2972.     public function triggerEagerLoads()
  2973.     {
  2974.         if (! $this->eagerLoadingEntities) {
  2975.             return;
  2976.         }
  2978.         // avoid infinite recursion
  2979.         $eagerLoadingEntities       = $this->eagerLoadingEntities;
  2980.         $this->eagerLoadingEntities = [];
  2982.         foreach ($eagerLoadingEntities as $entityName => $ids) {
  2983.             if (! $ids) {
  2984.                 continue;
  2985.             }
  2987.             $class = $this->em->getClassMetadata($entityName);
  2989.             $this->getEntityPersister($entityName)->loadAll(
  2990.                 array_combine($class->identifier, [array_values($ids)])
  2991.             );
  2992.         }
  2993.     }
  2995.     /**
  2996.      * Initializes (loads) an uninitialized persistent collection of an entity.
  2997.      *
  2998.      * @param PersistentCollection $collection The collection to initialize.
  2999.      *
  3000.      * @return void
  3001.      *
  3002.      * @todo Maybe later move to EntityManager#initialize($proxyOrCollection). See DDC-733.
  3003.      */
  3004.     public function loadCollection(PersistentCollection $collection)
  3005.     {
  3006.         $assoc     = $collection->getMapping();
  3007.         $persister = $this->getEntityPersister($assoc['targetEntity']);
  3009.         switch ($assoc['type']) {
  3010.             case ClassMetadata::ONE_TO_MANY:
  3011.                 $persister->loadOneToManyCollection($assoc, $collection->getOwner(), $collection);
  3012.                 break;
  3014.             case ClassMetadata::MANY_TO_MANY:
  3015.                 $persister->loadManyToManyCollection($assoc, $collection->getOwner(), $collection);
  3016.                 break;
  3017.         }
  3019.         $collection->setInitialized(true);
  3020.     }
  3022.     /**
  3023.      * Gets the identity map of the UnitOfWork.
  3024.      *
  3025.      * @psalm-return array<class-string, array<string, object|null>>
  3026.      */
  3027.     public function getIdentityMap()
  3028.     {
  3029.         return $this->identityMap;
  3030.     }
  3032.     /**
  3033.      * Gets the original data of an entity. The original data is the data that was
  3034.      * present at the time the entity was reconstituted from the database.
  3035.      *
  3036.      * @param object $entity
  3037.      *
  3038.      * @return mixed[]
  3039.      * @psalm-return array<string, mixed>
  3040.      */
  3041.     public function getOriginalEntityData($entity)
  3042.     {
  3043.         $oid = spl_object_id($entity);
  3045.         return $this->originalEntityData[$oid] ?? [];
  3046.     }
  3048.     /**
  3049.      * @param object  $entity
  3050.      * @param mixed[] $data
  3051.      *
  3052.      * @return void
  3053.      *
  3054.      * @ignore
  3055.      */
  3056.     public function setOriginalEntityData($entity, array $data)
  3057.     {
  3058.         $this->originalEntityData[spl_object_id($entity)] = $data;
  3059.     }
  3061.     /**
  3062.      * INTERNAL:
  3063.      * Sets a property value of the original data array of an entity.
  3064.      *
  3065.      * @param int    $oid
  3066.      * @param string $property
  3067.      * @param mixed  $value
  3068.      *
  3069.      * @return void
  3070.      *
  3071.      * @ignore
  3072.      */
  3073.     public function setOriginalEntityProperty($oid, $property, $value)
  3074.     {
  3075.         $this->originalEntityData[$oid][$property] = $value;
  3076.     }
  3078.     /**
  3079.      * Gets the identifier of an entity.
  3080.      * The returned value is always an array of identifier values. If the entity
  3081.      * has a composite identifier then the identifier values are in the same
  3082.      * order as the identifier field names as returned by ClassMetadata#getIdentifierFieldNames().
  3083.      *
  3084.      * @param object $entity
  3085.      *
  3086.      * @return mixed[] The identifier values.
  3087.      */
  3088.     public function getEntityIdentifier($entity)
  3089.     {
  3090.         if (! isset($this->entityIdentifiers[spl_object_id($entity)])) {
  3091.             throw EntityNotFoundException::noIdentifierFound(get_debug_type($entity));
  3092.         }
  3094.         return $this->entityIdentifiers[spl_object_id($entity)];
  3095.     }
  3097.     /**
  3098.      * Processes an entity instance to extract their identifier values.
  3099.      *
  3100.      * @param object $entity The entity instance.
  3101.      *
  3102.      * @return mixed A scalar value.
  3103.      *
  3104.      * @throws ORMInvalidArgumentException
  3105.      */
  3106.     public function getSingleIdentifierValue($entity)
  3107.     {
  3108.         $class = $this->em->getClassMetadata(get_class($entity));
  3110.         if ($class->isIdentifierComposite) {
  3111.             throw ORMInvalidArgumentException::invalidCompositeIdentifier();
  3112.         }
  3114.         $values = $this->isInIdentityMap($entity)
  3115.             ? $this->getEntityIdentifier($entity)
  3116.             : $class->getIdentifierValues($entity);
  3118.         return $values[$class->identifier[0]] ?? null;
  3119.     }
  3121.     /**
  3122.      * Tries to find an entity with the given identifier in the identity map of
  3123.      * this UnitOfWork.
  3124.      *
  3125.      * @param mixed  $id            The entity identifier to look for.
  3126.      * @param string $rootClassName The name of the root class of the mapped entity hierarchy.
  3127.      * @psalm-param class-string $rootClassName
  3128.      *
  3129.      * @return object|false Returns the entity with the specified identifier if it exists in
  3130.      *                      this UnitOfWork, FALSE otherwise.
  3131.      */
  3132.     public function tryGetById($id, $rootClassName)
  3133.     {
  3134.         $idHash = implode(' ', (array) $id);
  3136.         return $this->identityMap[$rootClassName][$idHash] ?? false;
  3137.     }
  3139.     /**
  3140.      * Schedules an entity for dirty-checking at commit-time.
  3141.      *
  3142.      * @param object $entity The entity to schedule for dirty-checking.
  3143.      *
  3144.      * @return void
  3145.      *
  3146.      * @todo Rename: scheduleForSynchronization
  3147.      */
  3148.     public function scheduleForDirtyCheck($entity)
  3149.     {
  3150.         $rootClassName = $this->em->getClassMetadata(get_class($entity))->rootEntityName;
  3152.         $this->scheduledForSynchronization[$rootClassName][spl_object_id($entity)] = $entity;
  3153.     }
  3155.     /**
  3156.      * Checks whether the UnitOfWork has any pending insertions.
  3157.      *
  3158.      * @return bool TRUE if this UnitOfWork has pending insertions, FALSE otherwise.
  3159.      */
  3160.     public function hasPendingInsertions()
  3161.     {
  3162.         return ! empty($this->entityInsertions);
  3163.     }
  3165.     /**
  3166.      * Calculates the size of the UnitOfWork. The size of the UnitOfWork is the
  3167.      * number of entities in the identity map.
  3168.      *
  3169.      * @return int
  3170.      */
  3171.     public function size()
  3172.     {
  3173.         return array_sum(array_map('count', $this->identityMap));
  3174.     }
  3176.     /**
  3177.      * Gets the EntityPersister for an Entity.
  3178.      *
  3179.      * @param string $entityName The name of the Entity.
  3180.      * @psalm-param class-string $entityName
  3181.      *
  3182.      * @return EntityPersister
  3183.      */
  3184.     public function getEntityPersister($entityName)
  3185.     {
  3186.         if (isset($this->persisters[$entityName])) {
  3187.             return $this->persisters[$entityName];
  3188.         }
  3190.         $class = $this->em->getClassMetadata($entityName);
  3192.         switch (true) {
  3193.             case $class->isInheritanceTypeNone():
  3194.                 $persister = new BasicEntityPersister($this->em, $class);
  3195.                 break;
  3197.             case $class->isInheritanceTypeSingleTable():
  3198.                 $persister = new SingleTablePersister($this->em, $class);
  3199.                 break;
  3201.             case $class->isInheritanceTypeJoined():
  3202.                 $persister = new JoinedSubclassPersister($this->em, $class);
  3203.                 break;
  3205.             default:
  3206.                 throw new RuntimeException('No persister found for entity.');
  3207.         }
  3209.         if ($this->hasCache && $class->cache !== null) {
  3210.             $persister = $this->em->getConfiguration()
  3211.                 ->getSecondLevelCacheConfiguration()
  3212.                 ->getCacheFactory()
  3213.                 ->buildCachedEntityPersister($this->em, $persister, $class);
  3214.         }
  3216.         $this->persisters[$entityName] = $persister;
  3218.         return $this->persisters[$entityName];
  3219.     }
  3221.     /**
  3222.      * Gets a collection persister for a collection-valued association.
  3223.      *
  3224.      * @psalm-param array<string, mixed> $association
  3225.      *
  3226.      * @return CollectionPersister
  3227.      */
  3228.     public function getCollectionPersister(array $association)
  3229.     {
  3230.         $role = isset($association['cache'])
  3231.             ? $association['sourceEntity'] . '::' . $association['fieldName']
  3232.             : $association['type'];
  3234.         if (isset($this->collectionPersisters[$role])) {
  3235.             return $this->collectionPersisters[$role];
  3236.         }
  3238.         $persister = $association['type'] === ClassMetadata::ONE_TO_MANY
  3239.             ? new OneToManyPersister($this->em)
  3240.             : new ManyToManyPersister($this->em);
  3242.         if ($this->hasCache && isset($association['cache'])) {
  3243.             $persister = $this->em->getConfiguration()
  3244.                 ->getSecondLevelCacheConfiguration()
  3245.                 ->getCacheFactory()
  3246.                 ->buildCachedCollectionPersister($this->em, $persister, $association);
  3247.         }
  3249.         $this->collectionPersisters[$role] = $persister;
  3251.         return $this->collectionPersisters[$role];
  3252.     }
  3254.     /**
  3255.      * INTERNAL:
  3256.      * Registers an entity as managed.
  3257.      *
  3258.      * @param object  $entity The entity.
  3259.      * @param mixed[] $id     The identifier values.
  3260.      * @param mixed[] $data   The original entity data.
  3261.      *
  3262.      * @return void
  3263.      */
  3264.     public function registerManaged($entity, array $id, array $data)
  3265.     {
  3266.         $oid = spl_object_id($entity);
  3268.         $this->entityIdentifiers[$oid]  = $id;
  3269.         $this->entityStates[$oid]       = self::STATE_MANAGED;
  3270.         $this->originalEntityData[$oid] = $data;
  3272.         $this->addToIdentityMap($entity);
  3274.         if ($entity instanceof NotifyPropertyChanged && ( ! $entity instanceof Proxy || $entity->__isInitialized())) {
  3275.             $entity->addPropertyChangedListener($this);
  3276.         }
  3277.     }
  3279.     /**
  3280.      * INTERNAL:
  3281.      * Clears the property changeset of the entity with the given OID.
  3282.      *
  3283.      * @param int $oid The entity's OID.
  3284.      *
  3285.      * @return void
  3286.      */
  3287.     public function clearEntityChangeSet($oid)
  3288.     {
  3289.         unset($this->entityChangeSets[$oid]);
  3290.     }
  3292.     /* PropertyChangedListener implementation */
  3294.     /**
  3295.      * Notifies this UnitOfWork of a property change in an entity.
  3296.      *
  3297.      * @param object $sender       The entity that owns the property.
  3298.      * @param string $propertyName The name of the property that changed.
  3299.      * @param mixed  $oldValue     The old value of the property.
  3300.      * @param mixed  $newValue     The new value of the property.
  3301.      *
  3302.      * @return void
  3303.      */
  3304.     public function propertyChanged($sender, $propertyName, $oldValue, $newValue)
  3305.     {
  3306.         $oid   = spl_object_id($sender);
  3307.         $class = $this->em->getClassMetadata(get_class($sender));
  3309.         $isAssocField = isset($class->associationMappings[$propertyName]);
  3311.         if (! $isAssocField && ! isset($class->fieldMappings[$propertyName])) {
  3312.             return; // ignore non-persistent fields
  3313.         }
  3315.         // Update changeset and mark entity for synchronization
  3316.         $this->entityChangeSets[$oid][$propertyName] = [$oldValue, $newValue];
  3318.         if (! isset($this->scheduledForSynchronization[$class->rootEntityName][$oid])) {
  3319.             $this->scheduleForDirtyCheck($sender);
  3320.         }
  3321.     }
  3323.     /**
  3324.      * Gets the currently scheduled entity insertions in this UnitOfWork.
  3325.      *
  3326.      * @psalm-return array<int, object>
  3327.      */
  3328.     public function getScheduledEntityInsertions()
  3329.     {
  3330.         return $this->entityInsertions;
  3331.     }
  3333.     /**
  3334.      * Gets the currently scheduled entity updates in this UnitOfWork.
  3335.      *
  3336.      * @psalm-return array<int, object>
  3337.      */
  3338.     public function getScheduledEntityUpdates()
  3339.     {
  3340.         return $this->entityUpdates;
  3341.     }
  3343.     /**
  3344.      * Gets the currently scheduled entity deletions in this UnitOfWork.
  3345.      *
  3346.      * @psalm-return array<int, object>
  3347.      */
  3348.     public function getScheduledEntityDeletions()
  3349.     {
  3350.         return $this->entityDeletions;
  3351.     }
  3353.     /**
  3354.      * Gets the currently scheduled complete collection deletions
  3355.      *
  3356.      * @psalm-return array<int, Collection<array-key, object>>
  3357.      */
  3358.     public function getScheduledCollectionDeletions()
  3359.     {
  3360.         return $this->collectionDeletions;
  3361.     }
  3363.     /**
  3364.      * Gets the currently scheduled collection inserts, updates and deletes.
  3365.      *
  3366.      * @psalm-return array<int, Collection<array-key, object>>
  3367.      */
  3368.     public function getScheduledCollectionUpdates()
  3369.     {
  3370.         return $this->collectionUpdates;
  3371.     }
  3373.     /**
  3374.      * Helper method to initialize a lazy loading proxy or persistent collection.
  3375.      *
  3376.      * @param object $obj
  3377.      *
  3378.      * @return void
  3379.      */
  3380.     public function initializeObject($obj)
  3381.     {
  3382.         if ($obj instanceof Proxy) {
  3383.             $obj->__load();
  3385.             return;
  3386.         }
  3388.         if ($obj instanceof PersistentCollection) {
  3389.             $obj->initialize();
  3390.         }
  3391.     }
  3393.     /**
  3394.      * Helper method to show an object as string.
  3395.      *
  3396.      * @param object $obj
  3397.      */
  3398.     private static function objToStr($obj): string
  3399.     {
  3400.         return method_exists($obj, '__toString') ? (string) $obj : get_debug_type($obj) . '@' . spl_object_id($obj);
  3401.     }
  3403.     /**
  3404.      * Marks an entity as read-only so that it will not be considered for updates during UnitOfWork#commit().
  3405.      *
  3406.      * This operation cannot be undone as some parts of the UnitOfWork now keep gathering information
  3407.      * on this object that might be necessary to perform a correct update.
  3408.      *
  3409.      * @param object $object
  3410.      *
  3411.      * @return void
  3412.      *
  3413.      * @throws ORMInvalidArgumentException
  3414.      */
  3415.     public function markReadOnly($object)
  3416.     {
  3417.         if (! is_object($object) || ! $this->isInIdentityMap($object)) {
  3418.             throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
  3419.         }
  3421.         $this->readOnlyObjects[spl_object_id($object)] = true;
  3422.     }
  3424.     /**
  3425.      * Is this entity read only?
  3426.      *
  3427.      * @param object $object
  3428.      *
  3429.      * @return bool
  3430.      *
  3431.      * @throws ORMInvalidArgumentException
  3432.      */
  3433.     public function isReadOnly($object)
  3434.     {
  3435.         if (! is_object($object)) {
  3436.             throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
  3437.         }
  3439.         return isset($this->readOnlyObjects[spl_object_id($object)]);
  3440.     }
  3442.     /**
  3443.      * Perform whatever processing is encapsulated here after completion of the transaction.
  3444.      */
  3445.     private function afterTransactionComplete(): void
  3446.     {
  3447.         $this->performCallbackOnCachedPersister(static function (CachedPersister $persister) {
  3448.             $persister->afterTransactionComplete();
  3449.         });
  3450.     }
  3452.     /**
  3453.      * Perform whatever processing is encapsulated here after completion of the rolled-back.
  3454.      */
  3455.     private function afterTransactionRolledBack(): void
  3456.     {
  3457.         $this->performCallbackOnCachedPersister(static function (CachedPersister $persister) {
  3458.             $persister->afterTransactionRolledBack();
  3459.         });
  3460.     }
  3462.     /**
  3463.      * Performs an action after the transaction.
  3464.      */
  3465.     private function performCallbackOnCachedPersister(callable $callback): void
  3466.     {
  3467.         if (! $this->hasCache) {
  3468.             return;
  3469.         }
  3471.         foreach (array_merge($this->persisters, $this->collectionPersisters) as $persister) {
  3472.             if ($persister instanceof CachedPersister) {
  3473.                 $callback($persister);
  3474.             }
  3475.         }
  3476.     }
  3478.     private function dispatchOnFlushEvent(): void
  3479.     {
  3480.         if ($this->evm->hasListeners(Events::onFlush)) {
  3481.             $this->evm->dispatchEvent(Events::onFlush, new OnFlushEventArgs($this->em));
  3482.         }
  3483.     }
  3485.     private function dispatchPostFlushEvent(): void
  3486.     {
  3487.         if ($this->evm->hasListeners(Events::postFlush)) {
  3488.             $this->evm->dispatchEvent(Events::postFlush, new PostFlushEventArgs($this->em));
  3489.         }
  3490.     }
  3492.     /**
  3493.      * Verifies if two given entities actually are the same based on identifier comparison
  3494.      *
  3495.      * @param object $entity1
  3496.      * @param object $entity2
  3497.      */
  3498.     private function isIdentifierEquals($entity1, $entity2): bool
  3499.     {
  3500.         if ($entity1 === $entity2) {
  3501.             return true;
  3502.         }
  3504.         $class = $this->em->getClassMetadata(get_class($entity1));
  3506.         if ($class !== $this->em->getClassMetadata(get_class($entity2))) {
  3507.             return false;
  3508.         }
  3510.         $oid1 = spl_object_id($entity1);
  3511.         $oid2 = spl_object_id($entity2);
  3513.         $id1 = $this->entityIdentifiers[$oid1] ?? $this->identifierFlattener->flattenIdentifier($class, $class->getIdentifierValues($entity1));
  3514.         $id2 = $this->entityIdentifiers[$oid2] ?? $this->identifierFlattener->flattenIdentifier($class, $class->getIdentifierValues($entity2));
  3516.         return $id1 === $id2 || implode(' ', $id1) === implode(' ', $id2);
  3517.     }
  3519.     /**
  3520.      * @throws ORMInvalidArgumentException
  3521.      */
  3522.     private function assertThatThereAreNoUnintentionallyNonPersistedAssociations(): void
  3523.     {
  3524.         $entitiesNeedingCascadePersist = array_diff_key($this->nonCascadedNewDetectedEntities, $this->entityInsertions);
  3526.         $this->nonCascadedNewDetectedEntities = [];
  3528.         if ($entitiesNeedingCascadePersist) {
  3529.             throw ORMInvalidArgumentException::newEntitiesFoundThroughRelationships(
  3530.                 array_values($entitiesNeedingCascadePersist)
  3531.             );
  3532.         }
  3533.     }
  3535.     /**
  3536.      * @param object $entity
  3537.      * @param object $managedCopy
  3538.      *
  3539.      * @throws ORMException
  3540.      * @throws OptimisticLockException
  3541.      * @throws TransactionRequiredException
  3542.      */
  3543.     private function mergeEntityStateIntoManagedCopy($entity, $managedCopy): void
  3544.     {
  3545.         if (! $this->isLoaded($entity)) {
  3546.             return;
  3547.         }
  3549.         if (! $this->isLoaded($managedCopy)) {
  3550.             $managedCopy->__load();
  3551.         }
  3553.         $class = $this->em->getClassMetadata(get_class($entity));
  3555.         foreach ($this->reflectionPropertiesGetter->getProperties($class->name) as $prop) {
  3556.             $name = $prop->name;
  3558.             $prop->setAccessible(true);
  3560.             if (! isset($class->associationMappings[$name])) {
  3561.                 if (! $class->isIdentifier($name)) {
  3562.                     $prop->setValue($managedCopy, $prop->getValue($entity));
  3563.                 }
  3564.             } else {
  3565.                 $assoc2 = $class->associationMappings[$name];
  3567.                 if ($assoc2['type'] & ClassMetadata::TO_ONE) {
  3568.                     $other = $prop->getValue($entity);
  3569.                     if ($other === null) {
  3570.                         $prop->setValue($managedCopy, null);
  3571.                     } else {
  3572.                         if ($other instanceof Proxy && ! $other->__isInitialized()) {
  3573.                             // do not merge fields marked lazy that have not been fetched.
  3574.                             continue;
  3575.                         }
  3577.                         if (! $assoc2['isCascadeMerge']) {
  3578.                             if ($this->getEntityState($other) === self::STATE_DETACHED) {
  3579.                                 $targetClass = $this->em->getClassMetadata($assoc2['targetEntity']);
  3580.                                 $relatedId   = $targetClass->getIdentifierValues($other);
  3582.                                 if ($targetClass->subClasses) {
  3583.                                     $other = $this->em->find($targetClass->name, $relatedId);
  3584.                                 } else {
  3585.                                     $other = $this->em->getProxyFactory()->getProxy(
  3586.                                         $assoc2['targetEntity'],
  3587.                                         $relatedId
  3588.                                     );
  3589.                                     $this->registerManaged($other, $relatedId, []);
  3590.                                 }
  3591.                             }
  3593.                             $prop->setValue($managedCopy, $other);
  3594.                         }
  3595.                     }
  3596.                 } else {
  3597.                     $mergeCol = $prop->getValue($entity);
  3599.                     if ($mergeCol instanceof PersistentCollection && ! $mergeCol->isInitialized()) {
  3600.                         // do not merge fields marked lazy that have not been fetched.
  3601.                         // keep the lazy persistent collection of the managed copy.
  3602.                         continue;
  3603.                     }
  3605.                     $managedCol = $prop->getValue($managedCopy);
  3607.                     if (! $managedCol) {
  3608.                         $managedCol = new PersistentCollection(
  3609.                             $this->em,
  3610.                             $this->em->getClassMetadata($assoc2['targetEntity']),
  3611.                             new ArrayCollection()
  3612.                         );
  3613.                         $managedCol->setOwner($managedCopy, $assoc2);
  3614.                         $prop->setValue($managedCopy, $managedCol);
  3615.                     }
  3617.                     if ($assoc2['isCascadeMerge']) {
  3618.                         $managedCol->initialize();
  3620.                         // clear and set dirty a managed collection if its not also the same collection to merge from.
  3621.                         if (! $managedCol->isEmpty() && $managedCol !== $mergeCol) {
  3622.                             $managedCol->unwrap()->clear();
  3623.                             $managedCol->setDirty(true);
  3625.                             if (
  3626.                                 $assoc2['isOwningSide']
  3627.                                 && $assoc2['type'] === ClassMetadata::MANY_TO_MANY
  3628.                                 && $class->isChangeTrackingNotify()
  3629.                             ) {
  3630.                                 $this->scheduleForDirtyCheck($managedCopy);
  3631.                             }
  3632.                         }
  3633.                     }
  3634.                 }
  3635.             }
  3637.             if ($class->isChangeTrackingNotify()) {
  3638.                 // Just treat all properties as changed, there is no other choice.
  3639.                 $this->propertyChanged($managedCopy, $name, null, $prop->getValue($managedCopy));
  3640.             }
  3641.         }
  3642.     }
  3644.     /**
  3645.      * This method called by hydrators, and indicates that hydrator totally completed current hydration cycle.
  3646.      * Unit of work able to fire deferred events, related to loading events here.
  3647.      *
  3648.      * @internal should be called internally from object hydrators
  3649.      *
  3650.      * @return void
  3651.      */
  3652.     public function hydrationComplete()
  3653.     {
  3654.         $this->hydrationCompleteHandler->hydrationComplete();
  3655.     }
  3657.     private function clearIdentityMapForEntityName(string $entityName): void
  3658.     {
  3659.         if (! isset($this->identityMap[$entityName])) {
  3660.             return;
  3661.         }
  3663.         $visited = [];
  3665.         foreach ($this->identityMap[$entityName] as $entity) {
  3666.             $this->doDetach($entity, $visited, false);
  3667.         }
  3668.     }
  3670.     private function clearEntityInsertionsForEntityName(string $entityName): void
  3671.     {
  3672.         foreach ($this->entityInsertions as $hash => $entity) {
  3673.             // note: performance optimization - `instanceof` is much faster than a function call
  3674.             if ($entity instanceof $entityName && get_class($entity) === $entityName) {
  3675.                 unset($this->entityInsertions[$hash]);
  3676.             }
  3677.         }
  3678.     }
  3680.     /**
  3681.      * @param mixed $identifierValue
  3682.      *
  3683.      * @return mixed the identifier after type conversion
  3684.      *
  3685.      * @throws MappingException if the entity has more than a single identifier.
  3686.      */
  3687.     private function convertSingleFieldIdentifierToPHPValue(ClassMetadata $class, $identifierValue)
  3688.     {
  3689.         return $this->em->getConnection()->convertToPHPValue(
  3690.             $identifierValue,
  3691.             $class->getTypeOfField($class->getSingleIdentifierFieldName())
  3692.         );
  3693.     }
  3694. }