793 lines
19 KiB
PHP
793 lines
19 KiB
PHP
<?php
|
|
/*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the LGPL. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\ORM;
|
|
|
|
use Doctrine\ORM\Mapping\ClassMetadata,
|
|
Doctrine\Common\Collections\Collection,
|
|
Doctrine\Common\Collections\ArrayCollection,
|
|
Closure;
|
|
|
|
/**
|
|
* A PersistentCollection represents a collection of elements that have persistent state.
|
|
*
|
|
* Collections of entities represent only the associations (links) to those entities.
|
|
* That means, if the collection is part of a many-many mapping and you remove
|
|
* entities from the collection, only the links in the relation table are removed (on flush).
|
|
* Similarly, if you remove entities from a collection that is part of a one-many
|
|
* mapping this will only result in the nulling out of the foreign keys on flush.
|
|
*
|
|
* @since 2.0
|
|
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
* @author Giorgio Sironi <piccoloprincipeazzurro@gmail.com>
|
|
* @todo Design for inheritance to allow custom implementations?
|
|
*/
|
|
final class PersistentCollection implements Collection
|
|
{
|
|
/**
|
|
* A snapshot of the collection at the moment it was fetched from the database.
|
|
* This is used to create a diff of the collection at commit time.
|
|
*
|
|
* @var array
|
|
*/
|
|
private $snapshot = array();
|
|
|
|
/**
|
|
* The entity that owns this collection.
|
|
*
|
|
* @var object
|
|
*/
|
|
private $owner;
|
|
|
|
/**
|
|
* The association mapping the collection belongs to.
|
|
* This is currently either a OneToManyMapping or a ManyToManyMapping.
|
|
*
|
|
* @var array
|
|
*/
|
|
private $association;
|
|
|
|
/**
|
|
* The EntityManager that manages the persistence of the collection.
|
|
*
|
|
* @var \Doctrine\ORM\EntityManager
|
|
*/
|
|
private $em;
|
|
|
|
/**
|
|
* The name of the field on the target entities that points to the owner
|
|
* of the collection. This is only set if the association is bi-directional.
|
|
*
|
|
* @var string
|
|
*/
|
|
private $backRefFieldName;
|
|
|
|
/**
|
|
* The class descriptor of the collection's entity type.
|
|
*/
|
|
private $typeClass;
|
|
|
|
/**
|
|
* Whether the collection is dirty and needs to be synchronized with the database
|
|
* when the UnitOfWork that manages its persistent state commits.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
private $isDirty = false;
|
|
|
|
/**
|
|
* Whether the collection has already been initialized.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
private $initialized = true;
|
|
|
|
/**
|
|
* The wrapped Collection instance.
|
|
*
|
|
* @var Collection
|
|
*/
|
|
private $coll;
|
|
|
|
/**
|
|
* Creates a new persistent collection.
|
|
*
|
|
* @param EntityManager $em The EntityManager the collection will be associated with.
|
|
* @param ClassMetadata $class The class descriptor of the entity type of this collection.
|
|
* @param array The collection elements.
|
|
*/
|
|
public function __construct(EntityManager $em, $class, $coll)
|
|
{
|
|
$this->coll = $coll;
|
|
$this->em = $em;
|
|
$this->typeClass = $class;
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* Sets the collection's owning entity together with the AssociationMapping that
|
|
* describes the association between the owner and the elements of the collection.
|
|
*
|
|
* @param object $entity
|
|
* @param AssociationMapping $assoc
|
|
*/
|
|
public function setOwner($entity, array $assoc)
|
|
{
|
|
$this->owner = $entity;
|
|
$this->association = $assoc;
|
|
$this->backRefFieldName = $assoc['inversedBy'] ?: $assoc['mappedBy'];
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* Gets the collection owner.
|
|
*
|
|
* @return object
|
|
*/
|
|
public function getOwner()
|
|
{
|
|
return $this->owner;
|
|
}
|
|
|
|
public function getTypeClass()
|
|
{
|
|
return $this->typeClass;
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* Adds an element to a collection during hydration. This will automatically
|
|
* complete bidirectional associations in the case of a one-to-many association.
|
|
*
|
|
* @param mixed $element The element to add.
|
|
*/
|
|
public function hydrateAdd($element)
|
|
{
|
|
$this->coll->add($element);
|
|
|
|
// If _backRefFieldName is set and its a one-to-many association,
|
|
// we need to set the back reference.
|
|
if ($this->backRefFieldName && $this->association['type'] === ClassMetadata::ONE_TO_MANY) {
|
|
// Set back reference to owner
|
|
$this->typeClass->reflFields[$this->backRefFieldName]->setValue(
|
|
$element, $this->owner
|
|
);
|
|
|
|
$this->em->getUnitOfWork()->setOriginalEntityProperty(
|
|
spl_object_hash($element), $this->backRefFieldName, $this->owner
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* Sets a keyed element in the collection during hydration.
|
|
*
|
|
* @param mixed $key The key to set.
|
|
* $param mixed $value The element to set.
|
|
*/
|
|
public function hydrateSet($key, $element)
|
|
{
|
|
$this->coll->set($key, $element);
|
|
|
|
// If _backRefFieldName is set, then the association is bidirectional
|
|
// and we need to set the back reference.
|
|
if ($this->backRefFieldName && $this->association['type'] === ClassMetadata::ONE_TO_MANY) {
|
|
// Set back reference to owner
|
|
$this->typeClass->reflFields[$this->backRefFieldName]->setValue(
|
|
$element, $this->owner
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Initializes the collection by loading its contents from the database
|
|
* if the collection is not yet initialized.
|
|
*/
|
|
public function initialize()
|
|
{
|
|
if ($this->initialized || ! $this->association) {
|
|
return;
|
|
}
|
|
|
|
// Has NEW objects added through add(). Remember them.
|
|
$newObjects = array();
|
|
|
|
if ($this->isDirty) {
|
|
$newObjects = $this->coll->toArray();
|
|
}
|
|
|
|
$this->coll->clear();
|
|
$this->em->getUnitOfWork()->loadCollection($this);
|
|
$this->takeSnapshot();
|
|
|
|
// Reattach NEW objects added through add(), if any.
|
|
if ($newObjects) {
|
|
foreach ($newObjects as $obj) {
|
|
$this->coll->add($obj);
|
|
}
|
|
|
|
$this->isDirty = true;
|
|
}
|
|
|
|
$this->initialized = true;
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* Tells this collection to take a snapshot of its current state.
|
|
*/
|
|
public function takeSnapshot()
|
|
{
|
|
$this->snapshot = $this->coll->toArray();
|
|
$this->isDirty = false;
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* Returns the last snapshot of the elements in the collection.
|
|
*
|
|
* @return array The last snapshot of the elements.
|
|
*/
|
|
public function getSnapshot()
|
|
{
|
|
return $this->snapshot;
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* getDeleteDiff
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getDeleteDiff()
|
|
{
|
|
return array_udiff_assoc(
|
|
$this->snapshot,
|
|
$this->coll->toArray(),
|
|
function($a, $b) { return $a === $b ? 0 : 1; }
|
|
);
|
|
}
|
|
|
|
/**
|
|
* INTERNAL:
|
|
* getInsertDiff
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getInsertDiff()
|
|
{
|
|
return array_udiff_assoc(
|
|
$this->coll->toArray(),
|
|
$this->snapshot,
|
|
function($a, $b) { return $a === $b ? 0 : 1; }
|
|
);
|
|
}
|
|
|
|
/**
|
|
* INTERNAL: Gets the association mapping of the collection.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getMapping()
|
|
{
|
|
return $this->association;
|
|
}
|
|
|
|
/**
|
|
* Marks this collection as changed/dirty.
|
|
*/
|
|
private function changed()
|
|
{
|
|
if ($this->isDirty) {
|
|
return;
|
|
}
|
|
|
|
$this->isDirty = true;
|
|
|
|
if ($this->association !== null &&
|
|
$this->association['isOwningSide'] &&
|
|
$this->association['type'] === ClassMetadata::MANY_TO_MANY &&
|
|
$this->owner &&
|
|
$this->em->getClassMetadata(get_class($this->owner))->isChangeTrackingNotify()) {
|
|
$this->em->getUnitOfWork()->scheduleForDirtyCheck($this->owner);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets a boolean flag indicating whether this collection is dirty which means
|
|
* its state needs to be synchronized with the database.
|
|
*
|
|
* @return boolean TRUE if the collection is dirty, FALSE otherwise.
|
|
*/
|
|
public function isDirty()
|
|
{
|
|
return $this->isDirty;
|
|
}
|
|
|
|
/**
|
|
* Sets a boolean flag, indicating whether this collection is dirty.
|
|
*
|
|
* @param boolean $dirty Whether the collection should be marked dirty or not.
|
|
*/
|
|
public function setDirty($dirty)
|
|
{
|
|
$this->isDirty = $dirty;
|
|
}
|
|
|
|
/**
|
|
* Sets the initialized flag of the collection, forcing it into that state.
|
|
*
|
|
* @param boolean $bool
|
|
*/
|
|
public function setInitialized($bool)
|
|
{
|
|
$this->initialized = $bool;
|
|
}
|
|
|
|
/**
|
|
* Checks whether this collection has been initialized.
|
|
*
|
|
* @return boolean
|
|
*/
|
|
public function isInitialized()
|
|
{
|
|
return $this->initialized;
|
|
}
|
|
|
|
/** {@inheritdoc} */
|
|
public function first()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->first();
|
|
}
|
|
|
|
/** {@inheritdoc} */
|
|
public function last()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->last();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function remove($key)
|
|
{
|
|
// TODO: If the keys are persistent as well (not yet implemented)
|
|
// and the collection is not initialized and orphanRemoval is
|
|
// not used we can issue a straight SQL delete/update on the
|
|
// association (table). Without initializing the collection.
|
|
$this->initialize();
|
|
|
|
$removed = $this->coll->remove($key);
|
|
|
|
if ( ! $removed) {
|
|
return $removed;
|
|
}
|
|
|
|
$this->changed();
|
|
|
|
if ($this->association !== null &&
|
|
$this->association['type'] & ClassMetadata::TO_MANY &&
|
|
$this->owner &&
|
|
$this->association['orphanRemoval']) {
|
|
$this->em->getUnitOfWork()->scheduleOrphanRemoval($removed);
|
|
}
|
|
|
|
return $removed;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function removeElement($element)
|
|
{
|
|
if ( ! $this->initialized && $this->association['fetch'] === Mapping\ClassMetadataInfo::FETCH_EXTRA_LAZY) {
|
|
if ($this->coll->contains($element)) {
|
|
return $this->coll->removeElement($element);
|
|
}
|
|
|
|
$persister = $this->em->getUnitOfWork()->getCollectionPersister($this->association);
|
|
|
|
if ($persister->removeElement($this, $element)) {
|
|
return $element;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
$this->initialize();
|
|
|
|
$removed = $this->coll->removeElement($element);
|
|
|
|
if ( ! $removed) {
|
|
return $removed;
|
|
}
|
|
|
|
$this->changed();
|
|
|
|
if ($this->association !== null &&
|
|
$this->association['type'] & ClassMetadata::TO_MANY &&
|
|
$this->owner &&
|
|
$this->association['orphanRemoval']) {
|
|
$this->em->getUnitOfWork()->scheduleOrphanRemoval($element);
|
|
}
|
|
|
|
return $removed;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function containsKey($key)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->containsKey($key);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function contains($element)
|
|
{
|
|
if ( ! $this->initialized && $this->association['fetch'] === Mapping\ClassMetadataInfo::FETCH_EXTRA_LAZY) {
|
|
$persister = $this->em->getUnitOfWork()->getCollectionPersister($this->association);
|
|
|
|
return $this->coll->contains($element) || $persister->contains($this, $element);
|
|
}
|
|
|
|
$this->initialize();
|
|
|
|
return $this->coll->contains($element);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function exists(Closure $p)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->exists($p);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function indexOf($element)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->indexOf($element);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function get($key)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->get($key);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getKeys()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->getKeys();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getValues()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->getValues();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function count()
|
|
{
|
|
if ( ! $this->initialized && $this->association['fetch'] === Mapping\ClassMetadataInfo::FETCH_EXTRA_LAZY) {
|
|
$persister = $this->em->getUnitOfWork()->getCollectionPersister($this->association);
|
|
|
|
return $persister->count($this) + ($this->isDirty ? $this->coll->count() : 0);
|
|
}
|
|
|
|
$this->initialize();
|
|
|
|
return $this->coll->count();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function set($key, $value)
|
|
{
|
|
$this->initialize();
|
|
|
|
$this->coll->set($key, $value);
|
|
|
|
$this->changed();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function add($value)
|
|
{
|
|
$this->coll->add($value);
|
|
|
|
$this->changed();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function isEmpty()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->isEmpty();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function getIterator()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->getIterator();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function map(Closure $func)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->map($func);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function filter(Closure $p)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->filter($p);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function forAll(Closure $p)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->forAll($p);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function partition(Closure $p)
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->partition($p);
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function toArray()
|
|
{
|
|
$this->initialize();
|
|
|
|
return $this->coll->toArray();
|
|
}
|
|
|
|
/**
|
|
* {@inheritdoc}
|
|
*/
|
|
public function clear()
|
|
{
|
|
if ($this->initialized && $this->isEmpty()) {
|
|
return;
|
|
}
|
|
|
|
$uow = $this->em->getUnitOfWork();
|
|
|
|
if ($this->association['type'] & ClassMetadata::TO_MANY &&
|
|
$this->association['orphanRemoval'] &&
|
|
$this->owner) {
|
|
// we need to initialize here, as orphan removal acts like implicit cascadeRemove,
|
|
// hence for event listeners we need the objects in memory.
|
|
$this->initialize();
|
|
|
|
foreach ($this->coll as $element) {
|
|
$uow->scheduleOrphanRemoval($element);
|
|
}
|
|
}
|
|
|
|
$this->coll->clear();
|
|
|
|
$this->initialized = true; // direct call, {@link initialize()} is too expensive
|
|
|
|
if ($this->association['isOwningSide']) {
|
|
$this->changed();
|
|
|
|
$uow->scheduleCollectionDeletion($this);
|
|
|
|
$this->takeSnapshot();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Called by PHP when this collection is serialized. Ensures that only the
|
|
* elements are properly serialized.
|
|
*
|
|
* @internal Tried to implement Serializable first but that did not work well
|
|
* with circular references. This solution seems simpler and works well.
|
|
*/
|
|
public function __sleep()
|
|
{
|
|
return array('coll', 'initialized');
|
|
}
|
|
|
|
/* ArrayAccess implementation */
|
|
|
|
/**
|
|
* @see containsKey()
|
|
*/
|
|
public function offsetExists($offset)
|
|
{
|
|
return $this->containsKey($offset);
|
|
}
|
|
|
|
/**
|
|
* @see get()
|
|
*/
|
|
public function offsetGet($offset)
|
|
{
|
|
return $this->get($offset);
|
|
}
|
|
|
|
/**
|
|
* @see add()
|
|
* @see set()
|
|
*/
|
|
public function offsetSet($offset, $value)
|
|
{
|
|
if ( ! isset($offset)) {
|
|
return $this->add($value);
|
|
}
|
|
|
|
return $this->set($offset, $value);
|
|
}
|
|
|
|
/**
|
|
* @see remove()
|
|
*/
|
|
public function offsetUnset($offset)
|
|
{
|
|
return $this->remove($offset);
|
|
}
|
|
|
|
public function key()
|
|
{
|
|
return $this->coll->key();
|
|
}
|
|
|
|
/**
|
|
* Gets the element of the collection at the current iterator position.
|
|
*/
|
|
public function current()
|
|
{
|
|
return $this->coll->current();
|
|
}
|
|
|
|
/**
|
|
* Moves the internal iterator position to the next element.
|
|
*/
|
|
public function next()
|
|
{
|
|
return $this->coll->next();
|
|
}
|
|
|
|
/**
|
|
* Retrieves the wrapped Collection instance.
|
|
*
|
|
* @return \Doctrine\Common\Collections\Collection
|
|
*/
|
|
public function unwrap()
|
|
{
|
|
return $this->coll;
|
|
}
|
|
|
|
/**
|
|
* Extract a slice of $length elements starting at position $offset from the Collection.
|
|
*
|
|
* If $length is null it returns all elements from $offset to the end of the Collection.
|
|
* Keys have to be preserved by this method. Calling this method will only return the
|
|
* selected slice and NOT change the elements contained in the collection slice is called on.
|
|
*
|
|
* @param int $offset
|
|
* @param int $length
|
|
*
|
|
* @return array
|
|
*/
|
|
public function slice($offset, $length = null)
|
|
{
|
|
if ( ! $this->initialized && ! $this->isDirty && $this->association['fetch'] === Mapping\ClassMetadataInfo::FETCH_EXTRA_LAZY) {
|
|
$persister = $this->em->getUnitOfWork()->getCollectionPersister($this->association);
|
|
|
|
return $persister->slice($this, $offset, $length);
|
|
}
|
|
|
|
$this->initialize();
|
|
|
|
return $this->coll->slice($offset, $length);
|
|
}
|
|
|
|
/**
|
|
* Cleanup internal state of cloned persistent collection.
|
|
*
|
|
* The following problems have to be prevented:
|
|
* 1. Added entities are added to old PC
|
|
* 2. New collection is not dirty, if reused on other entity nothing
|
|
* changes.
|
|
* 3. Snapshot leads to invalid diffs being generated.
|
|
* 4. Lazy loading grabs entities from old owner object.
|
|
* 5. New collection is connected to old owner and leads to duplicate keys.
|
|
*/
|
|
public function __clone()
|
|
{
|
|
if (is_object($this->coll)) {
|
|
$this->coll = clone $this->coll;
|
|
}
|
|
|
|
$this->initialize();
|
|
$this->owner = null;
|
|
|
|
$this->snapshot = array();
|
|
|
|
$this->changed();
|
|
}
|
|
}
|