vendor/doctrine/orm/lib/Doctrine/ORM/PersistentCollection.php line 40

  1. <?php
  3. declare(strict_types=1);
  5. namespace Doctrine\ORM;
  7. use Doctrine\Common\Collections\AbstractLazyCollection;
  8. use Doctrine\Common\Collections\ArrayCollection;
  9. use Doctrine\Common\Collections\Collection;
  10. use Doctrine\Common\Collections\Criteria;
  11. use Doctrine\Common\Collections\Selectable;
  12. use Doctrine\ORM\Mapping\ClassMetadata;
  13. use ReturnTypeWillChange;
  14. use RuntimeException;
  16. use function array_combine;
  17. use function array_diff_key;
  18. use function array_map;
  19. use function array_values;
  20. use function array_walk;
  21. use function assert;
  22. use function get_class;
  23. use function is_object;
  24. use function spl_object_id;
  26. /**
  27.  * A PersistentCollection represents a collection of elements that have persistent state.
  28.  *
  29.  * Collections of entities represent only the associations (links) to those entities.
  30.  * That means, if the collection is part of a many-many mapping and you remove
  31.  * entities from the collection, only the links in the relation table are removed (on flush).
  32.  * Similarly, if you remove entities from a collection that is part of a one-many
  33.  * mapping this will only result in the nulling out of the foreign keys on flush.
  34.  *
  35.  * @psalm-template TKey of array-key
  36.  * @psalm-template T
  37.  * @template-extends AbstractLazyCollection<TKey,T>
  38.  * @template-implements Selectable<TKey,T>
  39.  */
  40. final class PersistentCollection extends AbstractLazyCollection implements Selectable
  41. {
  42.     /**
  43.      * A snapshot of the collection at the moment it was fetched from the database.
  44.      * This is used to create a diff of the collection at commit time.
  45.      *
  46.      * @psalm-var array<string|int, mixed>
  47.      */
  48.     private $snapshot = [];
  50.     /**
  51.      * The entity that owns this collection.
  52.      *
  53.      * @var object|null
  54.      */
  55.     private $owner;
  57.     /**
  58.      * The association mapping the collection belongs to.
  59.      * This is currently either a OneToManyMapping or a ManyToManyMapping.
  60.      *
  61.      * @psalm-var array<string, mixed>|null
  62.      */
  63.     private $association;
  65.     /**
  66.      * The EntityManager that manages the persistence of the collection.
  67.      *
  68.      * @var EntityManagerInterface|null
  69.      */
  70.     private $em;
  72.     /**
  73.      * The name of the field on the target entities that points to the owner
  74.      * of the collection. This is only set if the association is bi-directional.
  75.      *
  76.      * @var string|null
  77.      */
  78.     private $backRefFieldName;
  80.     /**
  81.      * The class descriptor of the collection's entity type.
  82.      *
  83.      * @var ClassMetadata|null
  84.      */
  85.     private $typeClass;
  87.     /**
  88.      * Whether the collection is dirty and needs to be synchronized with the database
  89.      * when the UnitOfWork that manages its persistent state commits.
  90.      *
  91.      * @var bool
  92.      */
  93.     private $isDirty = false;
  95.     /**
  96.      * Creates a new persistent collection.
  97.      *
  98.      * @param EntityManagerInterface $em    The EntityManager the collection will be associated with.
  99.      * @param ClassMetadata          $class The class descriptor of the entity type of this collection.
  100.      * @psalm-param Collection<TKey, T>&Selectable<TKey, T> $collection The collection elements.
  101.      */
  102.     public function __construct(EntityManagerInterface $em, $class, Collection $collection)
  103.     {
  104.         $this->collection  = $collection;
  105.         $this->em          = $em;
  106.         $this->typeClass   = $class;
  107.         $this->initialized = true;
  108.     }
  110.     /**
  111.      * INTERNAL:
  112.      * Sets the collection's owning entity together with the AssociationMapping that
  113.      * describes the association between the owner and the elements of the collection.
  114.      *
  115.      * @param object $entity
  116.      * @psalm-param array<string, mixed> $assoc
  117.      */
  118.     public function setOwner($entity, array $assoc): void
  119.     {
  120.         $this->owner            = $entity;
  121.         $this->association      = $assoc;
  122.         $this->backRefFieldName = $assoc['inversedBy'] ?: $assoc['mappedBy'];
  123.     }
  125.     /**
  126.      * INTERNAL:
  127.      * Gets the collection owner.
  128.      *
  129.      * @return object|null
  130.      */
  131.     public function getOwner()
  132.     {
  133.         return $this->owner;
  134.     }
  136.     /** @return Mapping\ClassMetadata */
  137.     public function getTypeClass(): Mapping\ClassMetadataInfo
  138.     {
  139.         assert($this->typeClass !== null);
  141.         return $this->typeClass;
  142.     }
  144.     private function getUnitOfWork(): UnitOfWork
  145.     {
  146.         assert($this->em !== null);
  148.         return $this->em->getUnitOfWork();
  149.     }
  151.     /**
  152.      * INTERNAL:
  153.      * Adds an element to a collection during hydration. This will automatically
  154.      * complete bidirectional associations in the case of a one-to-many association.
  155.      *
  156.      * @param mixed $element The element to add.
  157.      */
  158.     public function hydrateAdd($element): void
  159.     {
  160.         $this->unwrap()->add($element);
  162.         // If _backRefFieldName is set and its a one-to-many association,
  163.         // we need to set the back reference.
  164.         if ($this->backRefFieldName && $this->association['type'] === ClassMetadata::ONE_TO_MANY) {
  165.             assert($this->typeClass !== null);
  166.             // Set back reference to owner
  167.             $this->typeClass->reflFields[$this->backRefFieldName]->setValue(
  168.                 $element,
  169.                 $this->owner
  170.             );
  172.             $this->getUnitOfWork()->setOriginalEntityProperty(
  173.                 spl_object_id($element),
  174.                 $this->backRefFieldName,
  175.                 $this->owner
  176.             );
  177.         }
  178.     }
  180.     /**
  181.      * INTERNAL:
  182.      * Sets a keyed element in the collection during hydration.
  183.      *
  184.      * @param mixed $key     The key to set.
  185.      * @param mixed $element The element to set.
  186.      */
  187.     public function hydrateSet($key, $element): void
  188.     {
  189.         $this->unwrap()->set($key, $element);
  191.         // If _backRefFieldName is set, then the association is bidirectional
  192.         // and we need to set the back reference.
  193.         if ($this->backRefFieldName && $this->association['type'] === ClassMetadata::ONE_TO_MANY) {
  194.             assert($this->typeClass !== null);
  195.             // Set back reference to owner
  196.             $this->typeClass->reflFields[$this->backRefFieldName]->setValue(
  197.                 $element,
  198.                 $this->owner
  199.             );
  200.         }
  201.     }
  203.     /**
  204.      * Initializes the collection by loading its contents from the database
  205.      * if the collection is not yet initialized.
  206.      */
  207.     public function initialize(): void
  208.     {
  209.         if ($this->initialized || ! $this->association) {
  210.             return;
  211.         }
  213.         $this->doInitialize();
  215.         $this->initialized = true;
  216.     }
  218.     /**
  219.      * INTERNAL:
  220.      * Tells this collection to take a snapshot of its current state.
  221.      */
  222.     public function takeSnapshot(): void
  223.     {
  224.         $this->snapshot = $this->unwrap()->toArray();
  225.         $this->isDirty  = false;
  226.     }
  228.     /**
  229.      * INTERNAL:
  230.      * Returns the last snapshot of the elements in the collection.
  231.      *
  232.      * @psalm-return array<string|int, mixed> The last snapshot of the elements.
  233.      */
  234.     public function getSnapshot(): array
  235.     {
  236.         return $this->snapshot;
  237.     }
  239.     /**
  240.      * INTERNAL:
  241.      * getDeleteDiff
  242.      *
  243.      * @return mixed[]
  244.      */
  245.     public function getDeleteDiff(): array
  246.     {
  247.         $collectionItems = $this->unwrap()->toArray();
  249.         return array_values(array_diff_key(
  250.             array_combine(array_map('spl_object_id', $this->snapshot), $this->snapshot),
  251.             array_combine(array_map('spl_object_id', $collectionItems), $collectionItems)
  252.         ));
  253.     }
  255.     /**
  256.      * INTERNAL:
  257.      * getInsertDiff
  258.      *
  259.      * @return mixed[]
  260.      */
  261.     public function getInsertDiff(): array
  262.     {
  263.         $collectionItems = $this->unwrap()->toArray();
  265.         return array_values(array_diff_key(
  266.             array_combine(array_map('spl_object_id', $collectionItems), $collectionItems),
  267.             array_combine(array_map('spl_object_id', $this->snapshot), $this->snapshot)
  268.         ));
  269.     }
  271.     /**
  272.      * INTERNAL: Gets the association mapping of the collection.
  273.      *
  274.      * @psalm-return array<string, mixed>|null
  275.      */
  276.     public function getMapping(): ?array
  277.     {
  278.         return $this->association;
  279.     }
  281.     /**
  282.      * Marks this collection as changed/dirty.
  283.      */
  284.     private function changed(): void
  285.     {
  286.         if ($this->isDirty) {
  287.             return;
  288.         }
  290.         $this->isDirty = true;
  292.         if (
  293.             $this->association !== null &&
  294.             $this->association['isOwningSide'] &&
  295.             $this->association['type'] === ClassMetadata::MANY_TO_MANY &&
  296.             $this->owner &&
  297.             $this->em !== null &&
  298.             $this->em->getClassMetadata(get_class($this->owner))->isChangeTrackingNotify()
  299.         ) {
  300.             $this->getUnitOfWork()->scheduleForDirtyCheck($this->owner);
  301.         }
  302.     }
  304.     /**
  305.      * Gets a boolean flag indicating whether this collection is dirty which means
  306.      * its state needs to be synchronized with the database.
  307.      *
  308.      * @return bool TRUE if the collection is dirty, FALSE otherwise.
  309.      */
  310.     public function isDirty(): bool
  311.     {
  312.         return $this->isDirty;
  313.     }
  315.     /**
  316.      * Sets a boolean flag, indicating whether this collection is dirty.
  317.      *
  318.      * @param bool $dirty Whether the collection should be marked dirty or not.
  319.      */
  320.     public function setDirty($dirty): void
  321.     {
  322.         $this->isDirty = $dirty;
  323.     }
  325.     /**
  326.      * Sets the initialized flag of the collection, forcing it into that state.
  327.      *
  328.      * @param bool $bool
  329.      */
  330.     public function setInitialized($bool): void
  331.     {
  332.         $this->initialized = $bool;
  333.     }
  335.     /**
  336.      * {@inheritdoc}
  337.      */
  338.     public function remove($key)
  339.     {
  340.         // TODO: If the keys are persistent as well (not yet implemented)
  341.         //       and the collection is not initialized and orphanRemoval is
  342.         //       not used we can issue a straight SQL delete/update on the
  343.         //       association (table). Without initializing the collection.
  344.         $removed = parent::remove($key);
  346.         if (! $removed) {
  347.             return $removed;
  348.         }
  350.         $this->changed();
  352.         if (
  353.             $this->association !== null &&
  354.             $this->association['type'] & ClassMetadata::TO_MANY &&
  355.             $this->owner &&
  356.             $this->association['orphanRemoval']
  357.         ) {
  358.             $this->getUnitOfWork()->scheduleOrphanRemoval($removed);
  359.         }
  361.         return $removed;
  362.     }
  364.     /**
  365.      * {@inheritdoc}
  366.      */
  367.     public function removeElement($element): bool
  368.     {
  369.         $removed = parent::removeElement($element);
  371.         if (! $removed) {
  372.             return $removed;
  373.         }
  375.         $this->changed();
  377.         if (
  378.             $this->association !== null &&
  379.             $this->association['type'] & ClassMetadata::TO_MANY &&
  380.             $this->owner &&
  381.             $this->association['orphanRemoval']
  382.         ) {
  383.             $this->getUnitOfWork()->scheduleOrphanRemoval($element);
  384.         }
  386.         return $removed;
  387.     }
  389.     /**
  390.      * {@inheritdoc}
  391.      */
  392.     public function containsKey($key): bool
  393.     {
  394.         if (
  395.             ! $this->initialized && $this->association['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY
  396.             && isset($this->association['indexBy'])
  397.         ) {
  398.             $persister = $this->getUnitOfWork()->getCollectionPersister($this->association);
  400.             return $this->unwrap()->containsKey($key) || $persister->containsKey($this, $key);
  401.         }
  403.         return parent::containsKey($key);
  404.     }
  406.     /**
  407.      * {@inheritdoc}
  408.      *
  409.      * @template TMaybeContained
  410.      */
  411.     public function contains($element): bool
  412.     {
  413.         if (! $this->initialized && $this->association['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY) {
  414.             $persister = $this->getUnitOfWork()->getCollectionPersister($this->association);
  416.             return $this->unwrap()->contains($element) || $persister->contains($this, $element);
  417.         }
  419.         return parent::contains($element);
  420.     }
  422.     /**
  423.      * {@inheritdoc}
  424.      */
  425.     public function get($key)
  426.     {
  427.         if (
  428.             ! $this->initialized
  429.             && $this->association['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY
  430.             && isset($this->association['indexBy'])
  431.         ) {
  432.             assert($this->em !== null);
  433.             assert($this->typeClass !== null);
  434.             if (! $this->typeClass->isIdentifierComposite && $this->typeClass->isIdentifier($this->association['indexBy'])) {
  435.                 return $this->em->find($this->typeClass->name, $key);
  436.             }
  438.             return $this->getUnitOfWork()->getCollectionPersister($this->association)->get($this, $key);
  439.         }
  441.         return parent::get($key);
  442.     }
  444.     public function count(): int
  445.     {
  446.         if (! $this->initialized && $this->association !== null && $this->association['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY) {
  447.             $persister = $this->getUnitOfWork()->getCollectionPersister($this->association);
  449.             return $persister->count($this) + ($this->isDirty ? $this->unwrap()->count() : 0);
  450.         }
  452.         return parent::count();
  453.     }
  455.     /**
  456.      * {@inheritdoc}
  457.      */
  458.     public function set($key, $value): void
  459.     {
  460.         parent::set($key, $value);
  462.         $this->changed();
  464.         if (is_object($value) && $this->em) {
  465.             $this->getUnitOfWork()->cancelOrphanRemoval($value);
  466.         }
  467.     }
  469.     /**
  470.      * {@inheritdoc}
  471.      */
  472.     public function add($value): bool
  473.     {
  474.         $this->unwrap()->add($value);
  476.         $this->changed();
  478.         if (is_object($value) && $this->em) {
  479.             $this->getUnitOfWork()->cancelOrphanRemoval($value);
  480.         }
  482.         return true;
  483.     }
  485.     /* ArrayAccess implementation */
  487.     /**
  488.      * {@inheritdoc}
  489.      */
  490.     public function offsetExists($offset): bool
  491.     {
  492.         return $this->containsKey($offset);
  493.     }
  495.     /**
  496.      * {@inheritdoc}
  497.      */
  498.     #[ReturnTypeWillChange]
  499.     public function offsetGet($offset)
  500.     {
  501.         return $this->get($offset);
  502.     }
  504.     /**
  505.      * {@inheritdoc}
  506.      */
  507.     public function offsetSet($offset, $value): void
  508.     {
  509.         if (! isset($offset)) {
  510.             $this->add($value);
  512.             return;
  513.         }
  515.         $this->set($offset, $value);
  516.     }
  518.     /**
  519.      * {@inheritdoc}
  520.      *
  521.      * @return object|null
  522.      */
  523.     #[ReturnTypeWillChange]
  524.     public function offsetUnset($offset)
  525.     {
  526.         return $this->remove($offset);
  527.     }
  529.     public function isEmpty(): bool
  530.     {
  531.         return $this->unwrap()->isEmpty() && $this->count() === 0;
  532.     }
  534.     public function clear(): void
  535.     {
  536.         if ($this->initialized && $this->isEmpty()) {
  537.             $this->unwrap()->clear();
  539.             return;
  540.         }
  542.         $uow = $this->getUnitOfWork();
  544.         if (
  545.             $this->association['type'] & ClassMetadata::TO_MANY &&
  546.             $this->association['orphanRemoval'] &&
  547.             $this->owner
  548.         ) {
  549.             // we need to initialize here, as orphan removal acts like implicit cascadeRemove,
  550.             // hence for event listeners we need the objects in memory.
  551.             $this->initialize();
  553.             foreach ($this->unwrap() as $element) {
  554.                 $uow->scheduleOrphanRemoval($element);
  555.             }
  556.         }
  558.         $this->unwrap()->clear();
  560.         $this->initialized = true; // direct call, {@link initialize()} is too expensive
  562.         if ($this->association['isOwningSide'] && $this->owner) {
  563.             $this->changed();
  565.             $uow->scheduleCollectionDeletion($this);
  567.             $this->takeSnapshot();
  568.         }
  569.     }
  571.     /**
  572.      * Called by PHP when this collection is serialized. Ensures that only the
  573.      * elements are properly serialized.
  574.      *
  575.      * Internal note: Tried to implement Serializable first but that did not work well
  576.      *                with circular references. This solution seems simpler and works well.
  577.      *
  578.      * @return string[]
  579.      * @psalm-return array{0: string, 1: string}
  580.      */
  581.     public function __sleep(): array
  582.     {
  583.         return ['collection', 'initialized'];
  584.     }
  586.     /**
  587.      * Extracts a slice of $length elements starting at position $offset from the Collection.
  588.      *
  589.      * If $length is null it returns all elements from $offset to the end of the Collection.
  590.      * Keys have to be preserved by this method. Calling this method will only return the
  591.      * selected slice and NOT change the elements contained in the collection slice is called on.
  592.      *
  593.      * @param int      $offset
  594.      * @param int|null $length
  595.      *
  596.      * @return mixed[]
  597.      * @psalm-return array<TKey,T>
  598.      */
  599.     public function slice($offset, $length = null): array
  600.     {
  601.         if (! $this->initialized && ! $this->isDirty && $this->association['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY) {
  602.             $persister = $this->getUnitOfWork()->getCollectionPersister($this->association);
  604.             return $persister->slice($this, $offset, $length);
  605.         }
  607.         return parent::slice($offset, $length);
  608.     }
  610.     /**
  611.      * Cleans up internal state of cloned persistent collection.
  612.      *
  613.      * The following problems have to be prevented:
  614.      * 1. Added entities are added to old PC
  615.      * 2. New collection is not dirty, if reused on other entity nothing
  616.      * changes.
  617.      * 3. Snapshot leads to invalid diffs being generated.
  618.      * 4. Lazy loading grabs entities from old owner object.
  619.      * 5. New collection is connected to old owner and leads to duplicate keys.
  620.      */
  621.     public function __clone()
  622.     {
  623.         if (is_object($this->collection)) {
  624.             $this->collection = clone $this->collection;
  625.         }
  627.         $this->initialize();
  629.         $this->owner    = null;
  630.         $this->snapshot = [];
  632.         $this->changed();
  633.     }
  635.     /**
  636.      * Selects all elements from a selectable that match the expression and
  637.      * return a new collection containing these elements.
  638.      *
  639.      * @psalm-return Collection<TKey, T>
  640.      *
  641.      * @throws RuntimeException
  642.      */
  643.     public function matching(Criteria $criteria): Collection
  644.     {
  645.         if ($this->isDirty) {
  646.             $this->initialize();
  647.         }
  649.         if ($this->initialized) {
  650.             return $this->unwrap()->matching($criteria);
  651.         }
  653.         if ($this->association['type'] === ClassMetadata::MANY_TO_MANY) {
  654.             $persister = $this->getUnitOfWork()->getCollectionPersister($this->association);
  656.             return new ArrayCollection($persister->loadCriteria($this, $criteria));
  657.         }
  659.         $builder         = Criteria::expr();
  660.         $ownerExpression = $builder->eq($this->backRefFieldName, $this->owner);
  661.         $expression      = $criteria->getWhereExpression();
  662.         $expression      = $expression ? $builder->andX($expression, $ownerExpression) : $ownerExpression;
  664.         $criteria = clone $criteria;
  665.         $criteria->where($expression);
  666.         $criteria->orderBy($criteria->getOrderings() ?: $this->association['orderBy'] ?? []);
  668.         $persister = $this->getUnitOfWork()->getEntityPersister($this->association['targetEntity']);
  670.         return $this->association['fetch'] === ClassMetadata::FETCH_EXTRA_LAZY
  671.             ? new LazyCriteriaCollection($persister, $criteria)
  672.             : new ArrayCollection($persister->loadCriteria($criteria));
  673.     }
  675.     /**
  676.      * Retrieves the wrapped Collection instance.
  677.      *
  678.      * @return Collection<TKey, T>&Selectable<TKey, T>
  679.      */
  680.     public function unwrap(): Collection
  681.     {
  682.         assert($this->collection instanceof Collection);
  683.         assert($this->collection instanceof Selectable);
  685.         return $this->collection;
  686.     }
  688.     protected function doInitialize(): void
  689.     {
  690.         // Has NEW objects added through add(). Remember them.
  691.         $newlyAddedDirtyObjects = [];
  693.         if ($this->isDirty) {
  694.             $newlyAddedDirtyObjects = $this->unwrap()->toArray();
  695.         }
  697.         $this->unwrap()->clear();
  698.         $this->getUnitOfWork()->loadCollection($this);
  699.         $this->takeSnapshot();
  701.         if ($newlyAddedDirtyObjects) {
  702.             $this->restoreNewObjectsInDirtyCollection($newlyAddedDirtyObjects);
  703.         }
  704.     }
  706.     /**
  707.      * @param object[] $newObjects
  708.      *
  709.      * Note: the only reason why this entire looping/complexity is performed via `spl_object_id`
  710.      *       is because we want to prevent using `array_udiff()`, which is likely to cause very
  711.      *       high overhead (complexity of O(n^2)). `array_diff_key()` performs the operation in
  712.      *       core, which is faster than using a callback for comparisons
  713.      */
  714.     private function restoreNewObjectsInDirtyCollection(array $newObjects): void
  715.     {
  716.         $loadedObjects               = $this->unwrap()->toArray();
  717.         $newObjectsByOid             = array_combine(array_map('spl_object_id', $newObjects), $newObjects);
  718.         $loadedObjectsByOid          = array_combine(array_map('spl_object_id', $loadedObjects), $loadedObjects);
  719.         $newObjectsThatWereNotLoaded = array_diff_key($newObjectsByOid, $loadedObjectsByOid);
  721.         if ($newObjectsThatWereNotLoaded) {
  722.             // Reattach NEW objects added through add(), if any.
  723.             array_walk($newObjectsThatWereNotLoaded, [$this->unwrap(), 'add']);
  725.             $this->isDirty = true;
  726.         }
  727.     }
  728. }