1
0
mirror of synced 2024-12-15 15:46:02 +03:00
doctrine2/lib/Doctrine/ORM/PersistentCollection.php

452 lines
12 KiB
PHP
Raw Normal View History

2007-01-02 18:24:43 +03:00
<?php
/*
* $Id$
2007-01-02 18:24:43 +03:00
*
* 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>.
2007-01-02 18:24:43 +03:00
*/
namespace Doctrine\ORM;
use Doctrine\Common\DoctrineException;
2009-01-29 20:00:44 +03:00
use Doctrine\ORM\Mapping\AssociationMapping;
2007-01-02 18:24:43 +03:00
/**
2009-01-29 20:00:44 +03:00
* A PersistentCollection represents a collection of elements that have persistent state.
2009-06-14 21:34:28 +04:00
*
2009-01-29 20:00:44 +03:00
* Collections of entities represent only the associations (links) to those entities.
2008-08-16 23:40:59 +04:00
* 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).
2008-08-16 23:40:59 +04:00
* 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.
* If you want entities in a one-many collection to be removed when
2008-08-16 23:40:59 +04:00
* they're removed from the collection, use deleteOrphans => true on the one-many
* mapping.
2007-01-02 18:24:43 +03:00
*
2008-08-16 23:40:59 +04:00
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
2009-01-04 19:15:32 +03:00
* @since 2.0
2008-09-12 16:34:46 +04:00
* @version $Revision: 4930 $
2008-08-16 23:40:59 +04:00
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Roman Borschel <roman@code-factory.org>
2007-01-02 18:24:43 +03:00
*/
final class PersistentCollection extends \Doctrine\Common\Collections\Collection
{
2008-08-16 23:40:59 +04:00
/**
* The base type of the collection.
*
* @var string
*/
private $_type;
2007-05-16 23:20:55 +04:00
/**
* 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
2007-05-16 23:20:55 +04:00
*/
private $_snapshot = array();
2007-01-02 18:24:43 +03:00
/**
* The entity that owns this collection.
*
* @var object
2007-01-02 18:24:43 +03:00
*/
private $_owner;
2007-01-02 18:24:43 +03:00
/**
* The association mapping the collection belongs to.
* This is currently either a OneToManyMapping or a ManyToManyMapping.
*
* @var Doctrine\ORM\Mapping\AssociationMapping
2007-01-02 18:24:43 +03:00
*/
private $_association;
2007-01-02 18:24:43 +03:00
/**
* The name of the field that is used for collection indexing.
*
* @var string
2007-01-02 18:24:43 +03:00
*/
private $_keyField;
/**
* 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;
/**
* Hydration flag.
*
* @var boolean
* @see setHydrationFlag()
*/
private $_hydrationFlag = false;
2007-01-02 18:24:43 +03:00
2009-01-29 20:00:44 +03:00
/**
* The class descriptor of the owning entity.
*/
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. */
private $_initialized = false;
2007-01-02 18:24:43 +03:00
/**
* Creates a new persistent collection.
2007-01-02 18:24:43 +03:00
*/
public function __construct(EntityManager $em, $class, array $data = array())
2007-01-02 18:24:43 +03:00
{
2009-01-29 20:00:44 +03:00
parent::__construct($data);
$this->_type = $class->name;
2009-01-04 19:15:32 +03:00
$this->_em = $em;
$this->_typeClass = $class;
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
* INTERNAL: Sets the key column for this collection
2007-01-02 18:24:43 +03:00
*
* @param string $column
2007-05-16 23:20:55 +04:00
* @return Doctrine_Collection
2007-01-02 18:24:43 +03:00
*/
2008-03-23 14:30:29 +03:00
public function setKeyField($fieldName)
2007-01-02 18:24:43 +03:00
{
2008-03-23 14:30:29 +03:00
$this->_keyField = $fieldName;
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
* INTERNAL: returns the name of the key column
2007-01-02 18:24:43 +03:00
*
* @return string
*/
2008-03-23 14:30:29 +03:00
public function getKeyField()
2007-01-02 18:24:43 +03:00
{
2008-03-23 14:30:29 +03:00
return $this->_keyField;
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
* INTERNAL:
* Sets the collection owner. Used (only?) during hydration.
2007-01-02 18:24:43 +03:00
*
* @param object $entity
* @param AssociationMapping $assoc
2007-01-02 18:24:43 +03:00
*/
public function setOwner($entity, AssociationMapping $assoc)
2007-01-02 18:24:43 +03:00
{
$this->_owner = $entity;
$this->_association = $assoc;
if ($assoc->isInverseSide()) {
// For sure bi-directional
$this->_backRefFieldName = $assoc->mappedByFieldName;
} else {
$targetClass = $this->_em->getClassMetadata($assoc->targetEntityName);
if (isset($targetClass->inverseMappings[$assoc->sourceFieldName])) {
// Bi-directional
$this->_backRefFieldName = $targetClass->inverseMappings[$assoc->sourceFieldName]
->sourceFieldName;
2007-01-02 18:24:43 +03:00
}
}
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
* INTERNAL:
* Gets the collection owner.
2007-01-02 18:24:43 +03:00
*
* @return object
2007-01-02 18:24:43 +03:00
*/
public function getOwner()
2007-01-02 18:24:43 +03:00
{
return $this->_owner;
2007-01-02 18:24:43 +03:00
}
/**
* Gets the class descriptor for the owning entity class.
*
* @return Doctrine\ORM\Mapping\ClassMetadata
*/
public function getOwnerClass()
{
return $this->_typeClass;
}
2007-01-02 18:24:43 +03:00
/**
2009-01-29 20:00:44 +03:00
* Removes an element from the collection.
2007-01-02 18:24:43 +03:00
*
* @param mixed $key
* @return boolean
* @override
2007-01-02 18:24:43 +03:00
*/
public function remove($key)
{
//TODO: delete entity if shouldDeleteOrphans
/*if ($this->_association->isOneToMany() && $this->_association->shouldDeleteOrphans()) {
$this->_em->delete($removed);
}*/
$removed = parent::remove($key);
if ($removed) {
$this->_changed();
}
return $removed;
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
2008-08-16 23:40:59 +04:00
* When the collection is a Map this is like put(key,value)/add(key,value).
* When the collection is a List this is like add(position,value).
*
2007-01-02 18:24:43 +03:00
* @param integer $key
2008-08-16 23:40:59 +04:00
* @param mixed $value
* @override
2007-01-02 18:24:43 +03:00
*/
public function set($key, $value)
2007-01-02 18:24:43 +03:00
{
2009-01-04 19:15:32 +03:00
parent::set($key, $value);
if ( ! $this->_hydrationFlag) {
$this->_changed();
}
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
2009-01-29 20:00:44 +03:00
* Adds an element to the collection.
*
2008-08-16 23:40:59 +04:00
* @param mixed $value
* @param string $key
* @return boolean Always TRUE.
* @override
2007-01-02 18:24:43 +03:00
*/
public function add($value)
2007-01-02 18:24:43 +03:00
{
parent::add($value);
2009-01-29 20:00:44 +03:00
if ($this->_hydrationFlag) {
if ($this->_backRefFieldName) {
// Set back reference to owner
if ($this->_association->isOneToMany()) {
$this->_typeClass->getReflectionProperty($this->_backRefFieldName)
->setValue($value, $this->_owner);
} else {
// ManyToMany
$this->_typeClass->getReflectionProperty($this->_backRefFieldName)
->getValue($value)->add($this->_owner);
}
}
} else {
$this->_changed();
}
2007-01-02 18:24:43 +03:00
return true;
}
2008-08-16 23:40:59 +04:00
/**
* Adds all elements of the other collection to this collection.
2008-08-16 23:40:59 +04:00
*
* @param object $otherCollection
2008-08-16 23:40:59 +04:00
* @todo Impl
* @override
2008-08-16 23:40:59 +04:00
*/
public function addAll($otherCollection)
{
2009-01-04 19:15:32 +03:00
parent::addAll($otherCollection);
2008-08-16 23:40:59 +04:00
//...
//TODO: Register collection as dirty with the UoW if necessary
//$this->_changed();
}
/**
* Checks whether an element is contained in the collection.
* This is an O(n) operation.
*/
public function contains($element)
{
if ( ! $this->_initialized) {
//TODO: Probably need to hit the database here...?
//return $this->_checkElementExistence($element);
}
return parent::contains($element);
}
/**
* @override
*/
public function count()
{
if ( ! $this->_initialized) {
//TODO: Initialize
}
return parent::count();
}
private function _checkElementExistence($element)
{
}
private function _initialize()
{
}
/**
* INTERNAL:
* Sets a flag that indicates whether the collection is currently being hydrated.
*
* If the flag is set to TRUE, this has the following consequences:
*
* 1) During hydration, bidirectional associations are completed automatically
* by setting the back reference.
* 2) During hydration no change notifications are reported to the UnitOfWork.
* That means add() etc. do not cause the collection to be scheduled
* for an update.
*
* @param boolean $bool
*/
public function setHydrationFlag($bool)
{
$this->_hydrationFlag = $bool;
2007-01-02 18:24:43 +03:00
}
2007-01-02 18:24:43 +03:00
/**
* INTERNAL:
* Tells this collection to take a snapshot of its current state.
2007-05-16 23:20:55 +04:00
*/
public function takeSnapshot()
2007-05-16 23:20:55 +04:00
{
$this->_snapshot = $this->_elements;
2007-05-16 23:20:55 +04:00
}
2007-05-16 23:20:55 +04:00
/**
* INTERNAL:
* Returns the last snapshot of the elements in the collection.
2007-05-16 23:20:55 +04:00
*
* @return array The last snapshot of the elements.
2007-05-16 23:20:55 +04:00
*/
public function getSnapshot()
2007-05-16 23:20:55 +04:00
{
return $this->_snapshot;
}
2007-11-16 01:45:09 +03:00
/**
* INTERNAL:
* getDeleteDiff
2007-11-16 01:45:09 +03:00
*
2008-08-16 23:40:59 +04:00
* @return array
2007-11-16 01:45:09 +03:00
*/
2007-05-17 01:28:33 +04:00
public function getDeleteDiff()
{
return array_udiff($this->_snapshot, $this->_elements, array($this, '_compareRecords'));
2007-05-17 01:28:33 +04:00
}
2007-11-16 01:45:09 +03:00
/**
2008-08-16 23:40:59 +04:00
* INTERNAL getInsertDiff
2007-11-16 01:45:09 +03:00
*
2008-08-16 23:40:59 +04:00
* @return array
2007-11-16 01:45:09 +03:00
*/
2007-05-17 01:28:33 +04:00
public function getInsertDiff()
{
return array_udiff($this->_elements, $this->_snapshot, array($this, '_compareRecords'));
}
/**
* Compares two records. To be used on _snapshot diffs using array_udiff.
2008-08-16 23:40:59 +04:00
*
* @return integer
*/
private function _compareRecords($a, $b)
{
return $a === $b ? 0 : 1;
2007-05-17 01:28:33 +04:00
}
/**
* INTERNAL: Gets the association mapping of the collection.
2008-08-16 23:40:59 +04:00
*
* @return Doctrine\ORM\Mapping\AssociationMapping
*/
2008-08-16 23:40:59 +04:00
public function getMapping()
{
return $this->_association;
}
2008-08-16 23:40:59 +04:00
/**
* Clears the collection.
*/
public function clear()
{
2008-08-16 23:40:59 +04:00
//TODO: Register collection as dirty with the UoW if necessary
//TODO: If oneToMany() && shouldDeleteOrphan() delete entities
/*if ($this->_association->isOneToMany() && $this->_association->shouldDeleteOrphans()) {
foreach ($this->_data as $entity) {
$this->_em->delete($entity);
}
}*/
2009-01-04 19:15:32 +03:00
parent::clear();
$this->_changed();
2008-08-16 23:40:59 +04:00
}
private function _changed()
{
$this->_isDirty = true;
}
/**
* Gets a boolean flag indicating whether this colleciton 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;
}
/* Serializable implementation */
/**
* 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('_elements');
}
}