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

612 lines
18 KiB
PHP
Raw Normal View History

<?php
/*
* $Id$
*
* 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\Common\EventManager,
Doctrine\DBAL\Connection,
Doctrine\ORM\Mapping\ClassMetadata,
Doctrine\ORM\Mapping\ClassMetadataFactory,
Doctrine\ORM\Proxy\ProxyFactory;
/**
* The EntityManager is the central access point to ORM functionality.
*
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
* @link www.doctrine-project.org
* @since 2.0
* @version $Revision$
* @author Roman Borschel <roman@code-factory.org>
* @todo Remove flush modes. They dont seem to be of much use. Manual flushing should
* be enough.
*/
class EntityManager
{
/**
* The used Configuration.
*
* @var Doctrine\ORM\Configuration
*/
private $_config;
/**
* The database connection used by the EntityManager.
*
* @var Doctrine\DBAL\Connection
*/
private $_conn;
/**
* The metadata factory, used to retrieve the ORM metadata of entity classes.
*
* @var Doctrine\ORM\Mapping\ClassMetadataFactory
*/
private $_metadataFactory;
/**
* The EntityRepository instances.
*
* @var array
*/
private $_repositories = array();
/**
* The UnitOfWork used to coordinate object-level transactions.
*
* @var Doctrine\ORM\UnitOfWork
*/
private $_unitOfWork;
/**
* The event manager that is the central point of the event system.
*
* @var Doctrine\Common\EventManager
*/
private $_eventManager;
2009-01-04 19:15:32 +03:00
/**
* The maintained (cached) hydrators. One instance per type.
*
* @var array
*/
private $_hydrators = array();
/**
2010-01-30 00:24:29 +03:00
* The proxy factory used to create dynamic proxies.
*
2010-01-30 00:24:29 +03:00
* @var Doctrine\ORM\Proxy\ProxyFactory
*/
private $_proxyFactory;
/**
* @var ExpressionBuilder The expression builder instance used to generate query expressions.
*/
private $_expressionBuilder;
/**
* Whether the EntityManager is closed or not.
*/
2008-09-07 17:48:40 +04:00
private $_closed = false;
/**
2009-01-04 19:15:32 +03:00
* Creates a new EntityManager that operates on the given database connection
* and uses the given Configuration and EventManager implementations.
*
2009-01-04 19:15:32 +03:00
* @param Doctrine\DBAL\Connection $conn
* @param Doctrine\ORM\Configuration $config
* @param Doctrine\Common\EventManager $eventManager
*/
protected function __construct(Connection $conn, Configuration $config, EventManager $eventManager)
{
$this->_conn = $conn;
2008-09-07 17:48:40 +04:00
$this->_config = $config;
$this->_eventManager = $eventManager;
$this->_metadataFactory = new ClassMetadataFactory($this);
$this->_metadataFactory->setCacheDriver($this->_config->getMetadataCacheImpl());
$this->_unitOfWork = new UnitOfWork($this);
$this->_proxyFactory = new ProxyFactory($this,
$config->getProxyDir(),
$config->getProxyNamespace(),
$config->getAutoGenerateProxyClasses());
}
/**
* Gets the database connection object used by the EntityManager.
*
* @return Doctrine\DBAL\Connection
*/
public function getConnection()
{
return $this->_conn;
}
2008-09-07 17:48:40 +04:00
/**
* Gets the metadata factory used to gather the metadata of classes.
*
* @return Doctrine\ORM\Mapping\ClassMetadataFactory
2008-09-07 17:48:40 +04:00
*/
public function getMetadataFactory()
2008-09-07 17:48:40 +04:00
{
return $this->_metadataFactory;
2008-09-07 17:48:40 +04:00
}
/**
* Gets an ExpressionBuilder used for object-oriented construction of query expressions.
*
* Example:
*
* [php]
* $qb = $em->createQueryBuilder();
* $expr = $em->getExpressionBuilder();
* $qb->select('u')->from('User', 'u')
* ->where($expr->orX($expr->eq('u.id', 1), $expr->eq('u.id', 2)));
*
* @return ExpressionBuilder
*/
public function getExpressionBuilder()
{
if ($this->_expressionBuilder === null) {
$this->_expressionBuilder = new Query\Expr;
}
return $this->_expressionBuilder;
}
/**
* Starts a transaction on the underlying database connection.
*/
public function beginTransaction()
{
$this->_conn->beginTransaction();
}
/**
* Commits a transaction on the underlying database connection.
*/
public function commit()
{
$this->_conn->commit();
}
/**
* Performs a rollback on the underlying database connection and closes the
* EntityManager as it may now be in a corrupted state.
*/
public function rollback()
{
2009-05-28 15:39:16 +04:00
$this->_conn->rollback();
$this->close();
}
/**
* Returns the metadata for a class.
*
* @return Doctrine\ORM\Mapping\ClassMetadata
* @internal Performance-sensitive method.
*/
public function getClassMetadata($className)
{
return $this->_metadataFactory->getMetadataFor($className);
}
/**
* Creates a new Query object.
*
* @param string The DQL string.
* @return Doctrine\ORM\Query
*/
public function createQuery($dql = "")
{
$query = new Query($this);
if ( ! empty($dql)) {
$query->setDql($dql);
}
return $query;
}
/**
* Creates a Query from a named query.
*
* @param string $name
2009-09-06 03:54:36 +04:00
* @return Doctrine\ORM\Query
*/
public function createNamedQuery($name)
{
return $this->createQuery($this->_config->getNamedQuery($name));
}
/**
* Creates a native SQL query.
*
* @param string $sql
* @param ResultSetMapping $rsm The ResultSetMapping to use.
* @return NativeQuery
*/
public function createNativeQuery($sql, \Doctrine\ORM\Query\ResultSetMapping $rsm)
{
$query = new NativeQuery($this);
$query->setSql($sql);
$query->setResultSetMapping($rsm);
return $query;
}
/**
* Creates a NativeQuery from a named native query.
*
* @param string $name
2009-09-06 03:54:36 +04:00
* @return Doctrine\ORM\NativeQuery
*/
public function createNamedNativeQuery($name)
{
list($sql, $rsm) = $this->_config->getNamedNativeQuery($name);
return $this->createNativeQuery($sql, $rsm);
}
/**
* Create a QueryBuilder instance
*
* @return QueryBuilder $qb
*/
public function createQueryBuilder()
{
return new QueryBuilder($this);
}
/**
* Flushes all changes to objects that have been queued up to now to the database.
* This effectively synchronizes the in-memory state of managed objects with the
* database.
*/
public function flush()
{
$this->_errorIfClosed();
$this->_unitOfWork->commit();
}
/**
* Finds an Entity by its identifier.
*
2009-01-04 19:15:32 +03:00
* This is just a convenient shortcut for getRepository($entityName)->find($id).
*
* @param string $entityName
* @param mixed $identifier
* @return object
*/
public function find($entityName, $identifier)
{
return $this->getRepository($entityName)->find($identifier);
}
/**
* Gets a reference to the entity identified by the given type and identifier
* without actually loading it.
*
* If partial objects are allowed, this method will return a partial object that only
* has its identifier populated. Otherwise a proxy is returned that automatically
* loads itself on first access.
*
* @return object The entity reference.
*/
public function getReference($entityName, $identifier)
{
$class = $this->_metadataFactory->getMetadataFor($entityName);
2009-10-07 16:39:46 +04:00
// Check identity map first, if its already in there just return it.
if ($entity = $this->_unitOfWork->tryGetById($identifier, $class->rootEntityName)) {
2009-10-07 16:39:46 +04:00
return $entity;
}
if ( ! is_array($identifier)) {
$identifier = array($class->identifier[0] => $identifier);
2009-07-24 15:33:38 +04:00
}
$entity = $this->_proxyFactory->getProxy($class->name, $identifier);
$this->_unitOfWork->registerManaged($entity, $identifier, array());
2009-07-24 15:33:38 +04:00
return $entity;
}
/**
* Clears the EntityManager. All entities that are currently managed
* by this EntityManager become detached.
*
* @param string $entityName
*/
public function clear($entityName = null)
{
if ($entityName === null) {
2009-05-19 20:11:08 +04:00
$this->_unitOfWork->clear();
} else {
2009-01-04 19:15:32 +03:00
//TODO
2009-12-18 16:20:22 +03:00
throw new ORMException("EntityManager#clear(\$entityName) not yet implemented.");
}
}
/**
* Closes the EntityManager. All entities that are currently managed
* by this EntityManager become detached. The EntityManager may no longer
* be used after it is closed.
*/
public function close()
{
$this->clear();
2008-09-07 17:48:40 +04:00
$this->_closed = true;
}
/**
2009-07-19 20:54:53 +04:00
* Tells the EntityManager to make an instance managed and persistent.
*
2009-07-19 20:54:53 +04:00
* The entity will be entered into the database at or before transaction
* commit or as a result of the flush operation.
*
* NOTE: The persist operation always considers entities that are not yet known to
* this EntityManager as NEW. Do not pass detached entities to the persist operation.
*
2009-07-19 20:54:53 +04:00
* @param object $object The instance to make managed and persistent.
*/
public function persist($entity)
{
if ( ! is_object($entity)) {
throw new \InvalidArgumentException(gettype($entity));
}
$this->_errorIfClosed();
$this->_unitOfWork->persist($entity);
}
/**
2009-07-19 20:54:53 +04:00
* Removes an entity instance.
*
2009-07-19 20:54:53 +04:00
* A removed entity will be removed from the database at or before transaction commit
* or as a result of the flush operation.
*
2009-07-19 20:54:53 +04:00
* @param object $entity The entity instance to remove.
*/
2009-07-19 20:54:53 +04:00
public function remove($entity)
{
if ( ! is_object($entity)) {
throw new \InvalidArgumentException(gettype($entity));
}
$this->_errorIfClosed();
2009-07-19 20:54:53 +04:00
$this->_unitOfWork->remove($entity);
}
2008-07-27 23:38:56 +04:00
/**
2009-07-19 20:54:53 +04:00
* Refreshes the persistent state of an entity from the database,
2008-08-16 23:40:59 +04:00
* overriding any local changes that have not yet been persisted.
2008-07-27 23:38:56 +04:00
*
2009-07-21 19:53:58 +04:00
* @param object $entity The entity to refresh.
2008-07-27 23:38:56 +04:00
*/
public function refresh($entity)
2008-07-27 23:38:56 +04:00
{
if ( ! is_object($entity)) {
throw new \InvalidArgumentException(gettype($entity));
}
2009-05-28 15:39:16 +04:00
$this->_errorIfClosed();
2009-07-21 19:53:58 +04:00
$this->_unitOfWork->refresh($entity);
2008-07-27 23:38:56 +04:00
}
/**
* Detaches an entity from the EntityManager, causing a managed entity to
* become detached. Unflushed changes made to the entity if any
* (including removal of the entity), will not be synchronized to the database.
* Entities which previously referenced the detached entity will continue to
* reference it.
*
* @param object $entity The entity to detach.
*/
public function detach($entity)
{
if ( ! is_object($entity)) {
throw new \InvalidArgumentException(gettype($entity));
}
$this->_unitOfWork->detach($entity);
}
/**
* Merges the state of a detached entity into the persistence context
* of this EntityManager and returns the managed copy of the entity.
* The entity passed to merge will not become associated/managed with this EntityManager.
*
* @param object $entity The detached entity to merge into the persistence context.
* @return object The managed copy of the entity.
*/
public function merge($entity)
{
if ( ! is_object($entity)) {
throw new \InvalidArgumentException(gettype($entity));
}
$this->_errorIfClosed();
return $this->_unitOfWork->merge($entity);
}
2008-07-27 23:38:56 +04:00
/**
* Creates a copy of the given entity. Can create a shallow or a deep copy.
*
* @param object $entity The entity to copy.
* @return object The new entity.
* @todo Implementation or remove.
2008-07-27 23:38:56 +04:00
*/
public function copy($entity, $deep = false)
2008-07-27 23:38:56 +04:00
{
throw new \BadMethodCallException("Not implemented.");
2008-07-27 23:38:56 +04:00
}
/**
* Gets the repository for an entity class.
*
* @param string $entityName The name of the Entity.
* @return EntityRepository The repository.
*/
public function getRepository($entityName)
{
if (isset($this->_repositories[$entityName])) {
return $this->_repositories[$entityName];
}
$metadata = $this->getClassMetadata($entityName);
$customRepositoryClassName = $metadata->customRepositoryClassName;
if ($customRepositoryClassName !== null) {
$repository = new $customRepositoryClassName($this, $metadata);
} else {
$repository = new EntityRepository($this, $metadata);
}
$this->_repositories[$entityName] = $repository;
return $repository;
}
/**
2009-07-19 20:54:53 +04:00
* Determines whether an entity instance is managed in this EntityManager.
*
* @param object $entity
* @return boolean TRUE if this EntityManager currently manages the given entity, FALSE otherwise.
*/
public function contains($entity)
{
2009-10-05 13:32:50 +04:00
return $this->_unitOfWork->isScheduledForInsert($entity) ||
$this->_unitOfWork->isInIdentityMap($entity) &&
! $this->_unitOfWork->isScheduledForDelete($entity);
}
/**
* Gets the EventManager used by the EntityManager.
*
* @return Doctrine\Common\EventManager
*/
public function getEventManager()
{
return $this->_eventManager;
}
/**
2008-09-07 17:48:40 +04:00
* Gets the Configuration used by the EntityManager.
*
* @return Doctrine\ORM\Configuration
*/
2008-09-07 17:48:40 +04:00
public function getConfiguration()
{
2008-09-07 17:48:40 +04:00
return $this->_config;
}
/**
* Throws an exception if the EntityManager is closed or currently not active.
*
2009-12-18 16:20:22 +03:00
* @throws ORMException If the EntityManager is closed.
*/
private function _errorIfClosed()
2008-09-07 17:48:40 +04:00
{
if ($this->_closed) {
2009-12-18 16:20:22 +03:00
throw ORMException::entityManagerClosed();
2008-09-07 17:48:40 +04:00
}
}
/**
2008-09-07 17:48:40 +04:00
* Gets the UnitOfWork used by the EntityManager to coordinate operations.
*
* @return Doctrine\ORM\UnitOfWork
*/
2008-09-07 17:48:40 +04:00
public function getUnitOfWork()
{
2008-09-07 17:48:40 +04:00
return $this->_unitOfWork;
}
/**
* Gets a hydrator for the given hydration mode.
*
* This method caches the hydrator instances which is used for all queries that don't
* selectively iterate over the result.
*
* @param int $hydrationMode
* @return Doctrine\ORM\Internal\Hydration\AbstractHydrator
*/
public function getHydrator($hydrationMode)
{
if ( ! isset($this->_hydrators[$hydrationMode])) {
$this->_hydrators[$hydrationMode] = $this->newHydrator($hydrationMode);
}
return $this->_hydrators[$hydrationMode];
}
/**
* Create a new instance for the given hydration mode.
*
* @param int $hydrationMode
* @return Doctrine\ORM\Internal\Hydration\AbstractHydrator
*/
public function newHydrator($hydrationMode)
{
switch ($hydrationMode) {
case Query::HYDRATE_OBJECT:
$hydrator = new Internal\Hydration\ObjectHydrator($this);
break;
case Query::HYDRATE_ARRAY:
$hydrator = new Internal\Hydration\ArrayHydrator($this);
break;
case Query::HYDRATE_SCALAR:
$hydrator = new Internal\Hydration\ScalarHydrator($this);
break;
case Query::HYDRATE_SINGLE_SCALAR:
$hydrator = new Internal\Hydration\SingleScalarHydrator($this);
break;
default:
throw ORMException::invalidHydrationMode($hydrationMode);
}
return $hydrator;
}
/**
* Gets the proxy factory used by the EntityManager to create entity proxies.
*
* @return ProxyFactory
*/
public function getProxyFactory()
{
return $this->_proxyFactory;
}
/**
2008-09-07 17:48:40 +04:00
* Factory method to create EntityManager instances.
*
2008-09-07 17:48:40 +04:00
* @param mixed $conn An array with the connection parameters or an existing
* Connection instance.
* @param Configuration $config The Configuration instance to use.
* @param EventManager $eventManager The EventManager instance to use.
* @return EntityManager The created EntityManager.
2008-09-07 17:48:40 +04:00
*/
public static function create($conn, Configuration $config = null, EventManager $eventManager = null)
2008-09-07 17:48:40 +04:00
{
$config = $config ?: new Configuration();
2008-09-07 17:48:40 +04:00
if (is_array($conn)) {
$conn = \Doctrine\DBAL\DriverManager::getConnection($conn, $config, ($eventManager ?: new EventManager()));
} else if ($conn instanceof Connection) {
if ($eventManager !== null && $conn->getEventManager() !== $eventManager) {
throw ORMException::mismatchedEventManager();
}
} else {
throw new \InvalidArgumentException("Invalid argument: " . $conn);
2008-09-07 17:48:40 +04:00
}
return new EntityManager($conn, $config, $conn->getEventManager());
2008-09-07 17:48:40 +04:00
}
}