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

Open in your IDE?
  1. <?php
  2. declare(strict_types=1);
  3. namespace Doctrine\ORM;
  4. use BackedEnum;
  5. use DateTimeInterface;
  6. use Doctrine\Common\Collections\ArrayCollection;
  7. use Doctrine\Common\Collections\Collection;
  8. use Doctrine\Common\EventManager;
  9. use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
  10. use Doctrine\DBAL\LockMode;
  11. use Doctrine\Deprecations\Deprecation;
  12. use Doctrine\ORM\Cache\Persister\CachedPersister;
  13. use Doctrine\ORM\Event\ListenersInvoker;
  14. use Doctrine\ORM\Event\OnFlushEventArgs;
  15. use Doctrine\ORM\Event\PostFlushEventArgs;
  16. use Doctrine\ORM\Event\PostPersistEventArgs;
  17. use Doctrine\ORM\Event\PostRemoveEventArgs;
  18. use Doctrine\ORM\Event\PostUpdateEventArgs;
  19. use Doctrine\ORM\Event\PreFlushEventArgs;
  20. use Doctrine\ORM\Event\PrePersistEventArgs;
  21. use Doctrine\ORM\Event\PreRemoveEventArgs;
  22. use Doctrine\ORM\Event\PreUpdateEventArgs;
  23. use Doctrine\ORM\Exception\EntityIdentityCollisionException;
  24. use Doctrine\ORM\Exception\ORMException;
  25. use Doctrine\ORM\Exception\UnexpectedAssociationValue;
  26. use Doctrine\ORM\Id\AssignedGenerator;
  27. use Doctrine\ORM\Internal\CommitOrderCalculator;
  28. use Doctrine\ORM\Internal\HydrationCompleteHandler;
  29. use Doctrine\ORM\Internal\TopologicalSort;
  30. use Doctrine\ORM\Mapping\ClassMetadata;
  31. use Doctrine\ORM\Mapping\MappingException;
  32. use Doctrine\ORM\Mapping\Reflection\ReflectionPropertiesGetter;
  33. use Doctrine\ORM\Persisters\Collection\CollectionPersister;
  34. use Doctrine\ORM\Persisters\Collection\ManyToManyPersister;
  35. use Doctrine\ORM\Persisters\Collection\OneToManyPersister;
  36. use Doctrine\ORM\Persisters\Entity\BasicEntityPersister;
  37. use Doctrine\ORM\Persisters\Entity\EntityPersister;
  38. use Doctrine\ORM\Persisters\Entity\JoinedSubclassPersister;
  39. use Doctrine\ORM\Persisters\Entity\SingleTablePersister;
  40. use Doctrine\ORM\Proxy\InternalProxy;
  41. use Doctrine\ORM\Utility\IdentifierFlattener;
  42. use Doctrine\Persistence\Mapping\RuntimeReflectionService;
  43. use Doctrine\Persistence\NotifyPropertyChanged;
  44. use Doctrine\Persistence\ObjectManagerAware;
  45. use Doctrine\Persistence\PropertyChangedListener;
  46. use Exception;
  47. use InvalidArgumentException;
  48. use RuntimeException;
  49. use Throwable;
  50. use UnexpectedValueException;
  51. use function array_combine;
  52. use function array_diff_key;
  53. use function array_filter;
  54. use function array_key_exists;
  55. use function array_map;
  56. use function array_merge;
  57. use function array_sum;
  58. use function array_values;
  59. use function assert;
  60. use function current;
  61. use function func_get_arg;
  62. use function func_num_args;
  63. use function get_class;
  64. use function get_debug_type;
  65. use function implode;
  66. use function in_array;
  67. use function is_array;
  68. use function is_object;
  69. use function method_exists;
  70. use function reset;
  71. use function spl_object_id;
  72. use function sprintf;
  73. use function strtolower;
  74. /**
  75.  * The UnitOfWork is responsible for tracking changes to objects during an
  76.  * "object-level" transaction and for writing out changes to the database
  77.  * in the correct order.
  78.  *
  79.  * Internal note: This class contains highly performance-sensitive code.
  80.  *
  81.  * @psalm-import-type AssociationMapping from ClassMetadata
  82.  */
  83. class UnitOfWork implements PropertyChangedListener
  84. {
  85.     /**
  86.      * An entity is in MANAGED state when its persistence is managed by an EntityManager.
  87.      */
  88.     public const STATE_MANAGED 1;
  89.     /**
  90.      * An entity is new if it has just been instantiated (i.e. using the "new" operator)
  91.      * and is not (yet) managed by an EntityManager.
  92.      */
  93.     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;
  99.     /**
  100.      * A removed entity instance is an instance with a persistent identity,
  101.      * associated with an EntityManager, whose persistent state will be deleted
  102.      * on commit.
  103.      */
  104.     public const STATE_REMOVED 4;
  105.     /**
  106.      * Hint used to collect all primary keys of associated entities during hydration
  107.      * and execute it in a dedicated query afterwards
  108.      *
  109.      * @see https://www.doctrine-project.org/projects/doctrine-orm/en/stable/reference/dql-doctrine-query-language.html#temporarily-change-fetch-mode-in-dql
  110.      */
  111.     public const HINT_DEFEREAGERLOAD 'deferEagerLoad';
  112.     /**
  113.      * The identity map that holds references to all managed entities that have
  114.      * an identity. The entities are grouped by their class name.
  115.      * Since all classes in a hierarchy must share the same identifier set,
  116.      * we always take the root class name of the hierarchy.
  117.      *
  118.      * @var mixed[]
  119.      * @psalm-var array<class-string, array<string, object>>
  120.      */
  121.     private $identityMap = [];
  122.     /**
  123.      * Map of all identifiers of managed entities.
  124.      * Keys are object ids (spl_object_id).
  125.      *
  126.      * @var mixed[]
  127.      * @psalm-var array<int, array<string, mixed>>
  128.      */
  129.     private $entityIdentifiers = [];
  130.     /**
  131.      * Map of the original entity data of managed entities.
  132.      * Keys are object ids (spl_object_id). This is used for calculating changesets
  133.      * at commit time.
  134.      *
  135.      * Internal note: Note that PHPs "copy-on-write" behavior helps a lot with memory usage.
  136.      *                A value will only really be copied if the value in the entity is modified
  137.      *                by the user.
  138.      *
  139.      * @psalm-var array<int, array<string, mixed>>
  140.      */
  141.     private $originalEntityData = [];
  142.     /**
  143.      * Map of entity changes. Keys are object ids (spl_object_id).
  144.      * Filled at the beginning of a commit of the UnitOfWork and cleaned at the end.
  145.      *
  146.      * @psalm-var array<int, array<string, array{mixed, mixed}>>
  147.      */
  148.     private $entityChangeSets = [];
  149.     /**
  150.      * The (cached) states of any known entities.
  151.      * Keys are object ids (spl_object_id).
  152.      *
  153.      * @psalm-var array<int, self::STATE_*>
  154.      */
  155.     private $entityStates = [];
  156.     /**
  157.      * Map of entities that are scheduled for dirty checking at commit time.
  158.      * This is only used for entities with a change tracking policy of DEFERRED_EXPLICIT.
  159.      * Keys are object ids (spl_object_id).
  160.      *
  161.      * @psalm-var array<class-string, array<int, mixed>>
  162.      */
  163.     private $scheduledForSynchronization = [];
  164.     /**
  165.      * A list of all pending entity insertions.
  166.      *
  167.      * @psalm-var array<int, object>
  168.      */
  169.     private $entityInsertions = [];
  170.     /**
  171.      * A list of all pending entity updates.
  172.      *
  173.      * @psalm-var array<int, object>
  174.      */
  175.     private $entityUpdates = [];
  176.     /**
  177.      * Any pending extra updates that have been scheduled by persisters.
  178.      *
  179.      * @psalm-var array<int, array{object, array<string, array{mixed, mixed}>}>
  180.      */
  181.     private $extraUpdates = [];
  182.     /**
  183.      * A list of all pending entity deletions.
  184.      *
  185.      * @psalm-var array<int, object>
  186.      */
  187.     private $entityDeletions = [];
  188.     /**
  189.      * New entities that were discovered through relationships that were not
  190.      * marked as cascade-persist. During flush, this array is populated and
  191.      * then pruned of any entities that were discovered through a valid
  192.      * cascade-persist path. (Leftovers cause an error.)
  193.      *
  194.      * Keys are OIDs, payload is a two-item array describing the association
  195.      * and the entity.
  196.      *
  197.      * @var array<int, array{AssociationMapping, object}> indexed by respective object spl_object_id()
  198.      */
  199.     private $nonCascadedNewDetectedEntities = [];
  200.     /**
  201.      * All pending collection deletions.
  202.      *
  203.      * @psalm-var array<int, PersistentCollection<array-key, object>>
  204.      */
  205.     private $collectionDeletions = [];
  206.     /**
  207.      * All pending collection updates.
  208.      *
  209.      * @psalm-var array<int, PersistentCollection<array-key, object>>
  210.      */
  211.     private $collectionUpdates = [];
  212.     /**
  213.      * List of collections visited during changeset calculation on a commit-phase of a UnitOfWork.
  214.      * At the end of the UnitOfWork all these collections will make new snapshots
  215.      * of their data.
  216.      *
  217.      * @psalm-var array<int, PersistentCollection<array-key, object>>
  218.      */
  219.     private $visitedCollections = [];
  220.     /**
  221.      * List of collections visited during the changeset calculation that contain to-be-removed
  222.      * entities and need to have keys removed post commit.
  223.      *
  224.      * Indexed by Collection object ID, which also serves as the key in self::$visitedCollections;
  225.      * values are the key names that need to be removed.
  226.      *
  227.      * @psalm-var array<int, array<array-key, true>>
  228.      */
  229.     private $pendingCollectionElementRemovals = [];
  230.     /**
  231.      * The EntityManager that "owns" this UnitOfWork instance.
  232.      *
  233.      * @var EntityManagerInterface
  234.      */
  235.     private $em;
  236.     /**
  237.      * The entity persister instances used to persist entity instances.
  238.      *
  239.      * @psalm-var array<string, EntityPersister>
  240.      */
  241.     private $persisters = [];
  242.     /**
  243.      * The collection persister instances used to persist collections.
  244.      *
  245.      * @psalm-var array<array-key, CollectionPersister>
  246.      */
  247.     private $collectionPersisters = [];
  248.     /**
  249.      * The EventManager used for dispatching events.
  250.      *
  251.      * @var EventManager
  252.      */
  253.     private $evm;
  254.     /**
  255.      * The ListenersInvoker used for dispatching events.
  256.      *
  257.      * @var ListenersInvoker
  258.      */
  259.     private $listenersInvoker;
  260.     /**
  261.      * The IdentifierFlattener used for manipulating identifiers
  262.      *
  263.      * @var IdentifierFlattener
  264.      */
  265.     private $identifierFlattener;
  266.     /**
  267.      * Orphaned entities that are scheduled for removal.
  268.      *
  269.      * @psalm-var array<int, object>
  270.      */
  271.     private $orphanRemovals = [];
  272.     /**
  273.      * Read-Only objects are never evaluated
  274.      *
  275.      * @var array<int, true>
  276.      */
  277.     private $readOnlyObjects = [];
  278.     /**
  279.      * Map of Entity Class-Names and corresponding IDs that should eager loaded when requested.
  280.      *
  281.      * @psalm-var array<class-string, array<string, mixed>>
  282.      */
  283.     private $eagerLoadingEntities = [];
  284.     /** @var bool */
  285.     protected $hasCache false;
  286.     /**
  287.      * Helper for handling completion of hydration
  288.      *
  289.      * @var HydrationCompleteHandler
  290.      */
  291.     private $hydrationCompleteHandler;
  292.     /** @var ReflectionPropertiesGetter */
  293.     private $reflectionPropertiesGetter;
  294.     /**
  295.      * Initializes a new UnitOfWork instance, bound to the given EntityManager.
  296.      */
  297.     public function __construct(EntityManagerInterface $em)
  298.     {
  299.         $this->em                         $em;
  300.         $this->evm                        $em->getEventManager();
  301.         $this->listenersInvoker           = new ListenersInvoker($em);
  302.         $this->hasCache                   $em->getConfiguration()->isSecondLevelCacheEnabled();
  303.         $this->identifierFlattener        = new IdentifierFlattener($this$em->getMetadataFactory());
  304.         $this->hydrationCompleteHandler   = new HydrationCompleteHandler($this->listenersInvoker$em);
  305.         $this->reflectionPropertiesGetter = new ReflectionPropertiesGetter(new RuntimeReflectionService());
  306.     }
  307.     /**
  308.      * Commits the UnitOfWork, executing all operations that have been postponed
  309.      * up to this point. The state of all managed entities will be synchronized with
  310.      * the database.
  311.      *
  312.      * The operations are executed in the following order:
  313.      *
  314.      * 1) All entity insertions
  315.      * 2) All entity updates
  316.      * 3) All collection deletions
  317.      * 4) All collection updates
  318.      * 5) All entity deletions
  319.      *
  320.      * @param object|mixed[]|null $entity
  321.      *
  322.      * @return void
  323.      *
  324.      * @throws Exception
  325.      */
  326.     public function commit($entity null)
  327.     {
  328.         if ($entity !== null) {
  329.             Deprecation::triggerIfCalledFromOutside(
  330.                 'doctrine/orm',
  331.                 'https://github.com/doctrine/orm/issues/8459',
  332.                 'Calling %s() with any arguments to commit specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
  333.                 __METHOD__
  334.             );
  335.         }
  336.         $connection $this->em->getConnection();
  337.         if ($connection instanceof PrimaryReadReplicaConnection) {
  338.             $connection->ensureConnectedToPrimary();
  339.         }
  340.         // Raise preFlush
  341.         if ($this->evm->hasListeners(Events::preFlush)) {
  342.             $this->evm->dispatchEvent(Events::preFlush, new PreFlushEventArgs($this->em));
  343.         }
  344.         // Compute changes done since last commit.
  345.         if ($entity === null) {
  346.             $this->computeChangeSets();
  347.         } elseif (is_object($entity)) {
  348.             $this->computeSingleEntityChangeSet($entity);
  349.         } elseif (is_array($entity)) {
  350.             foreach ($entity as $object) {
  351.                 $this->computeSingleEntityChangeSet($object);
  352.             }
  353.         }
  354.         if (
  355.             ! ($this->entityInsertions ||
  356.                 $this->entityDeletions ||
  357.                 $this->entityUpdates ||
  358.                 $this->collectionUpdates ||
  359.                 $this->collectionDeletions ||
  360.                 $this->orphanRemovals)
  361.         ) {
  362.             $this->dispatchOnFlushEvent();
  363.             $this->dispatchPostFlushEvent();
  364.             $this->postCommitCleanup($entity);
  365.             return; // Nothing to do.
  366.         }
  367.         $this->assertThatThereAreNoUnintentionallyNonPersistedAssociations();
  368.         if ($this->orphanRemovals) {
  369.             foreach ($this->orphanRemovals as $orphan) {
  370.                 $this->remove($orphan);
  371.             }
  372.         }
  373.         $this->dispatchOnFlushEvent();
  374.         $conn $this->em->getConnection();
  375.         $conn->beginTransaction();
  376.         try {
  377.             // Collection deletions (deletions of complete collections)
  378.             foreach ($this->collectionDeletions as $collectionToDelete) {
  379.                 // Deferred explicit tracked collections can be removed only when owning relation was persisted
  380.                 $owner $collectionToDelete->getOwner();
  381.                 if ($this->em->getClassMetadata(get_class($owner))->isChangeTrackingDeferredImplicit() || $this->isScheduledForDirtyCheck($owner)) {
  382.                     $this->getCollectionPersister($collectionToDelete->getMapping())->delete($collectionToDelete);
  383.                 }
  384.             }
  385.             if ($this->entityInsertions) {
  386.                 // Perform entity insertions first, so that all new entities have their rows in the database
  387.                 // and can be referred to by foreign keys. The commit order only needs to take new entities
  388.                 // into account (new entities referring to other new entities), since all other types (entities
  389.                 // with updates or scheduled deletions) are currently not a problem, since they are already
  390.                 // in the database.
  391.                 $this->executeInserts();
  392.             }
  393.             if ($this->entityUpdates) {
  394.                 // Updates do not need to follow a particular order
  395.                 $this->executeUpdates();
  396.             }
  397.             // Extra updates that were requested by persisters.
  398.             // This may include foreign keys that could not be set when an entity was inserted,
  399.             // which may happen in the case of circular foreign key relationships.
  400.             if ($this->extraUpdates) {
  401.                 $this->executeExtraUpdates();
  402.             }
  403.             // Collection updates (deleteRows, updateRows, insertRows)
  404.             // No particular order is necessary, since all entities themselves are already
  405.             // in the database
  406.             foreach ($this->collectionUpdates as $collectionToUpdate) {
  407.                 $this->getCollectionPersister($collectionToUpdate->getMapping())->update($collectionToUpdate);
  408.             }
  409.             // Entity deletions come last. Their order only needs to take care of other deletions
  410.             // (first delete entities depending upon others, before deleting depended-upon entities).
  411.             if ($this->entityDeletions) {
  412.                 $this->executeDeletions();
  413.             }
  414.             // Commit failed silently
  415.             if ($conn->commit() === false) {
  416.                 $object is_object($entity) ? $entity null;
  417.                 throw new OptimisticLockException('Commit failed'$object);
  418.             }
  419.         } catch (Throwable $e) {
  420.             $this->em->close();
  421.             if ($conn->isTransactionActive()) {
  422.                 $conn->rollBack();
  423.             }
  424.             $this->afterTransactionRolledBack();
  425.             throw $e;
  426.         }
  427.         $this->afterTransactionComplete();
  428.         // Unset removed entities from collections, and take new snapshots from
  429.         // all visited collections.
  430.         foreach ($this->visitedCollections as $coid => $coll) {
  431.             if (isset($this->pendingCollectionElementRemovals[$coid])) {
  432.                 foreach ($this->pendingCollectionElementRemovals[$coid] as $key => $valueIgnored) {
  433.                     unset($coll[$key]);
  434.                 }
  435.             }
  436.             $coll->takeSnapshot();
  437.         }
  438.         $this->dispatchPostFlushEvent();
  439.         $this->postCommitCleanup($entity);
  440.     }
  441.     /** @param object|object[]|null $entity */
  442.     private function postCommitCleanup($entity): void
  443.     {
  444.         $this->entityInsertions                 =
  445.         $this->entityUpdates                    =
  446.         $this->entityDeletions                  =
  447.         $this->extraUpdates                     =
  448.         $this->collectionUpdates                =
  449.         $this->nonCascadedNewDetectedEntities   =
  450.         $this->collectionDeletions              =
  451.         $this->pendingCollectionElementRemovals =
  452.         $this->visitedCollections               =
  453.         $this->orphanRemovals                   = [];
  454.         if ($entity === null) {
  455.             $this->entityChangeSets $this->scheduledForSynchronization = [];
  456.             return;
  457.         }
  458.         $entities is_object($entity)
  459.             ? [$entity]
  460.             : $entity;
  461.         foreach ($entities as $object) {
  462.             $oid spl_object_id($object);
  463.             $this->clearEntityChangeSet($oid);
  464.             unset($this->scheduledForSynchronization[$this->em->getClassMetadata(get_class($object))->rootEntityName][$oid]);
  465.         }
  466.     }
  467.     /**
  468.      * Computes the changesets of all entities scheduled for insertion.
  469.      */
  470.     private function computeScheduleInsertsChangeSets(): void
  471.     {
  472.         foreach ($this->entityInsertions as $entity) {
  473.             $class $this->em->getClassMetadata(get_class($entity));
  474.             $this->computeChangeSet($class$entity);
  475.         }
  476.     }
  477.     /**
  478.      * Only flushes the given entity according to a ruleset that keeps the UoW consistent.
  479.      *
  480.      * 1. All entities scheduled for insertion, (orphan) removals and changes in collections are processed as well!
  481.      * 2. Read Only entities are skipped.
  482.      * 3. Proxies are skipped.
  483.      * 4. Only if entity is properly managed.
  484.      *
  485.      * @param object $entity
  486.      *
  487.      * @throws InvalidArgumentException
  488.      */
  489.     private function computeSingleEntityChangeSet($entity): void
  490.     {
  491.         $state $this->getEntityState($entity);
  492.         if ($state !== self::STATE_MANAGED && $state !== self::STATE_REMOVED) {
  493.             throw new InvalidArgumentException('Entity has to be managed or scheduled for removal for single computation ' self::objToStr($entity));
  494.         }
  495.         $class $this->em->getClassMetadata(get_class($entity));
  496.         if ($state === self::STATE_MANAGED && $class->isChangeTrackingDeferredImplicit()) {
  497.             $this->persist($entity);
  498.         }
  499.         // Compute changes for INSERTed entities first. This must always happen even in this case.
  500.         $this->computeScheduleInsertsChangeSets();
  501.         if ($class->isReadOnly) {
  502.             return;
  503.         }
  504.         // Ignore uninitialized proxy objects
  505.         if ($this->isUninitializedObject($entity)) {
  506.             return;
  507.         }
  508.         // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION OR DELETION are processed here.
  509.         $oid spl_object_id($entity);
  510.         if (! isset($this->entityInsertions[$oid]) && ! isset($this->entityDeletions[$oid]) && isset($this->entityStates[$oid])) {
  511.             $this->computeChangeSet($class$entity);
  512.         }
  513.     }
  514.     /**
  515.      * Executes any extra updates that have been scheduled.
  516.      */
  517.     private function executeExtraUpdates(): void
  518.     {
  519.         foreach ($this->extraUpdates as $oid => $update) {
  520.             [$entity$changeset] = $update;
  521.             $this->entityChangeSets[$oid] = $changeset;
  522.             $this->getEntityPersister(get_class($entity))->update($entity);
  523.         }
  524.         $this->extraUpdates = [];
  525.     }
  526.     /**
  527.      * Gets the changeset for an entity.
  528.      *
  529.      * @param object $entity
  530.      *
  531.      * @return mixed[][]
  532.      * @psalm-return array<string, array{mixed, mixed}|PersistentCollection>
  533.      */
  534.     public function & getEntityChangeSet($entity)
  535.     {
  536.         $oid  spl_object_id($entity);
  537.         $data = [];
  538.         if (! isset($this->entityChangeSets[$oid])) {
  539.             return $data;
  540.         }
  541.         return $this->entityChangeSets[$oid];
  542.     }
  543.     /**
  544.      * Computes the changes that happened to a single entity.
  545.      *
  546.      * Modifies/populates the following properties:
  547.      *
  548.      * {@link _originalEntityData}
  549.      * If the entity is NEW or MANAGED but not yet fully persisted (only has an id)
  550.      * then it was not fetched from the database and therefore we have no original
  551.      * entity data yet. All of the current entity data is stored as the original entity data.
  552.      *
  553.      * {@link _entityChangeSets}
  554.      * The changes detected on all properties of the entity are stored there.
  555.      * A change is a tuple array where the first entry is the old value and the second
  556.      * entry is the new value of the property. Changesets are used by persisters
  557.      * to INSERT/UPDATE the persistent entity state.
  558.      *
  559.      * {@link _entityUpdates}
  560.      * If the entity is already fully MANAGED (has been fetched from the database before)
  561.      * and any changes to its properties are detected, then a reference to the entity is stored
  562.      * there to mark it for an update.
  563.      *
  564.      * {@link _collectionDeletions}
  565.      * If a PersistentCollection has been de-referenced in a fully MANAGED entity,
  566.      * then this collection is marked for deletion.
  567.      *
  568.      * @param ClassMetadata $class  The class descriptor of the entity.
  569.      * @param object        $entity The entity for which to compute the changes.
  570.      * @psalm-param ClassMetadata<T> $class
  571.      * @psalm-param T $entity
  572.      *
  573.      * @return void
  574.      *
  575.      * @template T of object
  576.      *
  577.      * @ignore
  578.      */
  579.     public function computeChangeSet(ClassMetadata $class$entity)
  580.     {
  581.         $oid spl_object_id($entity);
  582.         if (isset($this->readOnlyObjects[$oid])) {
  583.             return;
  584.         }
  585.         if (! $class->isInheritanceTypeNone()) {
  586.             $class $this->em->getClassMetadata(get_class($entity));
  587.         }
  588.         $invoke $this->listenersInvoker->getSubscribedSystems($classEvents::preFlush) & ~ListenersInvoker::INVOKE_MANAGER;
  589.         if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  590.             $this->listenersInvoker->invoke($classEvents::preFlush$entity, new PreFlushEventArgs($this->em), $invoke);
  591.         }
  592.         $actualData = [];
  593.         foreach ($class->reflFields as $name => $refProp) {
  594.             $value $refProp->getValue($entity);
  595.             if ($class->isCollectionValuedAssociation($name) && $value !== null) {
  596.                 if ($value instanceof PersistentCollection) {
  597.                     if ($value->getOwner() === $entity) {
  598.                         $actualData[$name] = $value;
  599.                         continue;
  600.                     }
  601.                     $value = new ArrayCollection($value->getValues());
  602.                 }
  603.                 // If $value is not a Collection then use an ArrayCollection.
  604.                 if (! $value instanceof Collection) {
  605.                     $value = new ArrayCollection($value);
  606.                 }
  607.                 $assoc $class->associationMappings[$name];
  608.                 // Inject PersistentCollection
  609.                 $value = new PersistentCollection(
  610.                     $this->em,
  611.                     $this->em->getClassMetadata($assoc['targetEntity']),
  612.                     $value
  613.                 );
  614.                 $value->setOwner($entity$assoc);
  615.                 $value->setDirty(! $value->isEmpty());
  616.                 $refProp->setValue($entity$value);
  617.                 $actualData[$name] = $value;
  618.                 continue;
  619.             }
  620.             if (( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity()) && ($name !== $class->versionField)) {
  621.                 $actualData[$name] = $value;
  622.             }
  623.         }
  624.         if (! isset($this->originalEntityData[$oid])) {
  625.             // Entity is either NEW or MANAGED but not yet fully persisted (only has an id).
  626.             // These result in an INSERT.
  627.             $this->originalEntityData[$oid] = $actualData;
  628.             $changeSet                      = [];
  629.             foreach ($actualData as $propName => $actualValue) {
  630.                 if (! isset($class->associationMappings[$propName])) {
  631.                     $changeSet[$propName] = [null$actualValue];
  632.                     continue;
  633.                 }
  634.                 $assoc $class->associationMappings[$propName];
  635.                 if ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE) {
  636.                     $changeSet[$propName] = [null$actualValue];
  637.                 }
  638.             }
  639.             $this->entityChangeSets[$oid] = $changeSet;
  640.         } else {
  641.             // Entity is "fully" MANAGED: it was already fully persisted before
  642.             // and we have a copy of the original data
  643.             $originalData           $this->originalEntityData[$oid];
  644.             $isChangeTrackingNotify $class->isChangeTrackingNotify();
  645.             $changeSet              $isChangeTrackingNotify && isset($this->entityChangeSets[$oid])
  646.                 ? $this->entityChangeSets[$oid]
  647.                 : [];
  648.             foreach ($actualData as $propName => $actualValue) {
  649.                 // skip field, its a partially omitted one!
  650.                 if (! (isset($originalData[$propName]) || array_key_exists($propName$originalData))) {
  651.                     continue;
  652.                 }
  653.                 $orgValue $originalData[$propName];
  654.                 if (! empty($class->fieldMappings[$propName]['enumType'])) {
  655.                     if (is_array($orgValue)) {
  656.                         foreach ($orgValue as $id => $val) {
  657.                             if ($val instanceof BackedEnum) {
  658.                                 $orgValue[$id] = $val->value;
  659.                             }
  660.                         }
  661.                     } else {
  662.                         if ($orgValue instanceof BackedEnum) {
  663.                             $orgValue $orgValue->value;
  664.                         }
  665.                     }
  666.                 }
  667.                 // skip if value haven't changed
  668.                 if ($orgValue === $actualValue) {
  669.                     continue;
  670.                 }
  671.                 // if regular field
  672.                 if (! isset($class->associationMappings[$propName])) {
  673.                     if ($isChangeTrackingNotify) {
  674.                         continue;
  675.                     }
  676.                     $changeSet[$propName] = [$orgValue$actualValue];
  677.                     continue;
  678.                 }
  679.                 $assoc $class->associationMappings[$propName];
  680.                 // Persistent collection was exchanged with the "originally"
  681.                 // created one. This can only mean it was cloned and replaced
  682.                 // on another entity.
  683.                 if ($actualValue instanceof PersistentCollection) {
  684.                     $owner $actualValue->getOwner();
  685.                     if ($owner === null) { // cloned
  686.                         $actualValue->setOwner($entity$assoc);
  687.                     } elseif ($owner !== $entity) { // no clone, we have to fix
  688.                         if (! $actualValue->isInitialized()) {
  689.                             $actualValue->initialize(); // we have to do this otherwise the cols share state
  690.                         }
  691.                         $newValue = clone $actualValue;
  692.                         $newValue->setOwner($entity$assoc);
  693.                         $class->reflFields[$propName]->setValue($entity$newValue);
  694.                     }
  695.                 }
  696.                 if ($orgValue instanceof PersistentCollection) {
  697.                     // A PersistentCollection was de-referenced, so delete it.
  698.                     $coid spl_object_id($orgValue);
  699.                     if (isset($this->collectionDeletions[$coid])) {
  700.                         continue;
  701.                     }
  702.                     $this->collectionDeletions[$coid] = $orgValue;
  703.                     $changeSet[$propName]             = $orgValue// Signal changeset, to-many assocs will be ignored.
  704.                     continue;
  705.                 }
  706.                 if ($assoc['type'] & ClassMetadata::TO_ONE) {
  707.                     if ($assoc['isOwningSide']) {
  708.                         $changeSet[$propName] = [$orgValue$actualValue];
  709.                     }
  710.                     if ($orgValue !== null && $assoc['orphanRemoval']) {
  711.                         assert(is_object($orgValue));
  712.                         $this->scheduleOrphanRemoval($orgValue);
  713.                     }
  714.                 }
  715.             }
  716.             if ($changeSet) {
  717.                 $this->entityChangeSets[$oid]   = $changeSet;
  718.                 $this->originalEntityData[$oid] = $actualData;
  719.                 $this->entityUpdates[$oid]      = $entity;
  720.             }
  721.         }
  722.         // Look for changes in associations of the entity
  723.         foreach ($class->associationMappings as $field => $assoc) {
  724.             $val $class->reflFields[$field]->getValue($entity);
  725.             if ($val === null) {
  726.                 continue;
  727.             }
  728.             $this->computeAssociationChanges($assoc$val);
  729.             if (
  730.                 ! isset($this->entityChangeSets[$oid]) &&
  731.                 $assoc['isOwningSide'] &&
  732.                 $assoc['type'] === ClassMetadata::MANY_TO_MANY &&
  733.                 $val instanceof PersistentCollection &&
  734.                 $val->isDirty()
  735.             ) {
  736.                 $this->entityChangeSets[$oid]   = [];
  737.                 $this->originalEntityData[$oid] = $actualData;
  738.                 $this->entityUpdates[$oid]      = $entity;
  739.             }
  740.         }
  741.     }
  742.     /**
  743.      * Computes all the changes that have been done to entities and collections
  744.      * since the last commit and stores these changes in the _entityChangeSet map
  745.      * temporarily for access by the persisters, until the UoW commit is finished.
  746.      *
  747.      * @return void
  748.      */
  749.     public function computeChangeSets()
  750.     {
  751.         // Compute changes for INSERTed entities first. This must always happen.
  752.         $this->computeScheduleInsertsChangeSets();
  753.         // Compute changes for other MANAGED entities. Change tracking policies take effect here.
  754.         foreach ($this->identityMap as $className => $entities) {
  755.             $class $this->em->getClassMetadata($className);
  756.             // Skip class if instances are read-only
  757.             if ($class->isReadOnly) {
  758.                 continue;
  759.             }
  760.             // If change tracking is explicit or happens through notification, then only compute
  761.             // changes on entities of that type that are explicitly marked for synchronization.
  762.             switch (true) {
  763.                 case $class->isChangeTrackingDeferredImplicit():
  764.                     $entitiesToProcess $entities;
  765.                     break;
  766.                 case isset($this->scheduledForSynchronization[$className]):
  767.                     $entitiesToProcess $this->scheduledForSynchronization[$className];
  768.                     break;
  769.                 default:
  770.                     $entitiesToProcess = [];
  771.             }
  772.             foreach ($entitiesToProcess as $entity) {
  773.                 // Ignore uninitialized proxy objects
  774.                 if ($this->isUninitializedObject($entity)) {
  775.                     continue;
  776.                 }
  777.                 // Only MANAGED entities that are NOT SCHEDULED FOR INSERTION OR DELETION are processed here.
  778.                 $oid spl_object_id($entity);
  779.                 if (! isset($this->entityInsertions[$oid]) && ! isset($this->entityDeletions[$oid]) && isset($this->entityStates[$oid])) {
  780.                     $this->computeChangeSet($class$entity);
  781.                 }
  782.             }
  783.         }
  784.     }
  785.     /**
  786.      * Computes the changes of an association.
  787.      *
  788.      * @param mixed $value The value of the association.
  789.      * @psalm-param AssociationMapping $assoc The association mapping.
  790.      *
  791.      * @throws ORMInvalidArgumentException
  792.      * @throws ORMException
  793.      */
  794.     private function computeAssociationChanges(array $assoc$value): void
  795.     {
  796.         if ($this->isUninitializedObject($value)) {
  797.             return;
  798.         }
  799.         // If this collection is dirty, schedule it for updates
  800.         if ($value instanceof PersistentCollection && $value->isDirty()) {
  801.             $coid spl_object_id($value);
  802.             $this->collectionUpdates[$coid]  = $value;
  803.             $this->visitedCollections[$coid] = $value;
  804.         }
  805.         // Look through the entities, and in any of their associations,
  806.         // for transient (new) entities, recursively. ("Persistence by reachability")
  807.         // Unwrap. Uninitialized collections will simply be empty.
  808.         $unwrappedValue $assoc['type'] & ClassMetadata::TO_ONE ? [$value] : $value->unwrap();
  809.         $targetClass    $this->em->getClassMetadata($assoc['targetEntity']);
  810.         foreach ($unwrappedValue as $key => $entry) {
  811.             if (! ($entry instanceof $targetClass->name)) {
  812.                 throw ORMInvalidArgumentException::invalidAssociation($targetClass$assoc$entry);
  813.             }
  814.             $state $this->getEntityState($entryself::STATE_NEW);
  815.             if (! ($entry instanceof $assoc['targetEntity'])) {
  816.                 throw UnexpectedAssociationValue::create(
  817.                     $assoc['sourceEntity'],
  818.                     $assoc['fieldName'],
  819.                     get_debug_type($entry),
  820.                     $assoc['targetEntity']
  821.                 );
  822.             }
  823.             switch ($state) {
  824.                 case self::STATE_NEW:
  825.                     if (! $assoc['isCascadePersist']) {
  826.                         /*
  827.                          * For now just record the details, because this may
  828.                          * not be an issue if we later discover another pathway
  829.                          * through the object-graph where cascade-persistence
  830.                          * is enabled for this object.
  831.                          */
  832.                         $this->nonCascadedNewDetectedEntities[spl_object_id($entry)] = [$assoc$entry];
  833.                         break;
  834.                     }
  835.                     $this->persistNew($targetClass$entry);
  836.                     $this->computeChangeSet($targetClass$entry);
  837.                     break;
  838.                 case self::STATE_REMOVED:
  839.                     // Consume the $value as array (it's either an array or an ArrayAccess)
  840.                     // and remove the element from Collection.
  841.                     if (! ($assoc['type'] & ClassMetadata::TO_MANY)) {
  842.                         break;
  843.                     }
  844.                     $coid                            spl_object_id($value);
  845.                     $this->visitedCollections[$coid] = $value;
  846.                     if (! isset($this->pendingCollectionElementRemovals[$coid])) {
  847.                         $this->pendingCollectionElementRemovals[$coid] = [];
  848.                     }
  849.                     $this->pendingCollectionElementRemovals[$coid][$key] = true;
  850.                     break;
  851.                 case self::STATE_DETACHED:
  852.                     // Can actually not happen right now as we assume STATE_NEW,
  853.                     // so the exception will be raised from the DBAL layer (constraint violation).
  854.                     throw ORMInvalidArgumentException::detachedEntityFoundThroughRelationship($assoc$entry);
  855.                 default:
  856.                     // MANAGED associated entities are already taken into account
  857.                     // during changeset calculation anyway, since they are in the identity map.
  858.             }
  859.         }
  860.     }
  861.     /**
  862.      * @param object $entity
  863.      * @psalm-param ClassMetadata<T> $class
  864.      * @psalm-param T $entity
  865.      *
  866.      * @template T of object
  867.      */
  868.     private function persistNew(ClassMetadata $class$entity): void
  869.     {
  870.         $oid    spl_object_id($entity);
  871.         $invoke $this->listenersInvoker->getSubscribedSystems($classEvents::prePersist);
  872.         if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  873.             $this->listenersInvoker->invoke($classEvents::prePersist$entity, new PrePersistEventArgs($entity$this->em), $invoke);
  874.         }
  875.         $idGen $class->idGenerator;
  876.         if (! $idGen->isPostInsertGenerator()) {
  877.             $idValue $idGen->generateId($this->em$entity);
  878.             if (! $idGen instanceof AssignedGenerator) {
  879.                 $idValue = [$class->getSingleIdentifierFieldName() => $this->convertSingleFieldIdentifierToPHPValue($class$idValue)];
  880.                 $class->setIdentifierValues($entity$idValue);
  881.             }
  882.             // Some identifiers may be foreign keys to new entities.
  883.             // In this case, we don't have the value yet and should treat it as if we have a post-insert generator
  884.             if (! $this->hasMissingIdsWhichAreForeignKeys($class$idValue)) {
  885.                 $this->entityIdentifiers[$oid] = $idValue;
  886.             }
  887.         }
  888.         $this->entityStates[$oid] = self::STATE_MANAGED;
  889.         $this->scheduleForInsert($entity);
  890.     }
  891.     /** @param mixed[] $idValue */
  892.     private function hasMissingIdsWhichAreForeignKeys(ClassMetadata $class, array $idValue): bool
  893.     {
  894.         foreach ($idValue as $idField => $idFieldValue) {
  895.             if ($idFieldValue === null && isset($class->associationMappings[$idField])) {
  896.                 return true;
  897.             }
  898.         }
  899.         return false;
  900.     }
  901.     /**
  902.      * INTERNAL:
  903.      * Computes the changeset of an individual entity, independently of the
  904.      * computeChangeSets() routine that is used at the beginning of a UnitOfWork#commit().
  905.      *
  906.      * The passed entity must be a managed entity. If the entity already has a change set
  907.      * because this method is invoked during a commit cycle then the change sets are added.
  908.      * whereby changes detected in this method prevail.
  909.      *
  910.      * @param ClassMetadata $class  The class descriptor of the entity.
  911.      * @param object        $entity The entity for which to (re)calculate the change set.
  912.      * @psalm-param ClassMetadata<T> $class
  913.      * @psalm-param T $entity
  914.      *
  915.      * @return void
  916.      *
  917.      * @throws ORMInvalidArgumentException If the passed entity is not MANAGED.
  918.      *
  919.      * @template T of object
  920.      * @ignore
  921.      */
  922.     public function recomputeSingleEntityChangeSet(ClassMetadata $class$entity)
  923.     {
  924.         $oid spl_object_id($entity);
  925.         if (! isset($this->entityStates[$oid]) || $this->entityStates[$oid] !== self::STATE_MANAGED) {
  926.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  927.         }
  928.         // skip if change tracking is "NOTIFY"
  929.         if ($class->isChangeTrackingNotify()) {
  930.             return;
  931.         }
  932.         if (! $class->isInheritanceTypeNone()) {
  933.             $class $this->em->getClassMetadata(get_class($entity));
  934.         }
  935.         $actualData = [];
  936.         foreach ($class->reflFields as $name => $refProp) {
  937.             if (
  938.                 ( ! $class->isIdentifier($name) || ! $class->isIdGeneratorIdentity())
  939.                 && ($name !== $class->versionField)
  940.                 && ! $class->isCollectionValuedAssociation($name)
  941.             ) {
  942.                 $actualData[$name] = $refProp->getValue($entity);
  943.             }
  944.         }
  945.         if (! isset($this->originalEntityData[$oid])) {
  946.             throw new RuntimeException('Cannot call recomputeSingleEntityChangeSet before computeChangeSet on an entity.');
  947.         }
  948.         $originalData $this->originalEntityData[$oid];
  949.         $changeSet    = [];
  950.         foreach ($actualData as $propName => $actualValue) {
  951.             $orgValue $originalData[$propName] ?? null;
  952.             if (isset($class->fieldMappings[$propName]['enumType'])) {
  953.                 if (is_array($orgValue)) {
  954.                     foreach ($orgValue as $id => $val) {
  955.                         if ($val instanceof BackedEnum) {
  956.                             $orgValue[$id] = $val->value;
  957.                         }
  958.                     }
  959.                 } else {
  960.                     if ($orgValue instanceof BackedEnum) {
  961.                         $orgValue $orgValue->value;
  962.                     }
  963.                 }
  964.             }
  965.             if ($orgValue !== $actualValue) {
  966.                 $changeSet[$propName] = [$orgValue$actualValue];
  967.             }
  968.         }
  969.         if ($changeSet) {
  970.             if (isset($this->entityChangeSets[$oid])) {
  971.                 $this->entityChangeSets[$oid] = array_merge($this->entityChangeSets[$oid], $changeSet);
  972.             } elseif (! isset($this->entityInsertions[$oid])) {
  973.                 $this->entityChangeSets[$oid] = $changeSet;
  974.                 $this->entityUpdates[$oid]    = $entity;
  975.             }
  976.             $this->originalEntityData[$oid] = $actualData;
  977.         }
  978.     }
  979.     /**
  980.      * Executes entity insertions
  981.      */
  982.     private function executeInserts(): void
  983.     {
  984.         $entities         $this->computeInsertExecutionOrder();
  985.         $eventsToDispatch = [];
  986.         foreach ($entities as $entity) {
  987.             $oid       spl_object_id($entity);
  988.             $class     $this->em->getClassMetadata(get_class($entity));
  989.             $persister $this->getEntityPersister($class->name);
  990.             $persister->addInsert($entity);
  991.             unset($this->entityInsertions[$oid]);
  992.             $postInsertIds $persister->executeInserts();
  993.             if (is_array($postInsertIds)) {
  994.                 Deprecation::trigger(
  995.                     'doctrine/orm',
  996.                     'https://github.com/doctrine/orm/pull/10743/',
  997.                     'Returning post insert IDs from \Doctrine\ORM\Persisters\Entity\EntityPersister::executeInserts() is deprecated and will not be supported in Doctrine ORM 3.0. Make the persister call Doctrine\ORM\UnitOfWork::assignPostInsertId() instead.'
  998.                 );
  999.                 // Persister returned post-insert IDs
  1000.                 foreach ($postInsertIds as $postInsertId) {
  1001.                     $this->assignPostInsertId($postInsertId['entity'], $postInsertId['generatedId']);
  1002.                 }
  1003.             }
  1004.             if (! isset($this->entityIdentifiers[$oid])) {
  1005.                 //entity was not added to identity map because some identifiers are foreign keys to new entities.
  1006.                 //add it now
  1007.                 $this->addToEntityIdentifiersAndEntityMap($class$oid$entity);
  1008.             }
  1009.             $invoke $this->listenersInvoker->getSubscribedSystems($classEvents::postPersist);
  1010.             if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1011.                 $eventsToDispatch[] = ['class' => $class'entity' => $entity'invoke' => $invoke];
  1012.             }
  1013.         }
  1014.         // Defer dispatching `postPersist` events to until all entities have been inserted and post-insert
  1015.         // IDs have been assigned.
  1016.         foreach ($eventsToDispatch as $event) {
  1017.             $this->listenersInvoker->invoke(
  1018.                 $event['class'],
  1019.                 Events::postPersist,
  1020.                 $event['entity'],
  1021.                 new PostPersistEventArgs($event['entity'], $this->em),
  1022.                 $event['invoke']
  1023.             );
  1024.         }
  1025.     }
  1026.     /**
  1027.      * @param object $entity
  1028.      * @psalm-param ClassMetadata<T> $class
  1029.      * @psalm-param T $entity
  1030.      *
  1031.      * @template T of object
  1032.      */
  1033.     private function addToEntityIdentifiersAndEntityMap(
  1034.         ClassMetadata $class,
  1035.         int $oid,
  1036.         $entity
  1037.     ): void {
  1038.         $identifier = [];
  1039.         foreach ($class->getIdentifierFieldNames() as $idField) {
  1040.             $origValue $class->getFieldValue($entity$idField);
  1041.             $value null;
  1042.             if (isset($class->associationMappings[$idField])) {
  1043.                 // NOTE: Single Columns as associated identifiers only allowed - this constraint it is enforced.
  1044.                 $value $this->getSingleIdentifierValue($origValue);
  1045.             }
  1046.             $identifier[$idField]                     = $value ?? $origValue;
  1047.             $this->originalEntityData[$oid][$idField] = $origValue;
  1048.         }
  1049.         $this->entityStates[$oid]      = self::STATE_MANAGED;
  1050.         $this->entityIdentifiers[$oid] = $identifier;
  1051.         $this->addToIdentityMap($entity);
  1052.     }
  1053.     /**
  1054.      * Executes all entity updates
  1055.      */
  1056.     private function executeUpdates(): void
  1057.     {
  1058.         foreach ($this->entityUpdates as $oid => $entity) {
  1059.             $class            $this->em->getClassMetadata(get_class($entity));
  1060.             $persister        $this->getEntityPersister($class->name);
  1061.             $preUpdateInvoke  $this->listenersInvoker->getSubscribedSystems($classEvents::preUpdate);
  1062.             $postUpdateInvoke $this->listenersInvoker->getSubscribedSystems($classEvents::postUpdate);
  1063.             if ($preUpdateInvoke !== ListenersInvoker::INVOKE_NONE) {
  1064.                 $this->listenersInvoker->invoke($classEvents::preUpdate$entity, new PreUpdateEventArgs($entity$this->em$this->getEntityChangeSet($entity)), $preUpdateInvoke);
  1065.                 $this->recomputeSingleEntityChangeSet($class$entity);
  1066.             }
  1067.             if (! empty($this->entityChangeSets[$oid])) {
  1068.                 $persister->update($entity);
  1069.             }
  1070.             unset($this->entityUpdates[$oid]);
  1071.             if ($postUpdateInvoke !== ListenersInvoker::INVOKE_NONE) {
  1072.                 $this->listenersInvoker->invoke($classEvents::postUpdate$entity, new PostUpdateEventArgs($entity$this->em), $postUpdateInvoke);
  1073.             }
  1074.         }
  1075.     }
  1076.     /**
  1077.      * Executes all entity deletions
  1078.      */
  1079.     private function executeDeletions(): void
  1080.     {
  1081.         $entities         $this->computeDeleteExecutionOrder();
  1082.         $eventsToDispatch = [];
  1083.         foreach ($entities as $entity) {
  1084.             $oid       spl_object_id($entity);
  1085.             $class     $this->em->getClassMetadata(get_class($entity));
  1086.             $persister $this->getEntityPersister($class->name);
  1087.             $invoke    $this->listenersInvoker->getSubscribedSystems($classEvents::postRemove);
  1088.             $persister->delete($entity);
  1089.             unset(
  1090.                 $this->entityDeletions[$oid],
  1091.                 $this->entityIdentifiers[$oid],
  1092.                 $this->originalEntityData[$oid],
  1093.                 $this->entityStates[$oid]
  1094.             );
  1095.             // Entity with this $oid after deletion treated as NEW, even if the $oid
  1096.             // is obtained by a new entity because the old one went out of scope.
  1097.             //$this->entityStates[$oid] = self::STATE_NEW;
  1098.             if (! $class->isIdentifierNatural()) {
  1099.                 $class->reflFields[$class->identifier[0]]->setValue($entitynull);
  1100.             }
  1101.             if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1102.                 $eventsToDispatch[] = ['class' => $class'entity' => $entity'invoke' => $invoke];
  1103.             }
  1104.         }
  1105.         // Defer dispatching `postRemove` events to until all entities have been removed.
  1106.         foreach ($eventsToDispatch as $event) {
  1107.             $this->listenersInvoker->invoke(
  1108.                 $event['class'],
  1109.                 Events::postRemove,
  1110.                 $event['entity'],
  1111.                 new PostRemoveEventArgs($event['entity'], $this->em),
  1112.                 $event['invoke']
  1113.             );
  1114.         }
  1115.     }
  1116.     /** @return list<object> */
  1117.     private function computeInsertExecutionOrder(): array
  1118.     {
  1119.         $sort = new TopologicalSort();
  1120.         // First make sure we have all the nodes
  1121.         foreach ($this->entityInsertions as $entity) {
  1122.             $sort->addNode($entity);
  1123.         }
  1124.         // Now add edges
  1125.         foreach ($this->entityInsertions as $entity) {
  1126.             $class $this->em->getClassMetadata(get_class($entity));
  1127.             foreach ($class->associationMappings as $assoc) {
  1128.                 // We only need to consider the owning sides of to-one associations,
  1129.                 // since many-to-many associations are persisted at a later step and
  1130.                 // have no insertion order problems (all entities already in the database
  1131.                 // at that time).
  1132.                 if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1133.                     continue;
  1134.                 }
  1135.                 $targetEntity $class->getFieldValue($entity$assoc['fieldName']);
  1136.                 // If there is no entity that we need to refer to, or it is already in the
  1137.                 // database (i. e. does not have to be inserted), no need to consider it.
  1138.                 if ($targetEntity === null || ! $sort->hasNode($targetEntity)) {
  1139.                     continue;
  1140.                 }
  1141.                 // An entity that references back to itself _and_ uses an application-provided ID
  1142.                 // (the "NONE" generator strategy) can be exempted from commit order computation.
  1143.                 // See https://github.com/doctrine/orm/pull/10735/ for more details on this edge case.
  1144.                 // A non-NULLable self-reference would be a cycle in the graph.
  1145.                 if ($targetEntity === $entity && $class->isIdentifierNatural()) {
  1146.                     continue;
  1147.                 }
  1148.                 // According to https://www.doctrine-project.org/projects/doctrine-orm/en/2.14/reference/annotations-reference.html#annref_joincolumn,
  1149.                 // the default for "nullable" is true. Unfortunately, it seems this default is not applied at the metadata driver, factory or other
  1150.                 // level, but in fact we may have an undefined 'nullable' key here, so we must assume that default here as well.
  1151.                 //
  1152.                 // Same in \Doctrine\ORM\Tools\EntityGenerator::isAssociationIsNullable or \Doctrine\ORM\Persisters\Entity\BasicEntityPersister::getJoinSQLForJoinColumns,
  1153.                 // to give two examples.
  1154.                 assert(isset($assoc['joinColumns']));
  1155.                 $joinColumns reset($assoc['joinColumns']);
  1156.                 $isNullable  = ! isset($joinColumns['nullable']) || $joinColumns['nullable'];
  1157.                 // Add dependency. The dependency direction implies that "$targetEntity has to go before $entity",
  1158.                 // so we can work through the topo sort result from left to right (with all edges pointing right).
  1159.                 $sort->addEdge($targetEntity$entity$isNullable);
  1160.             }
  1161.         }
  1162.         return $sort->sort();
  1163.     }
  1164.     /** @return list<object> */
  1165.     private function computeDeleteExecutionOrder(): array
  1166.     {
  1167.         $sort = new TopologicalSort();
  1168.         // First make sure we have all the nodes
  1169.         foreach ($this->entityDeletions as $entity) {
  1170.             $sort->addNode($entity);
  1171.         }
  1172.         // Now add edges
  1173.         foreach ($this->entityDeletions as $entity) {
  1174.             $class $this->em->getClassMetadata(get_class($entity));
  1175.             foreach ($class->associationMappings as $assoc) {
  1176.                 // We only need to consider the owning sides of to-one associations,
  1177.                 // since many-to-many associations can always be (and have already been)
  1178.                 // deleted in a preceding step.
  1179.                 if (! ($assoc['isOwningSide'] && $assoc['type'] & ClassMetadata::TO_ONE)) {
  1180.                     continue;
  1181.                 }
  1182.                 // For associations that implement a database-level cascade/set null operation,
  1183.                 // we do not have to follow a particular order: If the referred-to entity is
  1184.                 // deleted first, the DBMS will either delete the current $entity right away
  1185.                 // (CASCADE) or temporarily set the foreign key to NULL (SET NULL).
  1186.                 // Either way, we can skip it in the computation.
  1187.                 assert(isset($assoc['joinColumns']));
  1188.                 $joinColumns reset($assoc['joinColumns']);
  1189.                 if (isset($joinColumns['onDelete'])) {
  1190.                     $onDeleteOption strtolower($joinColumns['onDelete']);
  1191.                     if ($onDeleteOption === 'cascade' || $onDeleteOption === 'set null') {
  1192.                         continue;
  1193.                     }
  1194.                 }
  1195.                 $targetEntity $class->getFieldValue($entity$assoc['fieldName']);
  1196.                 // If the association does not refer to another entity or that entity
  1197.                 // is not to be deleted, there is no ordering problem and we can
  1198.                 // skip this particular association.
  1199.                 if ($targetEntity === null || ! $sort->hasNode($targetEntity)) {
  1200.                     continue;
  1201.                 }
  1202.                 // Add dependency. The dependency direction implies that "$entity has to be removed before $targetEntity",
  1203.                 // so we can work through the topo sort result from left to right (with all edges pointing right).
  1204.                 $sort->addEdge($entity$targetEntityfalse);
  1205.             }
  1206.         }
  1207.         return $sort->sort();
  1208.     }
  1209.     /**
  1210.      * Schedules an entity for insertion into the database.
  1211.      * If the entity already has an identifier, it will be added to the identity map.
  1212.      *
  1213.      * @param object $entity The entity to schedule for insertion.
  1214.      *
  1215.      * @return void
  1216.      *
  1217.      * @throws ORMInvalidArgumentException
  1218.      * @throws InvalidArgumentException
  1219.      */
  1220.     public function scheduleForInsert($entity)
  1221.     {
  1222.         $oid spl_object_id($entity);
  1223.         if (isset($this->entityUpdates[$oid])) {
  1224.             throw new InvalidArgumentException('Dirty entity can not be scheduled for insertion.');
  1225.         }
  1226.         if (isset($this->entityDeletions[$oid])) {
  1227.             throw ORMInvalidArgumentException::scheduleInsertForRemovedEntity($entity);
  1228.         }
  1229.         if (isset($this->originalEntityData[$oid]) && ! isset($this->entityInsertions[$oid])) {
  1230.             throw ORMInvalidArgumentException::scheduleInsertForManagedEntity($entity);
  1231.         }
  1232.         if (isset($this->entityInsertions[$oid])) {
  1233.             throw ORMInvalidArgumentException::scheduleInsertTwice($entity);
  1234.         }
  1235.         $this->entityInsertions[$oid] = $entity;
  1236.         if (isset($this->entityIdentifiers[$oid])) {
  1237.             $this->addToIdentityMap($entity);
  1238.         }
  1239.         if ($entity instanceof NotifyPropertyChanged) {
  1240.             $entity->addPropertyChangedListener($this);
  1241.         }
  1242.     }
  1243.     /**
  1244.      * Checks whether an entity is scheduled for insertion.
  1245.      *
  1246.      * @param object $entity
  1247.      *
  1248.      * @return bool
  1249.      */
  1250.     public function isScheduledForInsert($entity)
  1251.     {
  1252.         return isset($this->entityInsertions[spl_object_id($entity)]);
  1253.     }
  1254.     /**
  1255.      * Schedules an entity for being updated.
  1256.      *
  1257.      * @param object $entity The entity to schedule for being updated.
  1258.      *
  1259.      * @return void
  1260.      *
  1261.      * @throws ORMInvalidArgumentException
  1262.      */
  1263.     public function scheduleForUpdate($entity)
  1264.     {
  1265.         $oid spl_object_id($entity);
  1266.         if (! isset($this->entityIdentifiers[$oid])) {
  1267.             throw ORMInvalidArgumentException::entityHasNoIdentity($entity'scheduling for update');
  1268.         }
  1269.         if (isset($this->entityDeletions[$oid])) {
  1270.             throw ORMInvalidArgumentException::entityIsRemoved($entity'schedule for update');
  1271.         }
  1272.         if (! isset($this->entityUpdates[$oid]) && ! isset($this->entityInsertions[$oid])) {
  1273.             $this->entityUpdates[$oid] = $entity;
  1274.         }
  1275.     }
  1276.     /**
  1277.      * INTERNAL:
  1278.      * Schedules an extra update that will be executed immediately after the
  1279.      * regular entity updates within the currently running commit cycle.
  1280.      *
  1281.      * Extra updates for entities are stored as (entity, changeset) tuples.
  1282.      *
  1283.      * @param object $entity The entity for which to schedule an extra update.
  1284.      * @psalm-param array<string, array{mixed, mixed}>  $changeset The changeset of the entity (what to update).
  1285.      *
  1286.      * @return void
  1287.      *
  1288.      * @ignore
  1289.      */
  1290.     public function scheduleExtraUpdate($entity, array $changeset)
  1291.     {
  1292.         $oid         spl_object_id($entity);
  1293.         $extraUpdate = [$entity$changeset];
  1294.         if (isset($this->extraUpdates[$oid])) {
  1295.             [, $changeset2] = $this->extraUpdates[$oid];
  1296.             $extraUpdate = [$entity$changeset $changeset2];
  1297.         }
  1298.         $this->extraUpdates[$oid] = $extraUpdate;
  1299.     }
  1300.     /**
  1301.      * Checks whether an entity is registered as dirty in the unit of work.
  1302.      * Note: Is not very useful currently as dirty entities are only registered
  1303.      * at commit time.
  1304.      *
  1305.      * @param object $entity
  1306.      *
  1307.      * @return bool
  1308.      */
  1309.     public function isScheduledForUpdate($entity)
  1310.     {
  1311.         return isset($this->entityUpdates[spl_object_id($entity)]);
  1312.     }
  1313.     /**
  1314.      * Checks whether an entity is registered to be checked in the unit of work.
  1315.      *
  1316.      * @param object $entity
  1317.      *
  1318.      * @return bool
  1319.      */
  1320.     public function isScheduledForDirtyCheck($entity)
  1321.     {
  1322.         $rootEntityName $this->em->getClassMetadata(get_class($entity))->rootEntityName;
  1323.         return isset($this->scheduledForSynchronization[$rootEntityName][spl_object_id($entity)]);
  1324.     }
  1325.     /**
  1326.      * INTERNAL:
  1327.      * Schedules an entity for deletion.
  1328.      *
  1329.      * @param object $entity
  1330.      *
  1331.      * @return void
  1332.      */
  1333.     public function scheduleForDelete($entity)
  1334.     {
  1335.         $oid spl_object_id($entity);
  1336.         if (isset($this->entityInsertions[$oid])) {
  1337.             if ($this->isInIdentityMap($entity)) {
  1338.                 $this->removeFromIdentityMap($entity);
  1339.             }
  1340.             unset($this->entityInsertions[$oid], $this->entityStates[$oid]);
  1341.             return; // entity has not been persisted yet, so nothing more to do.
  1342.         }
  1343.         if (! $this->isInIdentityMap($entity)) {
  1344.             return;
  1345.         }
  1346.         $this->removeFromIdentityMap($entity);
  1347.         unset($this->entityUpdates[$oid]);
  1348.         if (! isset($this->entityDeletions[$oid])) {
  1349.             $this->entityDeletions[$oid] = $entity;
  1350.             $this->entityStates[$oid]    = self::STATE_REMOVED;
  1351.         }
  1352.     }
  1353.     /**
  1354.      * Checks whether an entity is registered as removed/deleted with the unit
  1355.      * of work.
  1356.      *
  1357.      * @param object $entity
  1358.      *
  1359.      * @return bool
  1360.      */
  1361.     public function isScheduledForDelete($entity)
  1362.     {
  1363.         return isset($this->entityDeletions[spl_object_id($entity)]);
  1364.     }
  1365.     /**
  1366.      * Checks whether an entity is scheduled for insertion, update or deletion.
  1367.      *
  1368.      * @param object $entity
  1369.      *
  1370.      * @return bool
  1371.      */
  1372.     public function isEntityScheduled($entity)
  1373.     {
  1374.         $oid spl_object_id($entity);
  1375.         return isset($this->entityInsertions[$oid])
  1376.             || isset($this->entityUpdates[$oid])
  1377.             || isset($this->entityDeletions[$oid]);
  1378.     }
  1379.     /**
  1380.      * INTERNAL:
  1381.      * Registers an entity in the identity map.
  1382.      * Note that entities in a hierarchy are registered with the class name of
  1383.      * the root entity.
  1384.      *
  1385.      * @param object $entity The entity to register.
  1386.      *
  1387.      * @return bool TRUE if the registration was successful, FALSE if the identity of
  1388.      * the entity in question is already managed.
  1389.      *
  1390.      * @throws ORMInvalidArgumentException
  1391.      * @throws EntityIdentityCollisionException
  1392.      *
  1393.      * @ignore
  1394.      */
  1395.     public function addToIdentityMap($entity)
  1396.     {
  1397.         $classMetadata $this->em->getClassMetadata(get_class($entity));
  1398.         $idHash        $this->getIdHashByEntity($entity);
  1399.         $className     $classMetadata->rootEntityName;
  1400.         if (isset($this->identityMap[$className][$idHash])) {
  1401.             if ($this->identityMap[$className][$idHash] !== $entity) {
  1402.                 if ($this->em->getConfiguration()->isRejectIdCollisionInIdentityMapEnabled()) {
  1403.                     throw EntityIdentityCollisionException::create($this->identityMap[$className][$idHash], $entity$idHash);
  1404.                 }
  1405.                 Deprecation::trigger(
  1406.                     'doctrine/orm',
  1407.                     'https://github.com/doctrine/orm/pull/10785',
  1408.                     <<<'EXCEPTION'
  1409. While adding an entity of class %s with an ID hash of "%s" to the identity map,
  1410. another object of class %s was already present for the same ID. This will trigger
  1411. an exception in ORM 3.0.
  1412. IDs should uniquely map to entity object instances. This problem may occur if:
  1413. - you use application-provided IDs and reuse ID values;
  1414. - database-provided IDs are reassigned after truncating the database without
  1415. clearing the EntityManager;
  1416. - you might have been using EntityManager#getReference() to create a reference
  1417. for a nonexistent ID that was subsequently (by the RDBMS) assigned to another
  1418. entity. 
  1419. Otherwise, it might be an ORM-internal inconsistency, please report it.
  1420. To opt-in to the new exception, call 
  1421. \Doctrine\ORM\Configuration::setRejectIdCollisionInIdentityMap on the entity
  1422. manager's configuration.
  1423. EXCEPTION
  1424.                     ,
  1425.                     get_class($entity),
  1426.                     $idHash,
  1427.                     get_class($this->identityMap[$className][$idHash])
  1428.                 );
  1429.             }
  1430.             return false;
  1431.         }
  1432.         $this->identityMap[$className][$idHash] = $entity;
  1433.         return true;
  1434.     }
  1435.     /**
  1436.      * Gets the id hash of an entity by its identifier.
  1437.      *
  1438.      * @param array<string|int, mixed> $identifier The identifier of an entity
  1439.      *
  1440.      * @return string The entity id hash.
  1441.      */
  1442.     final public static function getIdHashByIdentifier(array $identifier): string
  1443.     {
  1444.         return implode(
  1445.             ' ',
  1446.             array_map(
  1447.                 static function ($value) {
  1448.                     if ($value instanceof BackedEnum) {
  1449.                         return $value->value;
  1450.                     }
  1451.                     return $value;
  1452.                 },
  1453.                 $identifier
  1454.             )
  1455.         );
  1456.     }
  1457.     /**
  1458.      * Gets the id hash of an entity.
  1459.      *
  1460.      * @param object $entity The entity managed by Unit Of Work
  1461.      *
  1462.      * @return string The entity id hash.
  1463.      */
  1464.     public function getIdHashByEntity($entity): string
  1465.     {
  1466.         $identifier $this->entityIdentifiers[spl_object_id($entity)];
  1467.         if (empty($identifier) || in_array(null$identifiertrue)) {
  1468.             $classMetadata $this->em->getClassMetadata(get_class($entity));
  1469.             throw ORMInvalidArgumentException::entityWithoutIdentity($classMetadata->name$entity);
  1470.         }
  1471.         return self::getIdHashByIdentifier($identifier);
  1472.     }
  1473.     /**
  1474.      * Gets the state of an entity with regard to the current unit of work.
  1475.      *
  1476.      * @param object   $entity
  1477.      * @param int|null $assume The state to assume if the state is not yet known (not MANAGED or REMOVED).
  1478.      *                         This parameter can be set to improve performance of entity state detection
  1479.      *                         by potentially avoiding a database lookup if the distinction between NEW and DETACHED
  1480.      *                         is either known or does not matter for the caller of the method.
  1481.      * @psalm-param self::STATE_*|null $assume
  1482.      *
  1483.      * @return int The entity state.
  1484.      * @psalm-return self::STATE_*
  1485.      */
  1486.     public function getEntityState($entity$assume null)
  1487.     {
  1488.         $oid spl_object_id($entity);
  1489.         if (isset($this->entityStates[$oid])) {
  1490.             return $this->entityStates[$oid];
  1491.         }
  1492.         if ($assume !== null) {
  1493.             return $assume;
  1494.         }
  1495.         // State can only be NEW or DETACHED, because MANAGED/REMOVED states are known.
  1496.         // Note that you can not remember the NEW or DETACHED state in _entityStates since
  1497.         // the UoW does not hold references to such objects and the object hash can be reused.
  1498.         // More generally because the state may "change" between NEW/DETACHED without the UoW being aware of it.
  1499.         $class $this->em->getClassMetadata(get_class($entity));
  1500.         $id    $class->getIdentifierValues($entity);
  1501.         if (! $id) {
  1502.             return self::STATE_NEW;
  1503.         }
  1504.         if ($class->containsForeignIdentifier || $class->containsEnumIdentifier) {
  1505.             $id $this->identifierFlattener->flattenIdentifier($class$id);
  1506.         }
  1507.         switch (true) {
  1508.             case $class->isIdentifierNatural():
  1509.                 // Check for a version field, if available, to avoid a db lookup.
  1510.                 if ($class->isVersioned) {
  1511.                     assert($class->versionField !== null);
  1512.                     return $class->getFieldValue($entity$class->versionField)
  1513.                         ? self::STATE_DETACHED
  1514.                         self::STATE_NEW;
  1515.                 }
  1516.                 // Last try before db lookup: check the identity map.
  1517.                 if ($this->tryGetById($id$class->rootEntityName)) {
  1518.                     return self::STATE_DETACHED;
  1519.                 }
  1520.                 // db lookup
  1521.                 if ($this->getEntityPersister($class->name)->exists($entity)) {
  1522.                     return self::STATE_DETACHED;
  1523.                 }
  1524.                 return self::STATE_NEW;
  1525.             case ! $class->idGenerator->isPostInsertGenerator():
  1526.                 // if we have a pre insert generator we can't be sure that having an id
  1527.                 // really means that the entity exists. We have to verify this through
  1528.                 // the last resort: a db lookup
  1529.                 // Last try before db lookup: check the identity map.
  1530.                 if ($this->tryGetById($id$class->rootEntityName)) {
  1531.                     return self::STATE_DETACHED;
  1532.                 }
  1533.                 // db lookup
  1534.                 if ($this->getEntityPersister($class->name)->exists($entity)) {
  1535.                     return self::STATE_DETACHED;
  1536.                 }
  1537.                 return self::STATE_NEW;
  1538.             default:
  1539.                 return self::STATE_DETACHED;
  1540.         }
  1541.     }
  1542.     /**
  1543.      * INTERNAL:
  1544.      * Removes an entity from the identity map. This effectively detaches the
  1545.      * entity from the persistence management of Doctrine.
  1546.      *
  1547.      * @param object $entity
  1548.      *
  1549.      * @return bool
  1550.      *
  1551.      * @throws ORMInvalidArgumentException
  1552.      *
  1553.      * @ignore
  1554.      */
  1555.     public function removeFromIdentityMap($entity)
  1556.     {
  1557.         $oid           spl_object_id($entity);
  1558.         $classMetadata $this->em->getClassMetadata(get_class($entity));
  1559.         $idHash        self::getIdHashByIdentifier($this->entityIdentifiers[$oid]);
  1560.         if ($idHash === '') {
  1561.             throw ORMInvalidArgumentException::entityHasNoIdentity($entity'remove from identity map');
  1562.         }
  1563.         $className $classMetadata->rootEntityName;
  1564.         if (isset($this->identityMap[$className][$idHash])) {
  1565.             unset($this->identityMap[$className][$idHash], $this->readOnlyObjects[$oid]);
  1566.             //$this->entityStates[$oid] = self::STATE_DETACHED;
  1567.             return true;
  1568.         }
  1569.         return false;
  1570.     }
  1571.     /**
  1572.      * INTERNAL:
  1573.      * Gets an entity in the identity map by its identifier hash.
  1574.      *
  1575.      * @param string $idHash
  1576.      * @param string $rootClassName
  1577.      *
  1578.      * @return object
  1579.      *
  1580.      * @ignore
  1581.      */
  1582.     public function getByIdHash($idHash$rootClassName)
  1583.     {
  1584.         return $this->identityMap[$rootClassName][$idHash];
  1585.     }
  1586.     /**
  1587.      * INTERNAL:
  1588.      * Tries to get an entity by its identifier hash. If no entity is found for
  1589.      * the given hash, FALSE is returned.
  1590.      *
  1591.      * @param mixed  $idHash        (must be possible to cast it to string)
  1592.      * @param string $rootClassName
  1593.      *
  1594.      * @return false|object The found entity or FALSE.
  1595.      *
  1596.      * @ignore
  1597.      */
  1598.     public function tryGetByIdHash($idHash$rootClassName)
  1599.     {
  1600.         $stringIdHash = (string) $idHash;
  1601.         return $this->identityMap[$rootClassName][$stringIdHash] ?? false;
  1602.     }
  1603.     /**
  1604.      * Checks whether an entity is registered in the identity map of this UnitOfWork.
  1605.      *
  1606.      * @param object $entity
  1607.      *
  1608.      * @return bool
  1609.      */
  1610.     public function isInIdentityMap($entity)
  1611.     {
  1612.         $oid spl_object_id($entity);
  1613.         if (empty($this->entityIdentifiers[$oid])) {
  1614.             return false;
  1615.         }
  1616.         $classMetadata $this->em->getClassMetadata(get_class($entity));
  1617.         $idHash        self::getIdHashByIdentifier($this->entityIdentifiers[$oid]);
  1618.         return isset($this->identityMap[$classMetadata->rootEntityName][$idHash]);
  1619.     }
  1620.     /**
  1621.      * INTERNAL:
  1622.      * Checks whether an identifier hash exists in the identity map.
  1623.      *
  1624.      * @param string $idHash
  1625.      * @param string $rootClassName
  1626.      *
  1627.      * @return bool
  1628.      *
  1629.      * @ignore
  1630.      */
  1631.     public function containsIdHash($idHash$rootClassName)
  1632.     {
  1633.         return isset($this->identityMap[$rootClassName][$idHash]);
  1634.     }
  1635.     /**
  1636.      * Persists an entity as part of the current unit of work.
  1637.      *
  1638.      * @param object $entity The entity to persist.
  1639.      *
  1640.      * @return void
  1641.      */
  1642.     public function persist($entity)
  1643.     {
  1644.         $visited = [];
  1645.         $this->doPersist($entity$visited);
  1646.     }
  1647.     /**
  1648.      * Persists an entity as part of the current unit of work.
  1649.      *
  1650.      * This method is internally called during persist() cascades as it tracks
  1651.      * the already visited entities to prevent infinite recursions.
  1652.      *
  1653.      * @param object $entity The entity to persist.
  1654.      * @psalm-param array<int, object> $visited The already visited entities.
  1655.      *
  1656.      * @throws ORMInvalidArgumentException
  1657.      * @throws UnexpectedValueException
  1658.      */
  1659.     private function doPersist($entity, array &$visited): void
  1660.     {
  1661.         $oid spl_object_id($entity);
  1662.         if (isset($visited[$oid])) {
  1663.             return; // Prevent infinite recursion
  1664.         }
  1665.         $visited[$oid] = $entity// Mark visited
  1666.         $class $this->em->getClassMetadata(get_class($entity));
  1667.         // We assume NEW, so DETACHED entities result in an exception on flush (constraint violation).
  1668.         // If we would detect DETACHED here we would throw an exception anyway with the same
  1669.         // consequences (not recoverable/programming error), so just assuming NEW here
  1670.         // lets us avoid some database lookups for entities with natural identifiers.
  1671.         $entityState $this->getEntityState($entityself::STATE_NEW);
  1672.         switch ($entityState) {
  1673.             case self::STATE_MANAGED:
  1674.                 // Nothing to do, except if policy is "deferred explicit"
  1675.                 if ($class->isChangeTrackingDeferredExplicit()) {
  1676.                     $this->scheduleForDirtyCheck($entity);
  1677.                 }
  1678.                 break;
  1679.             case self::STATE_NEW:
  1680.                 $this->persistNew($class$entity);
  1681.                 break;
  1682.             case self::STATE_REMOVED:
  1683.                 // Entity becomes managed again
  1684.                 unset($this->entityDeletions[$oid]);
  1685.                 $this->addToIdentityMap($entity);
  1686.                 $this->entityStates[$oid] = self::STATE_MANAGED;
  1687.                 if ($class->isChangeTrackingDeferredExplicit()) {
  1688.                     $this->scheduleForDirtyCheck($entity);
  1689.                 }
  1690.                 break;
  1691.             case self::STATE_DETACHED:
  1692.                 // Can actually not happen right now since we assume STATE_NEW.
  1693.                 throw ORMInvalidArgumentException::detachedEntityCannot($entity'persisted');
  1694.             default:
  1695.                 throw new UnexpectedValueException(sprintf(
  1696.                     'Unexpected entity state: %s. %s',
  1697.                     $entityState,
  1698.                     self::objToStr($entity)
  1699.                 ));
  1700.         }
  1701.         $this->cascadePersist($entity$visited);
  1702.     }
  1703.     /**
  1704.      * Deletes an entity as part of the current unit of work.
  1705.      *
  1706.      * @param object $entity The entity to remove.
  1707.      *
  1708.      * @return void
  1709.      */
  1710.     public function remove($entity)
  1711.     {
  1712.         $visited = [];
  1713.         $this->doRemove($entity$visited);
  1714.     }
  1715.     /**
  1716.      * Deletes an entity as part of the current unit of work.
  1717.      *
  1718.      * This method is internally called during delete() cascades as it tracks
  1719.      * the already visited entities to prevent infinite recursions.
  1720.      *
  1721.      * @param object $entity The entity to delete.
  1722.      * @psalm-param array<int, object> $visited The map of the already visited entities.
  1723.      *
  1724.      * @throws ORMInvalidArgumentException If the instance is a detached entity.
  1725.      * @throws UnexpectedValueException
  1726.      */
  1727.     private function doRemove($entity, array &$visited): void
  1728.     {
  1729.         $oid spl_object_id($entity);
  1730.         if (isset($visited[$oid])) {
  1731.             return; // Prevent infinite recursion
  1732.         }
  1733.         $visited[$oid] = $entity// mark visited
  1734.         // Cascade first, because scheduleForDelete() removes the entity from the identity map, which
  1735.         // can cause problems when a lazy proxy has to be initialized for the cascade operation.
  1736.         $this->cascadeRemove($entity$visited);
  1737.         $class       $this->em->getClassMetadata(get_class($entity));
  1738.         $entityState $this->getEntityState($entity);
  1739.         switch ($entityState) {
  1740.             case self::STATE_NEW:
  1741.             case self::STATE_REMOVED:
  1742.                 // nothing to do
  1743.                 break;
  1744.             case self::STATE_MANAGED:
  1745.                 $invoke $this->listenersInvoker->getSubscribedSystems($classEvents::preRemove);
  1746.                 if ($invoke !== ListenersInvoker::INVOKE_NONE) {
  1747.                     $this->listenersInvoker->invoke($classEvents::preRemove$entity, new PreRemoveEventArgs($entity$this->em), $invoke);
  1748.                 }
  1749.                 $this->scheduleForDelete($entity);
  1750.                 break;
  1751.             case self::STATE_DETACHED:
  1752.                 throw ORMInvalidArgumentException::detachedEntityCannot($entity'removed');
  1753.             default:
  1754.                 throw new UnexpectedValueException(sprintf(
  1755.                     'Unexpected entity state: %s. %s',
  1756.                     $entityState,
  1757.                     self::objToStr($entity)
  1758.                 ));
  1759.         }
  1760.     }
  1761.     /**
  1762.      * Merges the state of the given detached entity into this UnitOfWork.
  1763.      *
  1764.      * @deprecated 2.7 This method is being removed from the ORM and won't have any replacement
  1765.      *
  1766.      * @param object $entity
  1767.      *
  1768.      * @return object The managed copy of the entity.
  1769.      *
  1770.      * @throws OptimisticLockException If the entity uses optimistic locking through a version
  1771.      *         attribute and the version check against the managed copy fails.
  1772.      */
  1773.     public function merge($entity)
  1774.     {
  1775.         $visited = [];
  1776.         return $this->doMerge($entity$visited);
  1777.     }
  1778.     /**
  1779.      * Executes a merge operation on an entity.
  1780.      *
  1781.      * @param object $entity
  1782.      * @psalm-param AssociationMapping|null $assoc
  1783.      * @psalm-param array<int, object> $visited
  1784.      *
  1785.      * @return object The managed copy of the entity.
  1786.      *
  1787.      * @throws OptimisticLockException If the entity uses optimistic locking through a version
  1788.      *         attribute and the version check against the managed copy fails.
  1789.      * @throws ORMInvalidArgumentException If the entity instance is NEW.
  1790.      * @throws EntityNotFoundException if an assigned identifier is used in the entity, but none is provided.
  1791.      */
  1792.     private function doMerge(
  1793.         $entity,
  1794.         array &$visited,
  1795.         $prevManagedCopy null,
  1796.         ?array $assoc null
  1797.     ) {
  1798.         $oid spl_object_id($entity);
  1799.         if (isset($visited[$oid])) {
  1800.             $managedCopy $visited[$oid];
  1801.             if ($prevManagedCopy !== null) {
  1802.                 $this->updateAssociationWithMergedEntity($entity$assoc$prevManagedCopy$managedCopy);
  1803.             }
  1804.             return $managedCopy;
  1805.         }
  1806.         $class $this->em->getClassMetadata(get_class($entity));
  1807.         // First we assume DETACHED, although it can still be NEW but we can avoid
  1808.         // an extra db-roundtrip this way. If it is not MANAGED but has an identity,
  1809.         // we need to fetch it from the db anyway in order to merge.
  1810.         // MANAGED entities are ignored by the merge operation.
  1811.         $managedCopy $entity;
  1812.         if ($this->getEntityState($entityself::STATE_DETACHED) !== self::STATE_MANAGED) {
  1813.             // Try to look the entity up in the identity map.
  1814.             $id $class->getIdentifierValues($entity);
  1815.             // If there is no ID, it is actually NEW.
  1816.             if (! $id) {
  1817.                 $managedCopy $this->newInstance($class);
  1818.                 $this->mergeEntityStateIntoManagedCopy($entity$managedCopy);
  1819.                 $this->persistNew($class$managedCopy);
  1820.             } else {
  1821.                 $flatId $class->containsForeignIdentifier || $class->containsEnumIdentifier
  1822.                     $this->identifierFlattener->flattenIdentifier($class$id)
  1823.                     : $id;
  1824.                 $managedCopy $this->tryGetById($flatId$class->rootEntityName);
  1825.                 if ($managedCopy) {
  1826.                     // We have the entity in-memory already, just make sure its not removed.
  1827.                     if ($this->getEntityState($managedCopy) === self::STATE_REMOVED) {
  1828.                         throw ORMInvalidArgumentException::entityIsRemoved($managedCopy'merge');
  1829.                     }
  1830.                 } else {
  1831.                     // We need to fetch the managed copy in order to merge.
  1832.                     $managedCopy $this->em->find($class->name$flatId);
  1833.                 }
  1834.                 if ($managedCopy === null) {
  1835.                     // If the identifier is ASSIGNED, it is NEW, otherwise an error
  1836.                     // since the managed entity was not found.
  1837.                     if (! $class->isIdentifierNatural()) {
  1838.                         throw EntityNotFoundException::fromClassNameAndIdentifier(
  1839.                             $class->getName(),
  1840.                             $this->identifierFlattener->flattenIdentifier($class$id)
  1841.                         );
  1842.                     }
  1843.                     $managedCopy $this->newInstance($class);
  1844.                     $class->setIdentifierValues($managedCopy$id);
  1845.                     $this->mergeEntityStateIntoManagedCopy($entity$managedCopy);
  1846.                     $this->persistNew($class$managedCopy);
  1847.                 } else {
  1848.                     $this->ensureVersionMatch($class$entity$managedCopy);
  1849.                     $this->mergeEntityStateIntoManagedCopy($entity$managedCopy);
  1850.                 }
  1851.             }
  1852.             $visited[$oid] = $managedCopy// mark visited
  1853.             if ($class->isChangeTrackingDeferredExplicit()) {
  1854.                 $this->scheduleForDirtyCheck($entity);
  1855.             }
  1856.         }
  1857.         if ($prevManagedCopy !== null) {
  1858.             $this->updateAssociationWithMergedEntity($entity$assoc$prevManagedCopy$managedCopy);
  1859.         }
  1860.         // Mark the managed copy visited as well
  1861.         $visited[spl_object_id($managedCopy)] = $managedCopy;
  1862.         $this->cascadeMerge($entity$managedCopy$visited);
  1863.         return $managedCopy;
  1864.     }
  1865.     /**
  1866.      * @param object $entity
  1867.      * @param object $managedCopy
  1868.      * @psalm-param ClassMetadata<T> $class
  1869.      * @psalm-param T $entity
  1870.      * @psalm-param T $managedCopy
  1871.      *
  1872.      * @throws OptimisticLockException
  1873.      *
  1874.      * @template T of object
  1875.      */
  1876.     private function ensureVersionMatch(
  1877.         ClassMetadata $class,
  1878.         $entity,
  1879.         $managedCopy
  1880.     ): void {
  1881.         if (! ($class->isVersioned && ! $this->isUninitializedObject($managedCopy) && ! $this->isUninitializedObject($entity))) {
  1882.             return;
  1883.         }
  1884.         assert($class->versionField !== null);
  1885.         $reflField          $class->reflFields[$class->versionField];
  1886.         $managedCopyVersion $reflField->getValue($managedCopy);
  1887.         $entityVersion      $reflField->getValue($entity);
  1888.         // Throw exception if versions don't match.
  1889.         // phpcs:ignore SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedEqualOperator
  1890.         if ($managedCopyVersion == $entityVersion) {
  1891.             return;
  1892.         }
  1893.         throw OptimisticLockException::lockFailedVersionMismatch($entity$entityVersion$managedCopyVersion);
  1894.     }
  1895.     /**
  1896.      * Sets/adds associated managed copies into the previous entity's association field
  1897.      *
  1898.      * @param object $entity
  1899.      * @psalm-param AssociationMapping $association
  1900.      */
  1901.     private function updateAssociationWithMergedEntity(
  1902.         $entity,
  1903.         array $association,
  1904.         $previousManagedCopy,
  1905.         $managedCopy
  1906.     ): void {
  1907.         $assocField $association['fieldName'];
  1908.         $prevClass  $this->em->getClassMetadata(get_class($previousManagedCopy));
  1909.         if ($association['type'] & ClassMetadata::TO_ONE) {
  1910.             $prevClass->reflFields[$assocField]->setValue($previousManagedCopy$managedCopy);
  1911.             return;
  1912.         }
  1913.         $value   $prevClass->reflFields[$assocField]->getValue($previousManagedCopy);
  1914.         $value[] = $managedCopy;
  1915.         if ($association['type'] === ClassMetadata::ONE_TO_MANY) {
  1916.             $class $this->em->getClassMetadata(get_class($entity));
  1917.             $class->reflFields[$association['mappedBy']]->setValue($managedCopy$previousManagedCopy);
  1918.         }
  1919.     }
  1920.     /**
  1921.      * Detaches an entity from the persistence management. It's persistence will
  1922.      * no longer be managed by Doctrine.
  1923.      *
  1924.      * @param object $entity The entity to detach.
  1925.      *
  1926.      * @return void
  1927.      */
  1928.     public function detach($entity)
  1929.     {
  1930.         $visited = [];
  1931.         $this->doDetach($entity$visited);
  1932.     }
  1933.     /**
  1934.      * Executes a detach operation on the given entity.
  1935.      *
  1936.      * @param object  $entity
  1937.      * @param mixed[] $visited
  1938.      * @param bool    $noCascade if true, don't cascade detach operation.
  1939.      */
  1940.     private function doDetach(
  1941.         $entity,
  1942.         array &$visited,
  1943.         bool $noCascade false
  1944.     ): void {
  1945.         $oid spl_object_id($entity);
  1946.         if (isset($visited[$oid])) {
  1947.             return; // Prevent infinite recursion
  1948.         }
  1949.         $visited[$oid] = $entity// mark visited
  1950.         switch ($this->getEntityState($entityself::STATE_DETACHED)) {
  1951.             case self::STATE_MANAGED:
  1952.                 if ($this->isInIdentityMap($entity)) {
  1953.                     $this->removeFromIdentityMap($entity);
  1954.                 }
  1955.                 unset(
  1956.                     $this->entityInsertions[$oid],
  1957.                     $this->entityUpdates[$oid],
  1958.                     $this->entityDeletions[$oid],
  1959.                     $this->entityIdentifiers[$oid],
  1960.                     $this->entityStates[$oid],
  1961.                     $this->originalEntityData[$oid]
  1962.                 );
  1963.                 break;
  1964.             case self::STATE_NEW:
  1965.             case self::STATE_DETACHED:
  1966.                 return;
  1967.         }
  1968.         if (! $noCascade) {
  1969.             $this->cascadeDetach($entity$visited);
  1970.         }
  1971.     }
  1972.     /**
  1973.      * Refreshes the state of the given entity from the database, overwriting
  1974.      * any local, unpersisted changes.
  1975.      *
  1976.      * @param object $entity The entity to refresh
  1977.      *
  1978.      * @return void
  1979.      *
  1980.      * @throws InvalidArgumentException If the entity is not MANAGED.
  1981.      * @throws TransactionRequiredException
  1982.      */
  1983.     public function refresh($entity)
  1984.     {
  1985.         $visited = [];
  1986.         $lockMode null;
  1987.         if (func_num_args() > 1) {
  1988.             $lockMode func_get_arg(1);
  1989.         }
  1990.         $this->doRefresh($entity$visited$lockMode);
  1991.     }
  1992.     /**
  1993.      * Executes a refresh operation on an entity.
  1994.      *
  1995.      * @param object $entity The entity to refresh.
  1996.      * @psalm-param array<int, object>  $visited The already visited entities during cascades.
  1997.      * @psalm-param LockMode::*|null $lockMode
  1998.      *
  1999.      * @throws ORMInvalidArgumentException If the entity is not MANAGED.
  2000.      * @throws TransactionRequiredException
  2001.      */
  2002.     private function doRefresh($entity, array &$visited, ?int $lockMode null): void
  2003.     {
  2004.         switch (true) {
  2005.             case $lockMode === LockMode::PESSIMISTIC_READ:
  2006.             case $lockMode === LockMode::PESSIMISTIC_WRITE:
  2007.                 if (! $this->em->getConnection()->isTransactionActive()) {
  2008.                     throw TransactionRequiredException::transactionRequired();
  2009.                 }
  2010.         }
  2011.         $oid spl_object_id($entity);
  2012.         if (isset($visited[$oid])) {
  2013.             return; // Prevent infinite recursion
  2014.         }
  2015.         $visited[$oid] = $entity// mark visited
  2016.         $class $this->em->getClassMetadata(get_class($entity));
  2017.         if ($this->getEntityState($entity) !== self::STATE_MANAGED) {
  2018.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  2019.         }
  2020.         $this->getEntityPersister($class->name)->refresh(
  2021.             array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
  2022.             $entity,
  2023.             $lockMode
  2024.         );
  2025.         $this->cascadeRefresh($entity$visited$lockMode);
  2026.     }
  2027.     /**
  2028.      * Cascades a refresh operation to associated entities.
  2029.      *
  2030.      * @param object $entity
  2031.      * @psalm-param array<int, object> $visited
  2032.      * @psalm-param LockMode::*|null $lockMode
  2033.      */
  2034.     private function cascadeRefresh($entity, array &$visited, ?int $lockMode null): void
  2035.     {
  2036.         $class $this->em->getClassMetadata(get_class($entity));
  2037.         $associationMappings array_filter(
  2038.             $class->associationMappings,
  2039.             static function ($assoc) {
  2040.                 return $assoc['isCascadeRefresh'];
  2041.             }
  2042.         );
  2043.         foreach ($associationMappings as $assoc) {
  2044.             $relatedEntities $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2045.             switch (true) {
  2046.                 case $relatedEntities instanceof PersistentCollection:
  2047.                     // Unwrap so that foreach() does not initialize
  2048.                     $relatedEntities $relatedEntities->unwrap();
  2049.                     // break; is commented intentionally!
  2050.                 case $relatedEntities instanceof Collection:
  2051.                 case is_array($relatedEntities):
  2052.                     foreach ($relatedEntities as $relatedEntity) {
  2053.                         $this->doRefresh($relatedEntity$visited$lockMode);
  2054.                     }
  2055.                     break;
  2056.                 case $relatedEntities !== null:
  2057.                     $this->doRefresh($relatedEntities$visited$lockMode);
  2058.                     break;
  2059.                 default:
  2060.                     // Do nothing
  2061.             }
  2062.         }
  2063.     }
  2064.     /**
  2065.      * Cascades a detach operation to associated entities.
  2066.      *
  2067.      * @param object             $entity
  2068.      * @param array<int, object> $visited
  2069.      */
  2070.     private function cascadeDetach($entity, array &$visited): void
  2071.     {
  2072.         $class $this->em->getClassMetadata(get_class($entity));
  2073.         $associationMappings array_filter(
  2074.             $class->associationMappings,
  2075.             static function ($assoc) {
  2076.                 return $assoc['isCascadeDetach'];
  2077.             }
  2078.         );
  2079.         foreach ($associationMappings as $assoc) {
  2080.             $relatedEntities $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2081.             switch (true) {
  2082.                 case $relatedEntities instanceof PersistentCollection:
  2083.                     // Unwrap so that foreach() does not initialize
  2084.                     $relatedEntities $relatedEntities->unwrap();
  2085.                     // break; is commented intentionally!
  2086.                 case $relatedEntities instanceof Collection:
  2087.                 case is_array($relatedEntities):
  2088.                     foreach ($relatedEntities as $relatedEntity) {
  2089.                         $this->doDetach($relatedEntity$visited);
  2090.                     }
  2091.                     break;
  2092.                 case $relatedEntities !== null:
  2093.                     $this->doDetach($relatedEntities$visited);
  2094.                     break;
  2095.                 default:
  2096.                     // Do nothing
  2097.             }
  2098.         }
  2099.     }
  2100.     /**
  2101.      * Cascades a merge operation to associated entities.
  2102.      *
  2103.      * @param object $entity
  2104.      * @param object $managedCopy
  2105.      * @psalm-param array<int, object> $visited
  2106.      */
  2107.     private function cascadeMerge($entity$managedCopy, array &$visited): void
  2108.     {
  2109.         $class $this->em->getClassMetadata(get_class($entity));
  2110.         $associationMappings array_filter(
  2111.             $class->associationMappings,
  2112.             static function ($assoc) {
  2113.                 return $assoc['isCascadeMerge'];
  2114.             }
  2115.         );
  2116.         foreach ($associationMappings as $assoc) {
  2117.             $relatedEntities $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2118.             if ($relatedEntities instanceof Collection) {
  2119.                 if ($relatedEntities === $class->reflFields[$assoc['fieldName']]->getValue($managedCopy)) {
  2120.                     continue;
  2121.                 }
  2122.                 if ($relatedEntities instanceof PersistentCollection) {
  2123.                     // Unwrap so that foreach() does not initialize
  2124.                     $relatedEntities $relatedEntities->unwrap();
  2125.                 }
  2126.                 foreach ($relatedEntities as $relatedEntity) {
  2127.                     $this->doMerge($relatedEntity$visited$managedCopy$assoc);
  2128.                 }
  2129.             } elseif ($relatedEntities !== null) {
  2130.                 $this->doMerge($relatedEntities$visited$managedCopy$assoc);
  2131.             }
  2132.         }
  2133.     }
  2134.     /**
  2135.      * Cascades the save operation to associated entities.
  2136.      *
  2137.      * @param object $entity
  2138.      * @psalm-param array<int, object> $visited
  2139.      */
  2140.     private function cascadePersist($entity, array &$visited): void
  2141.     {
  2142.         if ($this->isUninitializedObject($entity)) {
  2143.             // nothing to do - proxy is not initialized, therefore we don't do anything with it
  2144.             return;
  2145.         }
  2146.         $class $this->em->getClassMetadata(get_class($entity));
  2147.         $associationMappings array_filter(
  2148.             $class->associationMappings,
  2149.             static function ($assoc) {
  2150.                 return $assoc['isCascadePersist'];
  2151.             }
  2152.         );
  2153.         foreach ($associationMappings as $assoc) {
  2154.             $relatedEntities $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2155.             switch (true) {
  2156.                 case $relatedEntities instanceof PersistentCollection:
  2157.                     // Unwrap so that foreach() does not initialize
  2158.                     $relatedEntities $relatedEntities->unwrap();
  2159.                     // break; is commented intentionally!
  2160.                 case $relatedEntities instanceof Collection:
  2161.                 case is_array($relatedEntities):
  2162.                     if (($assoc['type'] & ClassMetadata::TO_MANY) <= 0) {
  2163.                         throw ORMInvalidArgumentException::invalidAssociation(
  2164.                             $this->em->getClassMetadata($assoc['targetEntity']),
  2165.                             $assoc,
  2166.                             $relatedEntities
  2167.                         );
  2168.                     }
  2169.                     foreach ($relatedEntities as $relatedEntity) {
  2170.                         $this->doPersist($relatedEntity$visited);
  2171.                     }
  2172.                     break;
  2173.                 case $relatedEntities !== null:
  2174.                     if (! $relatedEntities instanceof $assoc['targetEntity']) {
  2175.                         throw ORMInvalidArgumentException::invalidAssociation(
  2176.                             $this->em->getClassMetadata($assoc['targetEntity']),
  2177.                             $assoc,
  2178.                             $relatedEntities
  2179.                         );
  2180.                     }
  2181.                     $this->doPersist($relatedEntities$visited);
  2182.                     break;
  2183.                 default:
  2184.                     // Do nothing
  2185.             }
  2186.         }
  2187.     }
  2188.     /**
  2189.      * Cascades the delete operation to associated entities.
  2190.      *
  2191.      * @param object $entity
  2192.      * @psalm-param array<int, object> $visited
  2193.      */
  2194.     private function cascadeRemove($entity, array &$visited): void
  2195.     {
  2196.         $class $this->em->getClassMetadata(get_class($entity));
  2197.         $associationMappings array_filter(
  2198.             $class->associationMappings,
  2199.             static function ($assoc) {
  2200.                 return $assoc['isCascadeRemove'];
  2201.             }
  2202.         );
  2203.         if ($associationMappings) {
  2204.             $this->initializeObject($entity);
  2205.         }
  2206.         $entitiesToCascade = [];
  2207.         foreach ($associationMappings as $assoc) {
  2208.             $relatedEntities $class->reflFields[$assoc['fieldName']]->getValue($entity);
  2209.             switch (true) {
  2210.                 case $relatedEntities instanceof Collection:
  2211.                 case is_array($relatedEntities):
  2212.                     // If its a PersistentCollection initialization is intended! No unwrap!
  2213.                     foreach ($relatedEntities as $relatedEntity) {
  2214.                         $entitiesToCascade[] = $relatedEntity;
  2215.                     }
  2216.                     break;
  2217.                 case $relatedEntities !== null:
  2218.                     $entitiesToCascade[] = $relatedEntities;
  2219.                     break;
  2220.                 default:
  2221.                     // Do nothing
  2222.             }
  2223.         }
  2224.         foreach ($entitiesToCascade as $relatedEntity) {
  2225.             $this->doRemove($relatedEntity$visited);
  2226.         }
  2227.     }
  2228.     /**
  2229.      * Acquire a lock on the given entity.
  2230.      *
  2231.      * @param object                     $entity
  2232.      * @param int|DateTimeInterface|null $lockVersion
  2233.      * @psalm-param LockMode::* $lockMode
  2234.      *
  2235.      * @throws ORMInvalidArgumentException
  2236.      * @throws TransactionRequiredException
  2237.      * @throws OptimisticLockException
  2238.      */
  2239.     public function lock($entityint $lockMode$lockVersion null): void
  2240.     {
  2241.         if ($this->getEntityState($entityself::STATE_DETACHED) !== self::STATE_MANAGED) {
  2242.             throw ORMInvalidArgumentException::entityNotManaged($entity);
  2243.         }
  2244.         $class $this->em->getClassMetadata(get_class($entity));
  2245.         switch (true) {
  2246.             case $lockMode === LockMode::OPTIMISTIC:
  2247.                 if (! $class->isVersioned) {
  2248.                     throw OptimisticLockException::notVersioned($class->name);
  2249.                 }
  2250.                 if ($lockVersion === null) {
  2251.                     return;
  2252.                 }
  2253.                 $this->initializeObject($entity);
  2254.                 assert($class->versionField !== null);
  2255.                 $entityVersion $class->reflFields[$class->versionField]->getValue($entity);
  2256.                 // phpcs:ignore SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedNotEqualOperator
  2257.                 if ($entityVersion != $lockVersion) {
  2258.                     throw OptimisticLockException::lockFailedVersionMismatch($entity$lockVersion$entityVersion);
  2259.                 }
  2260.                 break;
  2261.             case $lockMode === LockMode::NONE:
  2262.             case $lockMode === LockMode::PESSIMISTIC_READ:
  2263.             case $lockMode === LockMode::PESSIMISTIC_WRITE:
  2264.                 if (! $this->em->getConnection()->isTransactionActive()) {
  2265.                     throw TransactionRequiredException::transactionRequired();
  2266.                 }
  2267.                 $oid spl_object_id($entity);
  2268.                 $this->getEntityPersister($class->name)->lock(
  2269.                     array_combine($class->getIdentifierFieldNames(), $this->entityIdentifiers[$oid]),
  2270.                     $lockMode
  2271.                 );
  2272.                 break;
  2273.             default:
  2274.                 // Do nothing
  2275.         }
  2276.     }
  2277.     /**
  2278.      * Gets the CommitOrderCalculator used by the UnitOfWork to order commits.
  2279.      *
  2280.      * @return CommitOrderCalculator
  2281.      */
  2282.     public function getCommitOrderCalculator()
  2283.     {
  2284.         return new Internal\CommitOrderCalculator();
  2285.     }
  2286.     /**
  2287.      * Clears the UnitOfWork.
  2288.      *
  2289.      * @param string|null $entityName if given, only entities of this type will get detached.
  2290.      *
  2291.      * @return void
  2292.      *
  2293.      * @throws ORMInvalidArgumentException if an invalid entity name is given.
  2294.      */
  2295.     public function clear($entityName null)
  2296.     {
  2297.         if ($entityName === null) {
  2298.             $this->identityMap                      =
  2299.             $this->entityIdentifiers                =
  2300.             $this->originalEntityData               =
  2301.             $this->entityChangeSets                 =
  2302.             $this->entityStates                     =
  2303.             $this->scheduledForSynchronization      =
  2304.             $this->entityInsertions                 =
  2305.             $this->entityUpdates                    =
  2306.             $this->entityDeletions                  =
  2307.             $this->nonCascadedNewDetectedEntities   =
  2308.             $this->collectionDeletions              =
  2309.             $this->collectionUpdates                =
  2310.             $this->extraUpdates                     =
  2311.             $this->readOnlyObjects                  =
  2312.             $this->pendingCollectionElementRemovals =
  2313.             $this->visitedCollections               =
  2314.             $this->eagerLoadingEntities             =
  2315.             $this->orphanRemovals                   = [];
  2316.         } else {
  2317.             Deprecation::triggerIfCalledFromOutside(
  2318.                 'doctrine/orm',
  2319.                 'https://github.com/doctrine/orm/issues/8460',
  2320.                 'Calling %s() with any arguments to clear specific entities is deprecated and will not be supported in Doctrine ORM 3.0.',
  2321.                 __METHOD__
  2322.             );
  2323.             $this->clearIdentityMapForEntityName($entityName);
  2324.             $this->clearEntityInsertionsForEntityName($entityName);
  2325.         }
  2326.         if ($this->evm->hasListeners(Events::onClear)) {
  2327.             $this->evm->dispatchEvent(Events::onClear, new Event\OnClearEventArgs($this->em$entityName));
  2328.         }
  2329.     }
  2330.     /**
  2331.      * INTERNAL:
  2332.      * Schedules an orphaned entity for removal. The remove() operation will be
  2333.      * invoked on that entity at the beginning of the next commit of this
  2334.      * UnitOfWork.
  2335.      *
  2336.      * @param object $entity
  2337.      *
  2338.      * @return void
  2339.      *
  2340.      * @ignore
  2341.      */
  2342.     public function scheduleOrphanRemoval($entity)
  2343.     {
  2344.         $this->orphanRemovals[spl_object_id($entity)] = $entity;
  2345.     }
  2346.     /**
  2347.      * INTERNAL:
  2348.      * Cancels a previously scheduled orphan removal.
  2349.      *
  2350.      * @param object $entity
  2351.      *
  2352.      * @return void
  2353.      *
  2354.      * @ignore
  2355.      */
  2356.     public function cancelOrphanRemoval($entity)
  2357.     {
  2358.         unset($this->orphanRemovals[spl_object_id($entity)]);
  2359.     }
  2360.     /**
  2361.      * INTERNAL:
  2362.      * Schedules a complete collection for removal when this UnitOfWork commits.
  2363.      *
  2364.      * @return void
  2365.      */
  2366.     public function scheduleCollectionDeletion(PersistentCollection $coll)
  2367.     {
  2368.         $coid spl_object_id($coll);
  2369.         // TODO: if $coll is already scheduled for recreation ... what to do?
  2370.         // Just remove $coll from the scheduled recreations?
  2371.         unset($this->collectionUpdates[$coid]);
  2372.         $this->collectionDeletions[$coid] = $coll;
  2373.     }
  2374.     /** @return bool */
  2375.     public function isCollectionScheduledForDeletion(PersistentCollection $coll)
  2376.     {
  2377.         return isset($this->collectionDeletions[spl_object_id($coll)]);
  2378.     }
  2379.     /** @return object */
  2380.     private function newInstance(ClassMetadata $class)
  2381.     {
  2382.         $entity $class->newInstance();
  2383.         if ($entity instanceof ObjectManagerAware) {
  2384.             $entity->injectObjectManager($this->em$class);
  2385.         }
  2386.         return $entity;
  2387.     }
  2388.     /**
  2389.      * INTERNAL:
  2390.      * Creates an entity. Used for reconstitution of persistent entities.
  2391.      *
  2392.      * Internal note: Highly performance-sensitive method.
  2393.      *
  2394.      * @param string  $className The name of the entity class.
  2395.      * @param mixed[] $data      The data for the entity.
  2396.      * @param mixed[] $hints     Any hints to account for during reconstitution/lookup of the entity.
  2397.      * @psalm-param class-string $className
  2398.      * @psalm-param array<string, mixed> $hints
  2399.      *
  2400.      * @return object The managed entity instance.
  2401.      *
  2402.      * @ignore
  2403.      * @todo Rename: getOrCreateEntity
  2404.      */
  2405.     public function createEntity($className, array $data, &$hints = [])
  2406.     {
  2407.         $class $this->em->getClassMetadata($className);
  2408.         $id     $this->identifierFlattener->flattenIdentifier($class$data);
  2409.         $idHash self::getIdHashByIdentifier($id);
  2410.         if (isset($this->identityMap[$class->rootEntityName][$idHash])) {
  2411.             $entity $this->identityMap[$class->rootEntityName][$idHash];
  2412.             $oid    spl_object_id($entity);
  2413.             if (
  2414.                 isset($hints[Query::HINT_REFRESH], $hints[Query::HINT_REFRESH_ENTITY])
  2415.             ) {
  2416.                 $unmanagedProxy $hints[Query::HINT_REFRESH_ENTITY];
  2417.                 if (
  2418.                     $unmanagedProxy !== $entity
  2419.                     && $this->isIdentifierEquals($unmanagedProxy$entity)
  2420.                 ) {
  2421.                     // We will hydrate the given un-managed proxy anyway:
  2422.                     // continue work, but consider it the entity from now on
  2423.                     $entity $unmanagedProxy;
  2424.                 }
  2425.             }
  2426.             if ($this->isUninitializedObject($entity)) {
  2427.                 $entity->__setInitialized(true);
  2428.             } else {
  2429.                 if (
  2430.                     ! isset($hints[Query::HINT_REFRESH])
  2431.                     || (isset($hints[Query::HINT_REFRESH_ENTITY]) && $hints[Query::HINT_REFRESH_ENTITY] !== $entity)
  2432.                 ) {
  2433.                     return $entity;
  2434.                 }
  2435.             }
  2436.             // inject ObjectManager upon refresh.
  2437.             if ($entity instanceof ObjectManagerAware) {
  2438.                 $entity->injectObjectManager($this->em$class);
  2439.             }
  2440.             $this->originalEntityData[$oid] = $data;
  2441.             if ($entity instanceof NotifyPropertyChanged) {
  2442.                 $entity->addPropertyChangedListener($this);
  2443.             }
  2444.         } else {
  2445.             $entity $this->newInstance($class);
  2446.             $oid    spl_object_id($entity);
  2447.             $this->registerManaged($entity$id$data);
  2448.             if (isset($hints[Query::HINT_READ_ONLY])) {
  2449.                 $this->readOnlyObjects[$oid] = true;
  2450.             }
  2451.         }
  2452.         foreach ($data as $field => $value) {
  2453.             if (isset($class->fieldMappings[$field])) {
  2454.                 $class->reflFields[$field]->setValue($entity$value);
  2455.             }
  2456.         }
  2457.         // Loading the entity right here, if its in the eager loading map get rid of it there.
  2458.         unset($this->eagerLoadingEntities[$class->rootEntityName][$idHash]);
  2459.         if (isset($this->eagerLoadingEntities[$class->rootEntityName]) && ! $this->eagerLoadingEntities[$class->rootEntityName]) {
  2460.             unset($this->eagerLoadingEntities[$class->rootEntityName]);
  2461.         }
  2462.         // Properly initialize any unfetched associations, if partial objects are not allowed.
  2463.         if (isset($hints[Query::HINT_FORCE_PARTIAL_LOAD])) {
  2464.             Deprecation::trigger(
  2465.                 'doctrine/orm',
  2466.                 'https://github.com/doctrine/orm/issues/8471',
  2467.                 'Partial Objects are deprecated (here entity %s)',
  2468.                 $className
  2469.             );
  2470.             return $entity;
  2471.         }
  2472.         foreach ($class->associationMappings as $field => $assoc) {
  2473.             // Check if the association is not among the fetch-joined associations already.
  2474.             if (isset($hints['fetchAlias'], $hints['fetched'][$hints['fetchAlias']][$field])) {
  2475.                 continue;
  2476.             }
  2477.             $targetClass $this->em->getClassMetadata($assoc['targetEntity']);
  2478.             switch (true) {
  2479.                 case $assoc['type'] & ClassMetadata::TO_ONE:
  2480.                     if (! $assoc['isOwningSide']) {
  2481.                         // use the given entity association
  2482.                         if (isset($data[$field]) && is_object($data[$field]) && isset($this->entityStates[spl_object_id($data[$field])])) {
  2483.                             $this->originalEntityData[$oid][$field] = $data[$field];
  2484.                             $class->reflFields[$field]->setValue($entity$data[$field]);
  2485.                             $targetClass->reflFields[$assoc['mappedBy']]->setValue($data[$field], $entity);
  2486.                             continue 2;
  2487.                         }
  2488.                         // Inverse side of x-to-one can never be lazy
  2489.                         $class->reflFields[$field]->setValue($entity$this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc$entity));
  2490.                         continue 2;
  2491.                     }
  2492.                     // use the entity association
  2493.                     if (isset($data[$field]) && is_object($data[$field]) && isset($this->entityStates[spl_object_id($data[$field])])) {
  2494.                         $class->reflFields[$field]->setValue($entity$data[$field]);
  2495.                         $this->originalEntityData[$oid][$field] = $data[$field];
  2496.                         break;
  2497.                     }
  2498.                     $associatedId = [];
  2499.                     // TODO: Is this even computed right in all cases of composite keys?
  2500.                     foreach ($assoc['targetToSourceKeyColumns'] as $targetColumn => $srcColumn) {
  2501.                         $joinColumnValue $data[$srcColumn] ?? null;
  2502.                         if ($joinColumnValue !== null) {
  2503.                             if ($joinColumnValue instanceof BackedEnum) {
  2504.                                 $joinColumnValue $joinColumnValue->value;
  2505.                             }
  2506.                             if ($targetClass->containsForeignIdentifier) {
  2507.                                 $associatedId[$targetClass->getFieldForColumn($targetColumn)] = $joinColumnValue;
  2508.                             } else {
  2509.                                 $associatedId[$targetClass->fieldNames[$targetColumn]] = $joinColumnValue;
  2510.                             }
  2511.                         } elseif (
  2512.                             $targetClass->containsForeignIdentifier
  2513.                             && in_array($targetClass->getFieldForColumn($targetColumn), $targetClass->identifiertrue)
  2514.                         ) {
  2515.                             // the missing key is part of target's entity primary key
  2516.                             $associatedId = [];
  2517.                             break;
  2518.                         }
  2519.                     }
  2520.                     if (! $associatedId) {
  2521.                         // Foreign key is NULL
  2522.                         $class->reflFields[$field]->setValue($entitynull);
  2523.                         $this->originalEntityData[$oid][$field] = null;
  2524.                         break;
  2525.                     }
  2526.                     if (! isset($hints['fetchMode'][$class->name][$field])) {
  2527.                         $hints['fetchMode'][$class->name][$field] = $assoc['fetch'];
  2528.                     }
  2529.                     // Foreign key is set
  2530.                     // Check identity map first
  2531.                     // FIXME: Can break easily with composite keys if join column values are in
  2532.                     //        wrong order. The correct order is the one in ClassMetadata#identifier.
  2533.                     $relatedIdHash self::getIdHashByIdentifier($associatedId);
  2534.                     switch (true) {
  2535.                         case isset($this->identityMap[$targetClass->rootEntityName][$relatedIdHash]):
  2536.                             $newValue $this->identityMap[$targetClass->rootEntityName][$relatedIdHash];
  2537.                             // If this is an uninitialized proxy, we are deferring eager loads,
  2538.                             // this association is marked as eager fetch, and its an uninitialized proxy (wtf!)
  2539.                             // then we can append this entity for eager loading!
  2540.                             if (
  2541.                                 $hints['fetchMode'][$class->name][$field] === ClassMetadata::FETCH_EAGER &&
  2542.                                 isset($hints[self::HINT_DEFEREAGERLOAD]) &&
  2543.                                 ! $targetClass->isIdentifierComposite &&
  2544.                                 $this->isUninitializedObject($newValue)
  2545.                             ) {
  2546.                                 $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($associatedId);
  2547.                             }
  2548.                             break;
  2549.                         case $targetClass->subClasses:
  2550.                             // If it might be a subtype, it can not be lazy. There isn't even
  2551.                             // a way to solve this with deferred eager loading, which means putting
  2552.                             // an entity with subclasses at a *-to-one location is really bad! (performance-wise)
  2553.                             $newValue $this->getEntityPersister($assoc['targetEntity'])->loadOneToOneEntity($assoc$entity$associatedId);
  2554.                             break;
  2555.                         default:
  2556.                             $normalizedAssociatedId $this->normalizeIdentifier($targetClass$associatedId);
  2557.                             switch (true) {
  2558.                                 // We are negating the condition here. Other cases will assume it is valid!
  2559.                                 case $hints['fetchMode'][$class->name][$field] !== ClassMetadata::FETCH_EAGER:
  2560.                                     $newValue $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $normalizedAssociatedId);
  2561.                                     $this->registerManaged($newValue$associatedId, []);
  2562.                                     break;
  2563.                                 // Deferred eager load only works for single identifier classes
  2564.                                 case isset($hints[self::HINT_DEFEREAGERLOAD]) && ! $targetClass->isIdentifierComposite:
  2565.                                     // TODO: Is there a faster approach?
  2566.                                     $this->eagerLoadingEntities[$targetClass->rootEntityName][$relatedIdHash] = current($normalizedAssociatedId);
  2567.                                     $newValue $this->em->getProxyFactory()->getProxy($assoc['targetEntity'], $normalizedAssociatedId);
  2568.                                     $this->registerManaged($newValue$associatedId, []);
  2569.                                     break;
  2570.                                 default:
  2571.                                     // TODO: This is very imperformant, ignore it?
  2572.                                     $newValue $this->em->find($assoc['targetEntity'], $normalizedAssociatedId);
  2573.                                     break;
  2574.                             }
  2575.                     }
  2576.                     $this->originalEntityData[$oid][$field] = $newValue;
  2577.                     $class->reflFields[$field]->setValue($entity$newValue);
  2578.                     if ($assoc['inversedBy'] && $assoc['type'] & ClassMetadata::ONE_TO_ONE && $newValue !== null) {
  2579.                         $inverseAssoc $targetClass->associationMappings[$assoc['inversedBy']];
  2580.                         $targetClass->reflFields[$inverseAssoc['fieldName']]->setValue($newValue$entity);
  2581.                     }
  2582.                     break;
  2583.                 default:
  2584.                     // Ignore if its a cached collection
  2585.                     if (isset($hints[Query::HINT_CACHE_ENABLED]) && $class->getFieldValue($entity$field) instanceof PersistentCollection) {
  2586.                         break;
  2587.                     }
  2588.                     // use the given collection
  2589.                     if (isset($data[$field]) && $data[$field] instanceof PersistentCollection) {
  2590.                         $data[$field]->setOwner($entity$assoc);
  2591.                         $class->reflFields[$field]->setValue($entity$data[$field]);
  2592.                         $this->originalEntityData[$oid][$field] = $data[$field];
  2593.                         break;
  2594.                     }
  2595.                     // Inject collection
  2596.                     $pColl = new PersistentCollection($this->em$targetClass, new ArrayCollection());
  2597.                     $pColl->setOwner($entity$assoc);
  2598.                     $pColl->setInitialized(false);
  2599.                     $reflField $class->reflFields[$field];
  2600.                     $reflField->setValue($entity$pColl);
  2601.                     if ($assoc['fetch'] === ClassMetadata::FETCH_EAGER) {
  2602.                         $this->loadCollection($pColl);
  2603.                         $pColl->takeSnapshot();
  2604.                     }
  2605.                     $this->originalEntityData[$oid][$field] = $pColl;
  2606.                     break;
  2607.             }
  2608.         }
  2609.         // defer invoking of postLoad event to hydration complete step
  2610.         $this->hydrationCompleteHandler->deferPostLoadInvoking($class$entity);
  2611.         return $entity;
  2612.     }
  2613.     /** @return void */
  2614.     public function triggerEagerLoads()
  2615.     {
  2616.         if (! $this->eagerLoadingEntities) {
  2617.             return;
  2618.         }
  2619.         // avoid infinite recursion
  2620.         $eagerLoadingEntities       $this->eagerLoadingEntities;
  2621.         $this->eagerLoadingEntities = [];
  2622.         foreach ($eagerLoadingEntities as $entityName => $ids) {
  2623.             if (! $ids) {
  2624.                 continue;
  2625.             }
  2626.             $class $this->em->getClassMetadata($entityName);
  2627.             $this->getEntityPersister($entityName)->loadAll(
  2628.                 array_combine($class->identifier, [array_values($ids)])
  2629.             );
  2630.         }
  2631.     }
  2632.     /**
  2633.      * Initializes (loads) an uninitialized persistent collection of an entity.
  2634.      *
  2635.      * @param PersistentCollection $collection The collection to initialize.
  2636.      *
  2637.      * @return void
  2638.      *
  2639.      * @todo Maybe later move to EntityManager#initialize($proxyOrCollection). See DDC-733.
  2640.      */
  2641.     public function loadCollection(PersistentCollection $collection)
  2642.     {
  2643.         $assoc     $collection->getMapping();
  2644.         $persister $this->getEntityPersister($assoc['targetEntity']);
  2645.         switch ($assoc['type']) {
  2646.             case ClassMetadata::ONE_TO_MANY:
  2647.                 $persister->loadOneToManyCollection($assoc$collection->getOwner(), $collection);
  2648.                 break;
  2649.             case ClassMetadata::MANY_TO_MANY:
  2650.                 $persister->loadManyToManyCollection($assoc$collection->getOwner(), $collection);
  2651.                 break;
  2652.         }
  2653.         $collection->setInitialized(true);
  2654.     }
  2655.     /**
  2656.      * Gets the identity map of the UnitOfWork.
  2657.      *
  2658.      * @psalm-return array<class-string, array<string, object>>
  2659.      */
  2660.     public function getIdentityMap()
  2661.     {
  2662.         return $this->identityMap;
  2663.     }
  2664.     /**
  2665.      * Gets the original data of an entity. The original data is the data that was
  2666.      * present at the time the entity was reconstituted from the database.
  2667.      *
  2668.      * @param object $entity
  2669.      *
  2670.      * @return mixed[]
  2671.      * @psalm-return array<string, mixed>
  2672.      */
  2673.     public function getOriginalEntityData($entity)
  2674.     {
  2675.         $oid spl_object_id($entity);
  2676.         return $this->originalEntityData[$oid] ?? [];
  2677.     }
  2678.     /**
  2679.      * @param object  $entity
  2680.      * @param mixed[] $data
  2681.      *
  2682.      * @return void
  2683.      *
  2684.      * @ignore
  2685.      */
  2686.     public function setOriginalEntityData($entity, array $data)
  2687.     {
  2688.         $this->originalEntityData[spl_object_id($entity)] = $data;
  2689.     }
  2690.     /**
  2691.      * INTERNAL:
  2692.      * Sets a property value of the original data array of an entity.
  2693.      *
  2694.      * @param int    $oid
  2695.      * @param string $property
  2696.      * @param mixed  $value
  2697.      *
  2698.      * @return void
  2699.      *
  2700.      * @ignore
  2701.      */
  2702.     public function setOriginalEntityProperty($oid$property$value)
  2703.     {
  2704.         $this->originalEntityData[$oid][$property] = $value;
  2705.     }
  2706.     /**
  2707.      * Gets the identifier of an entity.
  2708.      * The returned value is always an array of identifier values. If the entity
  2709.      * has a composite identifier then the identifier values are in the same
  2710.      * order as the identifier field names as returned by ClassMetadata#getIdentifierFieldNames().
  2711.      *
  2712.      * @param object $entity
  2713.      *
  2714.      * @return mixed[] The identifier values.
  2715.      */
  2716.     public function getEntityIdentifier($entity)
  2717.     {
  2718.         if (! isset($this->entityIdentifiers[spl_object_id($entity)])) {
  2719.             throw EntityNotFoundException::noIdentifierFound(get_debug_type($entity));
  2720.         }
  2721.         return $this->entityIdentifiers[spl_object_id($entity)];
  2722.     }
  2723.     /**
  2724.      * Processes an entity instance to extract their identifier values.
  2725.      *
  2726.      * @param object $entity The entity instance.
  2727.      *
  2728.      * @return mixed A scalar value.
  2729.      *
  2730.      * @throws ORMInvalidArgumentException
  2731.      */
  2732.     public function getSingleIdentifierValue($entity)
  2733.     {
  2734.         $class $this->em->getClassMetadata(get_class($entity));
  2735.         if ($class->isIdentifierComposite) {
  2736.             throw ORMInvalidArgumentException::invalidCompositeIdentifier();
  2737.         }
  2738.         $values $this->isInIdentityMap($entity)
  2739.             ? $this->getEntityIdentifier($entity)
  2740.             : $class->getIdentifierValues($entity);
  2741.         return $values[$class->identifier[0]] ?? null;
  2742.     }
  2743.     /**
  2744.      * Tries to find an entity with the given identifier in the identity map of
  2745.      * this UnitOfWork.
  2746.      *
  2747.      * @param mixed  $id            The entity identifier to look for.
  2748.      * @param string $rootClassName The name of the root class of the mapped entity hierarchy.
  2749.      * @psalm-param class-string $rootClassName
  2750.      *
  2751.      * @return object|false Returns the entity with the specified identifier if it exists in
  2752.      *                      this UnitOfWork, FALSE otherwise.
  2753.      */
  2754.     public function tryGetById($id$rootClassName)
  2755.     {
  2756.         $idHash self::getIdHashByIdentifier((array) $id);
  2757.         return $this->identityMap[$rootClassName][$idHash] ?? false;
  2758.     }
  2759.     /**
  2760.      * Schedules an entity for dirty-checking at commit-time.
  2761.      *
  2762.      * @param object $entity The entity to schedule for dirty-checking.
  2763.      *
  2764.      * @return void
  2765.      *
  2766.      * @todo Rename: scheduleForSynchronization
  2767.      */
  2768.     public function scheduleForDirtyCheck($entity)
  2769.     {
  2770.         $rootClassName $this->em->getClassMetadata(get_class($entity))->rootEntityName;
  2771.         $this->scheduledForSynchronization[$rootClassName][spl_object_id($entity)] = $entity;
  2772.     }
  2773.     /**
  2774.      * Checks whether the UnitOfWork has any pending insertions.
  2775.      *
  2776.      * @return bool TRUE if this UnitOfWork has pending insertions, FALSE otherwise.
  2777.      */
  2778.     public function hasPendingInsertions()
  2779.     {
  2780.         return ! empty($this->entityInsertions);
  2781.     }
  2782.     /**
  2783.      * Calculates the size of the UnitOfWork. The size of the UnitOfWork is the
  2784.      * number of entities in the identity map.
  2785.      *
  2786.      * @return int
  2787.      */
  2788.     public function size()
  2789.     {
  2790.         return array_sum(array_map('count'$this->identityMap));
  2791.     }
  2792.     /**
  2793.      * Gets the EntityPersister for an Entity.
  2794.      *
  2795.      * @param string $entityName The name of the Entity.
  2796.      * @psalm-param class-string $entityName
  2797.      *
  2798.      * @return EntityPersister
  2799.      */
  2800.     public function getEntityPersister($entityName)
  2801.     {
  2802.         if (isset($this->persisters[$entityName])) {
  2803.             return $this->persisters[$entityName];
  2804.         }
  2805.         $class $this->em->getClassMetadata($entityName);
  2806.         switch (true) {
  2807.             case $class->isInheritanceTypeNone():
  2808.                 $persister = new BasicEntityPersister($this->em$class);
  2809.                 break;
  2810.             case $class->isInheritanceTypeSingleTable():
  2811.                 $persister = new SingleTablePersister($this->em$class);
  2812.                 break;
  2813.             case $class->isInheritanceTypeJoined():
  2814.                 $persister = new JoinedSubclassPersister($this->em$class);
  2815.                 break;
  2816.             default:
  2817.                 throw new RuntimeException('No persister found for entity.');
  2818.         }
  2819.         if ($this->hasCache && $class->cache !== null) {
  2820.             $persister $this->em->getConfiguration()
  2821.                 ->getSecondLevelCacheConfiguration()
  2822.                 ->getCacheFactory()
  2823.                 ->buildCachedEntityPersister($this->em$persister$class);
  2824.         }
  2825.         $this->persisters[$entityName] = $persister;
  2826.         return $this->persisters[$entityName];
  2827.     }
  2828.     /**
  2829.      * Gets a collection persister for a collection-valued association.
  2830.      *
  2831.      * @psalm-param AssociationMapping $association
  2832.      *
  2833.      * @return CollectionPersister
  2834.      */
  2835.     public function getCollectionPersister(array $association)
  2836.     {
  2837.         $role = isset($association['cache'])
  2838.             ? $association['sourceEntity'] . '::' $association['fieldName']
  2839.             : $association['type'];
  2840.         if (isset($this->collectionPersisters[$role])) {
  2841.             return $this->collectionPersisters[$role];
  2842.         }
  2843.         $persister $association['type'] === ClassMetadata::ONE_TO_MANY
  2844.             ? new OneToManyPersister($this->em)
  2845.             : new ManyToManyPersister($this->em);
  2846.         if ($this->hasCache && isset($association['cache'])) {
  2847.             $persister $this->em->getConfiguration()
  2848.                 ->getSecondLevelCacheConfiguration()
  2849.                 ->getCacheFactory()
  2850.                 ->buildCachedCollectionPersister($this->em$persister$association);
  2851.         }
  2852.         $this->collectionPersisters[$role] = $persister;
  2853.         return $this->collectionPersisters[$role];
  2854.     }
  2855.     /**
  2856.      * INTERNAL:
  2857.      * Registers an entity as managed.
  2858.      *
  2859.      * @param object  $entity The entity.
  2860.      * @param mixed[] $id     The identifier values.
  2861.      * @param mixed[] $data   The original entity data.
  2862.      *
  2863.      * @return void
  2864.      */
  2865.     public function registerManaged($entity, array $id, array $data)
  2866.     {
  2867.         $oid spl_object_id($entity);
  2868.         $this->entityIdentifiers[$oid]  = $id;
  2869.         $this->entityStates[$oid]       = self::STATE_MANAGED;
  2870.         $this->originalEntityData[$oid] = $data;
  2871.         $this->addToIdentityMap($entity);
  2872.         if ($entity instanceof NotifyPropertyChanged && ! $this->isUninitializedObject($entity)) {
  2873.             $entity->addPropertyChangedListener($this);
  2874.         }
  2875.     }
  2876.     /**
  2877.      * INTERNAL:
  2878.      * Clears the property changeset of the entity with the given OID.
  2879.      *
  2880.      * @param int $oid The entity's OID.
  2881.      *
  2882.      * @return void
  2883.      */
  2884.     public function clearEntityChangeSet($oid)
  2885.     {
  2886.         unset($this->entityChangeSets[$oid]);
  2887.     }
  2888.     /* PropertyChangedListener implementation */
  2889.     /**
  2890.      * Notifies this UnitOfWork of a property change in an entity.
  2891.      *
  2892.      * @param object $sender       The entity that owns the property.
  2893.      * @param string $propertyName The name of the property that changed.
  2894.      * @param mixed  $oldValue     The old value of the property.
  2895.      * @param mixed  $newValue     The new value of the property.
  2896.      *
  2897.      * @return void
  2898.      */
  2899.     public function propertyChanged($sender$propertyName$oldValue$newValue)
  2900.     {
  2901.         $oid   spl_object_id($sender);
  2902.         $class $this->em->getClassMetadata(get_class($sender));
  2903.         $isAssocField = isset($class->associationMappings[$propertyName]);
  2904.         if (! $isAssocField && ! isset($class->fieldMappings[$propertyName])) {
  2905.             return; // ignore non-persistent fields
  2906.         }
  2907.         // Update changeset and mark entity for synchronization
  2908.         $this->entityChangeSets[$oid][$propertyName] = [$oldValue$newValue];
  2909.         if (! isset($this->scheduledForSynchronization[$class->rootEntityName][$oid])) {
  2910.             $this->scheduleForDirtyCheck($sender);
  2911.         }
  2912.     }
  2913.     /**
  2914.      * Gets the currently scheduled entity insertions in this UnitOfWork.
  2915.      *
  2916.      * @psalm-return array<int, object>
  2917.      */
  2918.     public function getScheduledEntityInsertions()
  2919.     {
  2920.         return $this->entityInsertions;
  2921.     }
  2922.     /**
  2923.      * Gets the currently scheduled entity updates in this UnitOfWork.
  2924.      *
  2925.      * @psalm-return array<int, object>
  2926.      */
  2927.     public function getScheduledEntityUpdates()
  2928.     {
  2929.         return $this->entityUpdates;
  2930.     }
  2931.     /**
  2932.      * Gets the currently scheduled entity deletions in this UnitOfWork.
  2933.      *
  2934.      * @psalm-return array<int, object>
  2935.      */
  2936.     public function getScheduledEntityDeletions()
  2937.     {
  2938.         return $this->entityDeletions;
  2939.     }
  2940.     /**
  2941.      * Gets the currently scheduled complete collection deletions
  2942.      *
  2943.      * @psalm-return array<int, PersistentCollection<array-key, object>>
  2944.      */
  2945.     public function getScheduledCollectionDeletions()
  2946.     {
  2947.         return $this->collectionDeletions;
  2948.     }
  2949.     /**
  2950.      * Gets the currently scheduled collection inserts, updates and deletes.
  2951.      *
  2952.      * @psalm-return array<int, PersistentCollection<array-key, object>>
  2953.      */
  2954.     public function getScheduledCollectionUpdates()
  2955.     {
  2956.         return $this->collectionUpdates;
  2957.     }
  2958.     /**
  2959.      * Helper method to initialize a lazy loading proxy or persistent collection.
  2960.      *
  2961.      * @param object $obj
  2962.      *
  2963.      * @return void
  2964.      */
  2965.     public function initializeObject($obj)
  2966.     {
  2967.         if ($obj instanceof InternalProxy) {
  2968.             $obj->__load();
  2969.             return;
  2970.         }
  2971.         if ($obj instanceof PersistentCollection) {
  2972.             $obj->initialize();
  2973.         }
  2974.     }
  2975.     /**
  2976.      * Tests if a value is an uninitialized entity.
  2977.      *
  2978.      * @param mixed $obj
  2979.      *
  2980.      * @psalm-assert-if-true InternalProxy $obj
  2981.      */
  2982.     public function isUninitializedObject($obj): bool
  2983.     {
  2984.         return $obj instanceof InternalProxy && ! $obj->__isInitialized();
  2985.     }
  2986.     /**
  2987.      * Helper method to show an object as string.
  2988.      *
  2989.      * @param object $obj
  2990.      */
  2991.     private static function objToStr($obj): string
  2992.     {
  2993.         return method_exists($obj'__toString') ? (string) $obj get_debug_type($obj) . '@' spl_object_id($obj);
  2994.     }
  2995.     /**
  2996.      * Marks an entity as read-only so that it will not be considered for updates during UnitOfWork#commit().
  2997.      *
  2998.      * This operation cannot be undone as some parts of the UnitOfWork now keep gathering information
  2999.      * on this object that might be necessary to perform a correct update.
  3000.      *
  3001.      * @param object $object
  3002.      *
  3003.      * @return void
  3004.      *
  3005.      * @throws ORMInvalidArgumentException
  3006.      */
  3007.     public function markReadOnly($object)
  3008.     {
  3009.         if (! is_object($object) || ! $this->isInIdentityMap($object)) {
  3010.             throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
  3011.         }
  3012.         $this->readOnlyObjects[spl_object_id($object)] = true;
  3013.     }
  3014.     /**
  3015.      * Is this entity read only?
  3016.      *
  3017.      * @param object $object
  3018.      *
  3019.      * @return bool
  3020.      *
  3021.      * @throws ORMInvalidArgumentException
  3022.      */
  3023.     public function isReadOnly($object)
  3024.     {
  3025.         if (! is_object($object)) {
  3026.             throw ORMInvalidArgumentException::readOnlyRequiresManagedEntity($object);
  3027.         }
  3028.         return isset($this->readOnlyObjects[spl_object_id($object)]);
  3029.     }
  3030.     /**
  3031.      * Perform whatever processing is encapsulated here after completion of the transaction.
  3032.      */
  3033.     private function afterTransactionComplete(): void
  3034.     {
  3035.         $this->performCallbackOnCachedPersister(static function (CachedPersister $persister) {
  3036.             $persister->afterTransactionComplete();
  3037.         });
  3038.     }
  3039.     /**
  3040.      * Perform whatever processing is encapsulated here after completion of the rolled-back.
  3041.      */
  3042.     private function afterTransactionRolledBack(): void
  3043.     {
  3044.         $this->performCallbackOnCachedPersister(static function (CachedPersister $persister) {
  3045.             $persister->afterTransactionRolledBack();
  3046.         });
  3047.     }
  3048.     /**
  3049.      * Performs an action after the transaction.
  3050.      */
  3051.     private function performCallbackOnCachedPersister(callable $callback): void
  3052.     {
  3053.         if (! $this->hasCache) {
  3054.             return;
  3055.         }
  3056.         foreach (array_merge($this->persisters$this->collectionPersisters) as $persister) {
  3057.             if ($persister instanceof CachedPersister) {
  3058.                 $callback($persister);
  3059.             }
  3060.         }
  3061.     }
  3062.     private function dispatchOnFlushEvent(): void
  3063.     {
  3064.         if ($this->evm->hasListeners(Events::onFlush)) {
  3065.             $this->evm->dispatchEvent(Events::onFlush, new OnFlushEventArgs($this->em));
  3066.         }
  3067.     }
  3068.     private function dispatchPostFlushEvent(): void
  3069.     {
  3070.         if ($this->evm->hasListeners(Events::postFlush)) {
  3071.             $this->evm->dispatchEvent(Events::postFlush, new PostFlushEventArgs($this->em));
  3072.         }
  3073.     }
  3074.     /**
  3075.      * Verifies if two given entities actually are the same based on identifier comparison
  3076.      *
  3077.      * @param object $entity1
  3078.      * @param object $entity2
  3079.      */
  3080.     private function isIdentifierEquals($entity1$entity2): bool
  3081.     {
  3082.         if ($entity1 === $entity2) {
  3083.             return true;
  3084.         }
  3085.         $class $this->em->getClassMetadata(get_class($entity1));
  3086.         if ($class !== $this->em->getClassMetadata(get_class($entity2))) {
  3087.             return false;
  3088.         }
  3089.         $oid1 spl_object_id($entity1);
  3090.         $oid2 spl_object_id($entity2);
  3091.         $id1 $this->entityIdentifiers[$oid1] ?? $this->identifierFlattener->flattenIdentifier($class$class->getIdentifierValues($entity1));
  3092.         $id2 $this->entityIdentifiers[$oid2] ?? $this->identifierFlattener->flattenIdentifier($class$class->getIdentifierValues($entity2));
  3093.         return $id1 === $id2 || self::getIdHashByIdentifier($id1) === self::getIdHashByIdentifier($id2);
  3094.     }
  3095.     /** @throws ORMInvalidArgumentException */
  3096.     private function assertThatThereAreNoUnintentionallyNonPersistedAssociations(): void
  3097.     {
  3098.         $entitiesNeedingCascadePersist array_diff_key($this->nonCascadedNewDetectedEntities$this->entityInsertions);
  3099.         $this->nonCascadedNewDetectedEntities = [];
  3100.         if ($entitiesNeedingCascadePersist) {
  3101.             throw ORMInvalidArgumentException::newEntitiesFoundThroughRelationships(
  3102.                 array_values($entitiesNeedingCascadePersist)
  3103.             );
  3104.         }
  3105.     }
  3106.     /**
  3107.      * @param object $entity
  3108.      * @param object $managedCopy
  3109.      *
  3110.      * @throws ORMException
  3111.      * @throws OptimisticLockException
  3112.      * @throws TransactionRequiredException
  3113.      */
  3114.     private function mergeEntityStateIntoManagedCopy($entity$managedCopy): void
  3115.     {
  3116.         if ($this->isUninitializedObject($entity)) {
  3117.             return;
  3118.         }
  3119.         $this->initializeObject($managedCopy);
  3120.         $class $this->em->getClassMetadata(get_class($entity));
  3121.         foreach ($this->reflectionPropertiesGetter->getProperties($class->name) as $prop) {
  3122.             $name $prop->name;
  3123.             $prop->setAccessible(true);
  3124.             if (! isset($class->associationMappings[$name])) {
  3125.                 if (! $class->isIdentifier($name)) {
  3126.                     $prop->setValue($managedCopy$prop->getValue($entity));
  3127.                 }
  3128.             } else {
  3129.                 $assoc2 $class->associationMappings[$name];
  3130.                 if ($assoc2['type'] & ClassMetadata::TO_ONE) {
  3131.                     $other $prop->getValue($entity);
  3132.                     if ($other === null) {
  3133.                         $prop->setValue($managedCopynull);
  3134.                     } else {
  3135.                         if ($this->isUninitializedObject($other)) {
  3136.                             // do not merge fields marked lazy that have not been fetched.
  3137.                             continue;
  3138.                         }
  3139.                         if (! $assoc2['isCascadeMerge']) {
  3140.                             if ($this->getEntityState($other) === self::STATE_DETACHED) {
  3141.                                 $targetClass $this->em->getClassMetadata($assoc2['targetEntity']);
  3142.                                 $relatedId   $targetClass->getIdentifierValues($other);
  3143.                                 $other $this->tryGetById($relatedId$targetClass->name);
  3144.                                 if (! $other) {
  3145.                                     if ($targetClass->subClasses) {
  3146.                                         $other $this->em->find($targetClass->name$relatedId);
  3147.                                     } else {
  3148.                                         $other $this->em->getProxyFactory()->getProxy(
  3149.                                             $assoc2['targetEntity'],
  3150.                                             $relatedId
  3151.                                         );
  3152.                                         $this->registerManaged($other$relatedId, []);
  3153.                                     }
  3154.                                 }
  3155.                             }
  3156.                             $prop->setValue($managedCopy$other);
  3157.                         }
  3158.                     }
  3159.                 } else {
  3160.                     $mergeCol $prop->getValue($entity);
  3161.                     if ($mergeCol instanceof PersistentCollection && ! $mergeCol->isInitialized()) {
  3162.                         // do not merge fields marked lazy that have not been fetched.
  3163.                         // keep the lazy persistent collection of the managed copy.
  3164.                         continue;
  3165.                     }
  3166.                     $managedCol $prop->getValue($managedCopy);
  3167.                     if (! $managedCol) {
  3168.                         $managedCol = new PersistentCollection(
  3169.                             $this->em,
  3170.                             $this->em->getClassMetadata($assoc2['targetEntity']),
  3171.                             new ArrayCollection()
  3172.                         );
  3173.                         $managedCol->setOwner($managedCopy$assoc2);
  3174.                         $prop->setValue($managedCopy$managedCol);
  3175.                     }
  3176.                     if ($assoc2['isCascadeMerge']) {
  3177.                         $managedCol->initialize();
  3178.                         // clear and set dirty a managed collection if its not also the same collection to merge from.
  3179.                         if (! $managedCol->isEmpty() && $managedCol !== $mergeCol) {
  3180.                             $managedCol->unwrap()->clear();
  3181.                             $managedCol->setDirty(true);
  3182.                             if (
  3183.                                 $assoc2['isOwningSide']
  3184.                                 && $assoc2['type'] === ClassMetadata::MANY_TO_MANY
  3185.                                 && $class->isChangeTrackingNotify()
  3186.                             ) {
  3187.                                 $this->scheduleForDirtyCheck($managedCopy);
  3188.                             }
  3189.                         }
  3190.                     }
  3191.                 }
  3192.             }
  3193.             if ($class->isChangeTrackingNotify()) {
  3194.                 // Just treat all properties as changed, there is no other choice.
  3195.                 $this->propertyChanged($managedCopy$namenull$prop->getValue($managedCopy));
  3196.             }
  3197.         }
  3198.     }
  3199.     /**
  3200.      * This method called by hydrators, and indicates that hydrator totally completed current hydration cycle.
  3201.      * Unit of work able to fire deferred events, related to loading events here.
  3202.      *
  3203.      * @internal should be called internally from object hydrators
  3204.      *
  3205.      * @return void
  3206.      */
  3207.     public function hydrationComplete()
  3208.     {
  3209.         $this->hydrationCompleteHandler->hydrationComplete();
  3210.     }
  3211.     private function clearIdentityMapForEntityName(string $entityName): void
  3212.     {
  3213.         if (! isset($this->identityMap[$entityName])) {
  3214.             return;
  3215.         }
  3216.         $visited = [];
  3217.         foreach ($this->identityMap[$entityName] as $entity) {
  3218.             $this->doDetach($entity$visitedfalse);
  3219.         }
  3220.     }
  3221.     private function clearEntityInsertionsForEntityName(string $entityName): void
  3222.     {
  3223.         foreach ($this->entityInsertions as $hash => $entity) {
  3224.             // note: performance optimization - `instanceof` is much faster than a function call
  3225.             if ($entity instanceof $entityName && get_class($entity) === $entityName) {
  3226.                 unset($this->entityInsertions[$hash]);
  3227.             }
  3228.         }
  3229.     }
  3230.     /**
  3231.      * @param mixed $identifierValue
  3232.      *
  3233.      * @return mixed the identifier after type conversion
  3234.      *
  3235.      * @throws MappingException if the entity has more than a single identifier.
  3236.      */
  3237.     private function convertSingleFieldIdentifierToPHPValue(ClassMetadata $class$identifierValue)
  3238.     {
  3239.         return $this->em->getConnection()->convertToPHPValue(
  3240.             $identifierValue,
  3241.             $class->getTypeOfField($class->getSingleIdentifierFieldName())
  3242.         );
  3243.     }
  3244.     /**
  3245.      * Given a flat identifier, this method will produce another flat identifier, but with all
  3246.      * association fields that are mapped as identifiers replaced by entity references, recursively.
  3247.      *
  3248.      * @param mixed[] $flatIdentifier
  3249.      *
  3250.      * @return array<string, mixed>
  3251.      */
  3252.     private function normalizeIdentifier(ClassMetadata $targetClass, array $flatIdentifier): array
  3253.     {
  3254.         $normalizedAssociatedId = [];
  3255.         foreach ($targetClass->getIdentifierFieldNames() as $name) {
  3256.             if (! array_key_exists($name$flatIdentifier)) {
  3257.                 continue;
  3258.             }
  3259.             if (! $targetClass->isSingleValuedAssociation($name)) {
  3260.                 $normalizedAssociatedId[$name] = $flatIdentifier[$name];
  3261.                 continue;
  3262.             }
  3263.             $targetIdMetadata $this->em->getClassMetadata($targetClass->getAssociationTargetClass($name));
  3264.             // Note: the ORM prevents using an entity with a composite identifier as an identifier association
  3265.             //       therefore, reset($targetIdMetadata->identifier) is always correct
  3266.             $normalizedAssociatedId[$name] = $this->em->getReference(
  3267.                 $targetIdMetadata->getName(),
  3268.                 $this->normalizeIdentifier(
  3269.                     $targetIdMetadata,
  3270.                     [(string) reset($targetIdMetadata->identifier) => $flatIdentifier[$name]]
  3271.                 )
  3272.             );
  3273.         }
  3274.         return $normalizedAssociatedId;
  3275.     }
  3276.     /**
  3277.      * Assign a post-insert generated ID to an entity
  3278.      *
  3279.      * This is used by EntityPersisters after they inserted entities into the database.
  3280.      * It will place the assigned ID values in the entity's fields and start tracking
  3281.      * the entity in the identity map.
  3282.      *
  3283.      * @param object $entity
  3284.      * @param mixed  $generatedId
  3285.      */
  3286.     final public function assignPostInsertId($entity$generatedId): void
  3287.     {
  3288.         $class   $this->em->getClassMetadata(get_class($entity));
  3289.         $idField $class->getSingleIdentifierFieldName();
  3290.         $idValue $this->convertSingleFieldIdentifierToPHPValue($class$generatedId);
  3291.         $oid     spl_object_id($entity);
  3292.         $class->reflFields[$idField]->setValue($entity$idValue);
  3293.         $this->entityIdentifiers[$oid]            = [$idField => $idValue];
  3294.         $this->entityStates[$oid]                 = self::STATE_MANAGED;
  3295.         $this->originalEntityData[$oid][$idField] = $idValue;
  3296.         $this->addToIdentityMap($entity);
  3297.     }
  3298. }