1004 lines
29 KiB
PHP
1004 lines
29 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 MIT license. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\ORM;
|
|
|
|
use Exception;
|
|
use Doctrine\Common\EventManager;
|
|
use Doctrine\Common\Persistence\ObjectManager;
|
|
use Doctrine\DBAL\Connection;
|
|
use Doctrine\DBAL\LockMode;
|
|
use Doctrine\ORM\Mapping\ClassMetadata;
|
|
use Doctrine\ORM\Mapping\ClassMetadataFactory;
|
|
use Doctrine\ORM\Query\ResultSetMapping;
|
|
use Doctrine\ORM\Proxy\ProxyFactory;
|
|
use Doctrine\ORM\Query\FilterCollection;
|
|
use Doctrine\Common\Util\ClassUtils;
|
|
|
|
/**
|
|
* The EntityManager is the central access point to ORM functionality.
|
|
*
|
|
* It is a facade to all different ORM subsystems such as UnitOfWork,
|
|
* Query Language and Repository API. Instantiation is done through
|
|
* the static create() method. The quickest way to obtain a fully
|
|
* configured EntityManager is:
|
|
*
|
|
* use Doctrine\ORM\Tools\Setup;
|
|
* use Doctrine\ORM\EntityManager;
|
|
*
|
|
* $paths = array('/path/to/entity/mapping/files');
|
|
*
|
|
* $config = Setup::createAnnotationMetadataConfiguration($paths);
|
|
* $dbParams = array('driver' => 'pdo_sqlite', 'memory' => true);
|
|
* $entityManager = EntityManager::create($dbParams, $config);
|
|
*
|
|
* For more information see
|
|
* {@link http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/configuration.html}
|
|
*
|
|
* You should never attempt to inherit from the EntityManager: Inheritance
|
|
* is not a valid extension point for the EntityManager. Instead you
|
|
* should take a look at the {@see \Doctrine\ORM\Decorator\EntityManagerDecorator}
|
|
* and wrap your entity manager in a decorator.
|
|
*
|
|
* @since 2.0
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
|
|
* @author Jonathan Wage <jonwage@gmail.com>
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
*/
|
|
/* final */class EntityManager implements EntityManagerInterface
|
|
{
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* The maintained (cached) hydrators. One instance per type.
|
|
*
|
|
* @var array
|
|
*/
|
|
private $hydrators = array();
|
|
|
|
/**
|
|
* The proxy factory used to create dynamic proxies.
|
|
*
|
|
* @var \Doctrine\ORM\Proxy\ProxyFactory
|
|
*/
|
|
private $proxyFactory;
|
|
|
|
/**
|
|
* The expression builder instance used to generate query expressions.
|
|
*
|
|
* @var \Doctrine\ORM\Query\Expr
|
|
*/
|
|
private $expressionBuilder;
|
|
|
|
/**
|
|
* Whether the EntityManager is closed or not.
|
|
*
|
|
* @var bool
|
|
*/
|
|
private $closed = false;
|
|
|
|
/**
|
|
* Collection of query filters.
|
|
*
|
|
* @var \Doctrine\ORM\Query\FilterCollection
|
|
*/
|
|
private $filterCollection;
|
|
|
|
/**
|
|
* Creates a new EntityManager that operates on the given database connection
|
|
* and uses the given Configuration and EventManager implementations.
|
|
*
|
|
* @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;
|
|
$this->config = $config;
|
|
$this->eventManager = $eventManager;
|
|
|
|
$metadataFactoryClassName = $config->getClassMetadataFactoryName();
|
|
|
|
$this->metadataFactory = new $metadataFactoryClassName;
|
|
$this->metadataFactory->setEntityManager($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;
|
|
}
|
|
|
|
/**
|
|
* Gets the metadata factory used to gather the metadata of classes.
|
|
*
|
|
* @return \Doctrine\ORM\Mapping\ClassMetadataFactory
|
|
*/
|
|
public function getMetadataFactory()
|
|
{
|
|
return $this->metadataFactory;
|
|
}
|
|
|
|
/**
|
|
* Gets an ExpressionBuilder used for object-oriented construction of query expressions.
|
|
*
|
|
* Example:
|
|
*
|
|
* <code>
|
|
* $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)));
|
|
* </code>
|
|
*
|
|
* @return \Doctrine\ORM\Query\Expr
|
|
*/
|
|
public function getExpressionBuilder()
|
|
{
|
|
if ($this->expressionBuilder === null) {
|
|
$this->expressionBuilder = new Query\Expr;
|
|
}
|
|
|
|
return $this->expressionBuilder;
|
|
}
|
|
|
|
/**
|
|
* Starts a transaction on the underlying database connection.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function beginTransaction()
|
|
{
|
|
$this->conn->beginTransaction();
|
|
}
|
|
|
|
/**
|
|
* Executes a function in a transaction.
|
|
*
|
|
* The function gets passed this EntityManager instance as an (optional) parameter.
|
|
*
|
|
* {@link flush} is invoked prior to transaction commit.
|
|
*
|
|
* If an exception occurs during execution of the function or flushing or transaction commit,
|
|
* the transaction is rolled back, the EntityManager closed and the exception re-thrown.
|
|
*
|
|
* @param callable $func The function to execute transactionally.
|
|
*
|
|
* @return mixed The non-empty value returned from the closure or true instead.
|
|
*/
|
|
public function transactional($func)
|
|
{
|
|
if (!is_callable($func)) {
|
|
throw new \InvalidArgumentException('Expected argument of type "callable", got "' . gettype($func) . '"');
|
|
}
|
|
|
|
$this->conn->beginTransaction();
|
|
|
|
try {
|
|
$return = call_user_func($func, $this);
|
|
|
|
$this->flush();
|
|
$this->conn->commit();
|
|
|
|
return $return ?: true;
|
|
} catch (Exception $e) {
|
|
$this->close();
|
|
$this->conn->rollback();
|
|
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Commits a transaction on the underlying database connection.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function commit()
|
|
{
|
|
$this->conn->commit();
|
|
}
|
|
|
|
/**
|
|
* Performs a rollback on the underlying database connection.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function rollback()
|
|
{
|
|
$this->conn->rollback();
|
|
}
|
|
|
|
/**
|
|
* Returns the ORM metadata descriptor for a class.
|
|
*
|
|
* The class name must be the fully-qualified class name without a leading backslash
|
|
* (as it is returned by get_class($obj)) or an aliased class name.
|
|
*
|
|
* Examples:
|
|
* MyProject\Domain\User
|
|
* sales:PriceRequest
|
|
*
|
|
* @param string $className
|
|
*
|
|
* @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 $dql 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
|
|
*
|
|
* @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, 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
|
|
*
|
|
* @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
|
|
*/
|
|
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.
|
|
*
|
|
* If an entity is explicitly passed to this method only this entity and
|
|
* the cascade-persist semantics + scheduled inserts/removals are synchronized.
|
|
*
|
|
* @param null|object|array $entity
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws \Doctrine\ORM\OptimisticLockException If a version check on an entity that
|
|
* makes use of optimistic locking fails.
|
|
*/
|
|
public function flush($entity = null)
|
|
{
|
|
$this->errorIfClosed();
|
|
|
|
$this->unitOfWork->commit($entity);
|
|
}
|
|
|
|
/**
|
|
* Finds an Entity by its identifier.
|
|
*
|
|
* @param string $entityName
|
|
* @param mixed $id
|
|
* @param integer $lockMode
|
|
* @param integer|null $lockVersion
|
|
*
|
|
* @return object|null The entity instance or NULL if the entity can not be found.
|
|
*
|
|
* @throws OptimisticLockException
|
|
* @throws ORMInvalidArgumentException
|
|
* @throws TransactionRequiredException
|
|
* @throws ORMException
|
|
*/
|
|
public function find($entityName, $id, $lockMode = LockMode::NONE, $lockVersion = null)
|
|
{
|
|
$class = $this->metadataFactory->getMetadataFor(ltrim($entityName, '\\'));
|
|
|
|
if (is_object($id) && $this->metadataFactory->hasMetadataFor(ClassUtils::getClass($id))) {
|
|
$id = $this->unitOfWork->getSingleIdentifierValue($id);
|
|
|
|
if ($id === null) {
|
|
throw ORMInvalidArgumentException::invalidIdentifierBindingEntity();
|
|
}
|
|
}
|
|
|
|
if ( ! is_array($id)) {
|
|
$id = array($class->identifier[0] => $id);
|
|
}
|
|
|
|
$sortedId = array();
|
|
|
|
foreach ($class->identifier as $identifier) {
|
|
if ( ! isset($id[$identifier])) {
|
|
throw ORMException::missingIdentifierField($class->name, $identifier);
|
|
}
|
|
|
|
$sortedId[$identifier] = $id[$identifier];
|
|
}
|
|
|
|
$unitOfWork = $this->getUnitOfWork();
|
|
|
|
// Check identity map first
|
|
if (($entity = $unitOfWork->tryGetById($sortedId, $class->rootEntityName)) !== false) {
|
|
if ( ! ($entity instanceof $class->name)) {
|
|
return null;
|
|
}
|
|
|
|
switch ($lockMode) {
|
|
case LockMode::OPTIMISTIC:
|
|
$this->lock($entity, $lockMode, $lockVersion);
|
|
break;
|
|
|
|
case LockMode::PESSIMISTIC_READ:
|
|
case LockMode::PESSIMISTIC_WRITE:
|
|
$persister = $unitOfWork->getEntityPersister($class->name);
|
|
$persister->refresh($sortedId, $entity, $lockMode);
|
|
break;
|
|
}
|
|
|
|
return $entity; // Hit!
|
|
}
|
|
|
|
$persister = $unitOfWork->getEntityPersister($class->name);
|
|
|
|
switch ($lockMode) {
|
|
case LockMode::NONE:
|
|
return $persister->load($sortedId);
|
|
|
|
case LockMode::OPTIMISTIC:
|
|
if ( ! $class->isVersioned) {
|
|
throw OptimisticLockException::notVersioned($class->name);
|
|
}
|
|
|
|
$entity = $persister->load($sortedId);
|
|
|
|
$unitOfWork->lock($entity, $lockMode, $lockVersion);
|
|
|
|
return $entity;
|
|
|
|
default:
|
|
if ( ! $this->getConnection()->isTransactionActive()) {
|
|
throw TransactionRequiredException::transactionRequired();
|
|
}
|
|
|
|
return $persister->load($sortedId, null, null, array(), $lockMode);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Gets a reference to the entity identified by the given type and identifier
|
|
* without actually loading it, if the entity is not yet loaded.
|
|
*
|
|
* @param string $entityName The name of the entity type.
|
|
* @param mixed $id The entity identifier.
|
|
*
|
|
* @return object The entity reference.
|
|
*
|
|
* @throws ORMException
|
|
*/
|
|
public function getReference($entityName, $id)
|
|
{
|
|
$class = $this->metadataFactory->getMetadataFor(ltrim($entityName, '\\'));
|
|
|
|
if ( ! is_array($id)) {
|
|
$id = array($class->identifier[0] => $id);
|
|
}
|
|
|
|
$sortedId = array();
|
|
|
|
foreach ($class->identifier as $identifier) {
|
|
if ( ! isset($id[$identifier])) {
|
|
throw ORMException::missingIdentifierField($class->name, $identifier);
|
|
}
|
|
|
|
$sortedId[$identifier] = $id[$identifier];
|
|
}
|
|
|
|
// Check identity map first, if its already in there just return it.
|
|
if (($entity = $this->unitOfWork->tryGetById($sortedId, $class->rootEntityName)) !== false) {
|
|
return ($entity instanceof $class->name) ? $entity : null;
|
|
}
|
|
|
|
if ($class->subClasses) {
|
|
return $this->find($entityName, $sortedId);
|
|
}
|
|
|
|
if ( ! is_array($sortedId)) {
|
|
$sortedId = array($class->identifier[0] => $sortedId);
|
|
}
|
|
|
|
$entity = $this->proxyFactory->getProxy($class->name, $sortedId);
|
|
|
|
$this->unitOfWork->registerManaged($entity, $sortedId, array());
|
|
|
|
return $entity;
|
|
}
|
|
|
|
/**
|
|
* Gets a partial reference to the entity identified by the given type and identifier
|
|
* without actually loading it, if the entity is not yet loaded.
|
|
*
|
|
* The returned reference may be a partial object if the entity is not yet loaded/managed.
|
|
* If it is a partial object it will not initialize the rest of the entity state on access.
|
|
* Thus you can only ever safely access the identifier of an entity obtained through
|
|
* this method.
|
|
*
|
|
* The use-cases for partial references involve maintaining bidirectional associations
|
|
* without loading one side of the association or to update an entity without loading it.
|
|
* Note, however, that in the latter case the original (persistent) entity data will
|
|
* never be visible to the application (especially not event listeners) as it will
|
|
* never be loaded in the first place.
|
|
*
|
|
* @param string $entityName The name of the entity type.
|
|
* @param mixed $identifier The entity identifier.
|
|
*
|
|
* @return object The (partial) entity reference.
|
|
*/
|
|
public function getPartialReference($entityName, $identifier)
|
|
{
|
|
$class = $this->metadataFactory->getMetadataFor(ltrim($entityName, '\\'));
|
|
|
|
// Check identity map first, if its already in there just return it.
|
|
if (($entity = $this->unitOfWork->tryGetById($identifier, $class->rootEntityName)) !== false) {
|
|
return ($entity instanceof $class->name) ? $entity : null;
|
|
}
|
|
|
|
if ( ! is_array($identifier)) {
|
|
$identifier = array($class->identifier[0] => $identifier);
|
|
}
|
|
|
|
$entity = $class->newInstance();
|
|
|
|
$class->setIdentifierValues($entity, $identifier);
|
|
|
|
$this->unitOfWork->registerManaged($entity, $identifier, array());
|
|
$this->unitOfWork->markReadOnly($entity);
|
|
|
|
return $entity;
|
|
}
|
|
|
|
/**
|
|
* Clears the EntityManager. All entities that are currently managed
|
|
* by this EntityManager become detached.
|
|
*
|
|
* @param string|null $entityName if given, only entities of this type will get detached
|
|
*
|
|
* @return void
|
|
*/
|
|
public function clear($entityName = null)
|
|
{
|
|
$this->unitOfWork->clear($entityName);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function close()
|
|
{
|
|
$this->clear();
|
|
|
|
$this->closed = true;
|
|
}
|
|
|
|
/**
|
|
* Tells the EntityManager to make an instance managed and persistent.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param object $entity The instance to make managed and persistent.
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws ORMInvalidArgumentException
|
|
*/
|
|
public function persist($entity)
|
|
{
|
|
if ( ! is_object($entity)) {
|
|
throw ORMInvalidArgumentException::invalidObject('EntityManager#persist()' , $entity);
|
|
}
|
|
|
|
$this->errorIfClosed();
|
|
|
|
$this->unitOfWork->persist($entity);
|
|
}
|
|
|
|
/**
|
|
* Removes an entity instance.
|
|
*
|
|
* A removed entity will be removed from the database at or before transaction commit
|
|
* or as a result of the flush operation.
|
|
*
|
|
* @param object $entity The entity instance to remove.
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws ORMInvalidArgumentException
|
|
*/
|
|
public function remove($entity)
|
|
{
|
|
if ( ! is_object($entity)) {
|
|
throw ORMInvalidArgumentException::invalidObject('EntityManager#remove()' , $entity);
|
|
}
|
|
|
|
$this->errorIfClosed();
|
|
|
|
$this->unitOfWork->remove($entity);
|
|
}
|
|
|
|
/**
|
|
* Refreshes the persistent state of an entity from the database,
|
|
* overriding any local changes that have not yet been persisted.
|
|
*
|
|
* @param object $entity The entity to refresh.
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws ORMInvalidArgumentException
|
|
*/
|
|
public function refresh($entity)
|
|
{
|
|
if ( ! is_object($entity)) {
|
|
throw ORMInvalidArgumentException::invalidObject('EntityManager#refresh()' , $entity);
|
|
}
|
|
|
|
$this->errorIfClosed();
|
|
|
|
$this->unitOfWork->refresh($entity);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws ORMInvalidArgumentException
|
|
*/
|
|
public function detach($entity)
|
|
{
|
|
if ( ! is_object($entity)) {
|
|
throw ORMInvalidArgumentException::invalidObject('EntityManager#detach()' , $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.
|
|
*
|
|
* @throws ORMInvalidArgumentException
|
|
*/
|
|
public function merge($entity)
|
|
{
|
|
if ( ! is_object($entity)) {
|
|
throw ORMInvalidArgumentException::invalidObject('EntityManager#merge()' , $entity);
|
|
}
|
|
|
|
$this->errorIfClosed();
|
|
|
|
return $this->unitOfWork->merge($entity);
|
|
}
|
|
|
|
/**
|
|
* Creates a copy of the given entity. Can create a shallow or a deep copy.
|
|
*
|
|
* @param object $entity The entity to copy.
|
|
* @param boolean $deep FALSE for a shallow copy, TRUE for a deep copy.
|
|
*
|
|
* @return object The new entity.
|
|
*
|
|
* @throws \BadMethodCallException
|
|
*
|
|
* @todo Implementation need. This is necessary since $e2 = clone $e1; throws an E_FATAL when access anything on $e:
|
|
* Fatal error: Maximum function nesting level of '100' reached, aborting!
|
|
*/
|
|
public function copy($entity, $deep = false)
|
|
{
|
|
throw new \BadMethodCallException("Not implemented.");
|
|
}
|
|
|
|
/**
|
|
* Acquire a lock on the given entity.
|
|
*
|
|
* @param object $entity
|
|
* @param int $lockMode
|
|
* @param int|null $lockVersion
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws OptimisticLockException
|
|
* @throws PessimisticLockException
|
|
*/
|
|
public function lock($entity, $lockMode, $lockVersion = null)
|
|
{
|
|
$this->unitOfWork->lock($entity, $lockMode, $lockVersion);
|
|
}
|
|
|
|
/**
|
|
* Gets the repository for an entity class.
|
|
*
|
|
* @param string $entityName The name of the entity.
|
|
*
|
|
* @return EntityRepository The repository class.
|
|
*/
|
|
public function getRepository($entityName)
|
|
{
|
|
$entityName = ltrim($entityName, '\\');
|
|
|
|
if (isset($this->repositories[$entityName])) {
|
|
return $this->repositories[$entityName];
|
|
}
|
|
|
|
$metadata = $this->getClassMetadata($entityName);
|
|
$repositoryClassName = $metadata->customRepositoryClassName;
|
|
|
|
if ($repositoryClassName === null) {
|
|
$repositoryClassName = $this->config->getDefaultRepositoryClassName();
|
|
}
|
|
|
|
$repository = new $repositoryClassName($this, $metadata);
|
|
|
|
$this->repositories[$entityName] = $repository;
|
|
|
|
return $repository;
|
|
}
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
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;
|
|
}
|
|
|
|
/**
|
|
* Gets the Configuration used by the EntityManager.
|
|
*
|
|
* @return \Doctrine\ORM\Configuration
|
|
*/
|
|
public function getConfiguration()
|
|
{
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* Throws an exception if the EntityManager is closed or currently not active.
|
|
*
|
|
* @return void
|
|
*
|
|
* @throws ORMException If the EntityManager is closed.
|
|
*/
|
|
private function errorIfClosed()
|
|
{
|
|
if ($this->closed) {
|
|
throw ORMException::entityManagerClosed();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if the Entity manager is open or closed.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isOpen()
|
|
{
|
|
return (!$this->closed);
|
|
}
|
|
|
|
/**
|
|
* Gets the UnitOfWork used by the EntityManager to coordinate operations.
|
|
*
|
|
* @return \Doctrine\ORM\UnitOfWork
|
|
*/
|
|
public function getUnitOfWork()
|
|
{
|
|
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
|
|
*
|
|
* @throws ORMException
|
|
*/
|
|
public function newHydrator($hydrationMode)
|
|
{
|
|
switch ($hydrationMode) {
|
|
case Query::HYDRATE_OBJECT:
|
|
return new Internal\Hydration\ObjectHydrator($this);
|
|
|
|
case Query::HYDRATE_ARRAY:
|
|
return new Internal\Hydration\ArrayHydrator($this);
|
|
|
|
case Query::HYDRATE_SCALAR:
|
|
return new Internal\Hydration\ScalarHydrator($this);
|
|
|
|
case Query::HYDRATE_SINGLE_SCALAR:
|
|
return new Internal\Hydration\SingleScalarHydrator($this);
|
|
|
|
case Query::HYDRATE_SIMPLEOBJECT:
|
|
return new Internal\Hydration\SimpleObjectHydrator($this);
|
|
|
|
default:
|
|
if (($class = $this->config->getCustomHydrationMode($hydrationMode)) !== null) {
|
|
return new $class($this);
|
|
}
|
|
}
|
|
|
|
throw ORMException::invalidHydrationMode($hydrationMode);
|
|
}
|
|
|
|
/**
|
|
* Gets the proxy factory used by the EntityManager to create entity proxies.
|
|
*
|
|
* @return ProxyFactory
|
|
*/
|
|
public function getProxyFactory()
|
|
{
|
|
return $this->proxyFactory;
|
|
}
|
|
|
|
/**
|
|
* Helper method to initialize a lazy loading proxy or persistent collection.
|
|
*
|
|
* This method is a no-op for other objects
|
|
*
|
|
* @param object $obj
|
|
*
|
|
* @return void
|
|
*/
|
|
public function initializeObject($obj)
|
|
{
|
|
$this->unitOfWork->initializeObject($obj);
|
|
}
|
|
|
|
/**
|
|
* Factory method to create EntityManager instances.
|
|
*
|
|
* @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.
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @throws ORMException
|
|
*/
|
|
public static function create($conn, Configuration $config, EventManager $eventManager = null)
|
|
{
|
|
if ( ! $config->getMetadataDriverImpl()) {
|
|
throw ORMException::missingMappingDriverImpl();
|
|
}
|
|
|
|
switch (true) {
|
|
case (is_array($conn)):
|
|
$conn = \Doctrine\DBAL\DriverManager::getConnection(
|
|
$conn, $config, ($eventManager ?: new EventManager())
|
|
);
|
|
break;
|
|
|
|
case ($conn instanceof Connection):
|
|
if ($eventManager !== null && $conn->getEventManager() !== $eventManager) {
|
|
throw ORMException::mismatchedEventManager();
|
|
}
|
|
break;
|
|
|
|
default:
|
|
throw new \InvalidArgumentException("Invalid argument: " . $conn);
|
|
}
|
|
|
|
return new EntityManager($conn, $config, $conn->getEventManager());
|
|
}
|
|
|
|
/**
|
|
* Gets the enabled filters.
|
|
*
|
|
* @return FilterCollection The active filter collection.
|
|
*/
|
|
public function getFilters()
|
|
{
|
|
if (null === $this->filterCollection) {
|
|
$this->filterCollection = new FilterCollection($this);
|
|
}
|
|
|
|
return $this->filterCollection;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the state of the filter collection is clean.
|
|
*
|
|
* @return boolean True, if the filter collection is clean.
|
|
*/
|
|
public function isFiltersStateClean()
|
|
{
|
|
return null === $this->filterCollection || $this->filterCollection->isClean();
|
|
}
|
|
|
|
/**
|
|
* Checks whether the Entity Manager has filters.
|
|
*
|
|
* @return boolean True, if the EM has a filter collection.
|
|
*/
|
|
public function hasFilters()
|
|
{
|
|
return null !== $this->filterCollection;
|
|
}
|
|
}
|