1
0
mirror of synced 2024-12-14 07:06:04 +03:00
doctrine2/lib/Doctrine/ORM/Persisters/AbstractCollectionPersister.php

286 lines
8.3 KiB
PHP
Raw Normal View History

2008-08-16 23:40:59 +04:00
<?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
2012-05-26 16:37:00 +04:00
* and is licensed under the MIT license. For more information, see
* <http://www.doctrine-project.org>.
*/
2008-08-16 23:40:59 +04:00
2009-01-29 20:00:44 +03:00
namespace Doctrine\ORM\Persisters;
2012-10-12 15:53:20 +04:00
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\PersistentCollection;
2009-01-29 20:00:44 +03:00
/**
* Base class for all collection persisters.
*
* @since 2.0
* @author Roman Borschel <roman@code-factory.org>
*/
abstract class AbstractCollectionPersister
2008-08-16 23:40:59 +04:00
{
/**
* @var EntityManager
*/
protected $em;
/**
* @var \Doctrine\DBAL\Connection
*/
protected $conn;
/**
* @var \Doctrine\ORM\UnitOfWork
*/
protected $uow;
2012-06-12 03:14:17 +04:00
/**
* The database platform.
*
* @var \Doctrine\DBAL\Platforms\AbstractPlatform
*/
protected $platform;
2012-06-02 03:44:26 +04:00
/**
* The quote strategy.
*
* @var \Doctrine\ORM\Mapping\QuoteStrategy
*/
protected $quoteStrategy;
/**
2010-04-10 02:00:36 +04:00
* Initializes a new instance of a class derived from AbstractCollectionPersister.
*
* @param \Doctrine\ORM\EntityManager $em
*/
public function __construct(EntityManager $em)
{
$this->em = $em;
$this->uow = $em->getUnitOfWork();
$this->conn = $em->getConnection();
$this->platform = $this->conn->getDatabasePlatform();
2012-06-12 03:14:17 +04:00
$this->quoteStrategy = $em->getConfiguration()->getQuoteStrategy();
}
/**
* Deletes the persistent state represented by the given collection.
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
public function delete(PersistentCollection $coll)
2008-08-16 23:40:59 +04:00
{
$mapping = $coll->getMapping();
2011-12-20 01:56:19 +04:00
if ( ! $mapping['isOwningSide']) {
return; // ignore inverse side
2008-08-16 23:40:59 +04:00
}
2011-12-20 01:56:19 +04:00
$sql = $this->getDeleteSQL($coll);
2012-08-12 22:17:47 +04:00
$this->conn->executeUpdate($sql, $this->getDeleteSQLParameters($coll));
2008-08-16 23:40:59 +04:00
}
/**
* Gets the SQL statement for deleting the given collection.
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
abstract protected function getDeleteSQL(PersistentCollection $coll);
/**
* Gets the SQL parameters for the corresponding SQL statement to delete
* the given collection.
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
abstract protected function getDeleteSQLParameters(PersistentCollection $coll);
/**
* Updates the given collection, synchronizing it's state with the database
* by inserting, updating and deleting individual elements.
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
public function update(PersistentCollection $coll)
{
$mapping = $coll->getMapping();
2011-12-20 01:56:19 +04:00
if ( ! $mapping['isOwningSide']) {
return; // ignore inverse side
}
2011-12-20 01:56:19 +04:00
$this->deleteRows($coll);
$this->insertRows($coll);
}
2011-12-20 01:56:19 +04:00
/**
* Delete rows
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
public function deleteRows(PersistentCollection $coll)
2011-12-20 01:56:19 +04:00
{
$diff = $coll->getDeleteDiff();
$sql = $this->getDeleteRowSQL($coll);
2011-12-20 01:56:19 +04:00
foreach ($diff as $element) {
$this->conn->executeUpdate($sql, $this->getDeleteRowSQLParameters($coll, $element));
}
2008-08-16 23:40:59 +04:00
}
2011-12-20 01:56:19 +04:00
/**
* Insert rows
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
public function insertRows(PersistentCollection $coll)
2009-01-29 20:00:44 +03:00
{
$diff = $coll->getInsertDiff();
$sql = $this->getInsertRowSQL($coll);
2011-12-20 01:56:19 +04:00
foreach ($diff as $element) {
$this->conn->executeUpdate($sql, $this->getInsertRowSQLParameters($coll, $element));
}
2009-01-29 20:00:44 +03:00
}
/**
* Count the size of this persistent collection
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
2012-08-12 22:17:47 +04:00
*
2012-10-20 07:39:51 +04:00
* @return integer
*/
public function count(PersistentCollection $coll)
{
throw new \BadMethodCallException("Counting the size of this persistent collection is not supported by this CollectionPersister.");
}
/**
* Slice elements
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
* @param integer $offset
* @param integer $length
2012-08-12 22:17:47 +04:00
*
* @return array
*/
public function slice(PersistentCollection $coll, $offset, $length = null)
{
throw new \BadMethodCallException("Slicing elements is not supported by this CollectionPersister.");
}
/**
* Check for existance of an element
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
2012-10-23 02:03:05 +04:00
* @param object $element
2012-08-12 22:17:47 +04:00
*
2012-10-20 07:39:51 +04:00
* @return boolean
*/
public function contains(PersistentCollection $coll, $element)
{
throw new \BadMethodCallException("Checking for existance of an element is not supported by this CollectionPersister.");
}
/**
* Check for existance of a key
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
* @param mixed $key
2012-08-12 22:17:47 +04:00
*
2012-10-20 07:39:51 +04:00
* @return boolean
*/
public function containsKey(PersistentCollection $coll, $key)
{
throw new \BadMethodCallException("Checking for existance of a key is not supported by this CollectionPersister.");
}
/**
* Remove an element
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
* @param object $element
2012-08-12 22:17:47 +04:00
*
2012-10-20 07:39:51 +04:00
* @return mixed
*/
public function removeElement(PersistentCollection $coll, $element)
{
throw new \BadMethodCallException("Removing an element is not supported by this CollectionPersister.");
}
/**
* Remove an element by key
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
2012-08-12 22:17:47 +04:00
*
2012-10-20 07:39:51 +04:00
* @param mixed $key
*/
public function removeKey(PersistentCollection $coll, $key)
{
throw new \BadMethodCallException("Removing a key is not supported by this CollectionPersister.");
}
/**
* Get an element by key
*
2012-10-20 07:39:51 +04:00
* @param \Doctrine\ORM\PersistentCollection $coll
* @param mixed $index
2012-08-13 03:02:01 +04:00
*
2012-10-23 02:03:05 +04:00
* @return mixed
*/
public function get(PersistentCollection $coll, $index)
{
throw new \BadMethodCallException("Selecting a collection by index is not supported by this CollectionPersister.");
}
/**
* Gets the SQL statement used for deleting a row from the collection.
2011-12-20 01:56:19 +04:00
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
abstract protected function getDeleteRowSQL(PersistentCollection $coll);
2009-01-29 20:00:44 +03:00
/**
* Gets the SQL parameters for the corresponding SQL statement to delete the given
* element from the given collection.
*
* @param \Doctrine\ORM\PersistentCollection $coll
* @param mixed $element
*/
abstract protected function getDeleteRowSQLParameters(PersistentCollection $coll, $element);
/**
* Gets the SQL statement used for updating a row in the collection.
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
abstract protected function getUpdateRowSQL(PersistentCollection $coll);
/**
* Gets the SQL statement used for inserting a row in the collection.
*
* @param \Doctrine\ORM\PersistentCollection $coll
*/
abstract protected function getInsertRowSQL(PersistentCollection $coll);
/**
* Gets the SQL parameters for the corresponding SQL statement to insert the given
* element of the given collection into the database.
*
* @param \Doctrine\ORM\PersistentCollection $coll
* @param mixed $element
*/
abstract protected function getInsertRowSQLParameters(PersistentCollection $coll, $element);
}