123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322 |
- <?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 MIT license. For more information, see
- * <http://www.doctrine-project.org>.
- */
- namespace Doctrine\ORM\Persisters;
- use Doctrine\ORM\EntityManager;
- use Doctrine\ORM\PersistentCollection;
- /**
- * Base class for all collection persisters.
- *
- * @since 2.0
- * @author Roman Borschel <roman@code-factory.org>
- */
- abstract class AbstractCollectionPersister
- {
- /**
- * @var EntityManager
- */
- protected $em;
- /**
- * @var \Doctrine\DBAL\Connection
- */
- protected $conn;
- /**
- * @var \Doctrine\ORM\UnitOfWork
- */
- protected $uow;
- /**
- * The database platform.
- *
- * @var \Doctrine\DBAL\Platforms\AbstractPlatform
- */
- protected $platform;
-
- /**
- * The quote strategy.
- *
- * @var \Doctrine\ORM\Mapping\QuoteStrategy
- */
- protected $quoteStrategy;
- /**
- * 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();
- $this->quoteStrategy = $em->getConfiguration()->getQuoteStrategy();
- }
- /**
- * Deletes the persistent state represented by the given collection.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return void
- */
- public function delete(PersistentCollection $coll)
- {
- $mapping = $coll->getMapping();
- if ( ! $mapping['isOwningSide']) {
- return; // ignore inverse side
- }
- $sql = $this->getDeleteSQL($coll);
- $this->conn->executeUpdate($sql, $this->getDeleteSQLParameters($coll));
- }
- /**
- * Gets the SQL statement for deleting the given collection.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return string
- */
- 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
- *
- * @return array
- */
- abstract protected function getDeleteSQLParameters(PersistentCollection $coll);
- /**
- * Updates the given collection, synchronizing its state with the database
- * by inserting, updating and deleting individual elements.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return void
- */
- public function update(PersistentCollection $coll)
- {
- $mapping = $coll->getMapping();
- if ( ! $mapping['isOwningSide']) {
- return; // ignore inverse side
- }
- $this->deleteRows($coll);
- $this->insertRows($coll);
- }
- /**
- * Deletes rows.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return void
- */
- public function deleteRows(PersistentCollection $coll)
- {
- $diff = $coll->getDeleteDiff();
- $sql = $this->getDeleteRowSQL($coll);
- foreach ($diff as $element) {
- $this->conn->executeUpdate($sql, $this->getDeleteRowSQLParameters($coll, $element));
- }
- }
- /**
- * Inserts rows.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return void
- */
- public function insertRows(PersistentCollection $coll)
- {
- $diff = $coll->getInsertDiff();
- $sql = $this->getInsertRowSQL($coll);
- foreach ($diff as $element) {
- $this->conn->executeUpdate($sql, $this->getInsertRowSQLParameters($coll, $element));
- }
- }
- /**
- * Counts the size of this persistent collection.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return integer
- *
- * @throws \BadMethodCallException
- */
- public function count(PersistentCollection $coll)
- {
- throw new \BadMethodCallException("Counting the size of this persistent collection is not supported by this CollectionPersister.");
- }
- /**
- * Slices elements.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- * @param integer $offset
- * @param integer $length
- *
- * @return array
- *
- * @throws \BadMethodCallException
- */
- public function slice(PersistentCollection $coll, $offset, $length = null)
- {
- throw new \BadMethodCallException("Slicing elements is not supported by this CollectionPersister.");
- }
- /**
- * Checks for existence of an element.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- * @param object $element
- *
- * @return boolean
- *
- * @throws \BadMethodCallException
- */
- public function contains(PersistentCollection $coll, $element)
- {
- throw new \BadMethodCallException("Checking for existence of an element is not supported by this CollectionPersister.");
- }
- /**
- * Checks for existence of a key.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- * @param mixed $key
- *
- * @return boolean
- *
- * @throws \BadMethodCallException
- */
- public function containsKey(PersistentCollection $coll, $key)
- {
- throw new \BadMethodCallException("Checking for existence of a key is not supported by this CollectionPersister.");
- }
- /**
- * Removes an element.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- * @param object $element
- *
- * @return mixed
- *
- * @throws \BadMethodCallException
- */
- public function removeElement(PersistentCollection $coll, $element)
- {
- throw new \BadMethodCallException("Removing an element is not supported by this CollectionPersister.");
- }
- /**
- * Removes an element by key.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- * @param mixed $key
- *
- * @return void
- *
- * @throws \BadMethodCallException
- */
- public function removeKey(PersistentCollection $coll, $key)
- {
- throw new \BadMethodCallException("Removing a key is not supported by this CollectionPersister.");
- }
- /**
- * Gets an element by key.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- * @param mixed $index
- *
- * @return mixed
- *
- * @throws \BadMethodCallException
- */
- 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.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return string
- */
- abstract protected function getDeleteRowSQL(PersistentCollection $coll);
- /**
- * 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
- *
- * @return array
- */
- abstract protected function getDeleteRowSQLParameters(PersistentCollection $coll, $element);
- /**
- * Gets the SQL statement used for updating a row in the collection.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return string
- */
- abstract protected function getUpdateRowSQL(PersistentCollection $coll);
- /**
- * Gets the SQL statement used for inserting a row in the collection.
- *
- * @param \Doctrine\ORM\PersistentCollection $coll
- *
- * @return string
- */
- 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
- *
- * @return array
- */
- abstract protected function getInsertRowSQLParameters(PersistentCollection $coll, $element);
- }
|