vendor/doctrine/orm/lib/Doctrine/ORM/EntityManagerInterface.php line 33

Open in your IDE?
  1. <?php
  2. /*
  3.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  4.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  5.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  6.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  7.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  8.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  9.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14.  *
  15.  * This software consists of voluntary contributions made by many individuals
  16.  * and is licensed under the MIT license. For more information, see
  17.  * <http://www.doctrine-project.org>.
  18.  */
  20. namespace Doctrine\ORM;
  22. use Doctrine\Common\Persistence\ObjectManager;
  23. use Doctrine\ORM\Query\ResultSetMapping;
  25. /**
  26.  * EntityManager interface
  27.  *
  28.  * @since   2.4
  29.  * @author  Lars Strojny <lars@strojny.net>
  30.  *
  31.  * @method Mapping\ClassMetadata getClassMetadata($className)
  32.  */
  33. interface EntityManagerInterface extends ObjectManager
  34. {
  35.     /**
  36.      * Returns the cache API for managing the second level cache regions or NULL if the cache is not enabled.
  37.      *
  38.      * @return \Doctrine\ORM\Cache|null
  39.      */
  40.     public function getCache();
  42.     /**
  43.      * Gets the database connection object used by the EntityManager.
  44.      *
  45.      * @return \Doctrine\DBAL\Connection
  46.      */
  47.     public function getConnection();
  49.     /**
  50.      * Gets an ExpressionBuilder used for object-oriented construction of query expressions.
  51.      *
  52.      * Example:
  53.      *
  54.      * <code>
  55.      *     $qb = $em->createQueryBuilder();
  56.      *     $expr = $em->getExpressionBuilder();
  57.      *     $qb->select('u')->from('User', 'u')
  58.      *         ->where($expr->orX($expr->eq('u.id', 1), $expr->eq('u.id', 2)));
  59.      * </code>
  60.      *
  61.      * @return \Doctrine\ORM\Query\Expr
  62.      */
  63.     public function getExpressionBuilder();
  65.     /**
  66.      * Starts a transaction on the underlying database connection.
  67.      *
  68.      * @return void
  69.      */
  70.     public function beginTransaction();
  72.     /**
  73.      * Executes a function in a transaction.
  74.      *
  75.      * The function gets passed this EntityManager instance as an (optional) parameter.
  76.      *
  77.      * {@link flush} is invoked prior to transaction commit.
  78.      *
  79.      * If an exception occurs during execution of the function or flushing or transaction commit,
  80.      * the transaction is rolled back, the EntityManager closed and the exception re-thrown.
  81.      *
  82.      * @param callable $func The function to execute transactionally.
  83.      *
  84.      * @return mixed The non-empty value returned from the closure or true instead.
  85.      */
  86.     public function transactional($func);
  88.     /**
  89.      * Commits a transaction on the underlying database connection.
  90.      *
  91.      * @return void
  92.      */
  93.     public function commit();
  95.     /**
  96.      * Performs a rollback on the underlying database connection.
  97.      *
  98.      * @return void
  99.      */
  100.     public function rollback();
  102.     /**
  103.      * Creates a new Query object.
  104.      *
  105.      * @param string $dql The DQL string.
  106.      *
  107.      * @return Query
  108.      */
  109.     public function createQuery($dql = '');
  111.     /**
  112.      * Creates a Query from a named query.
  113.      *
  114.      * @param string $name
  115.      *
  116.      * @return Query
  117.      */
  118.     public function createNamedQuery($name);
  120.     /**
  121.      * Creates a native SQL query.
  122.      *
  123.      * @param string           $sql
  124.      * @param ResultSetMapping $rsm The ResultSetMapping to use.
  125.      *
  126.      * @return NativeQuery
  127.      */
  128.     public function createNativeQuery($sql, ResultSetMapping $rsm);
  130.     /**
  131.      * Creates a NativeQuery from a named native query.
  132.      *
  133.      * @param string $name
  134.      *
  135.      * @return NativeQuery
  136.      */
  137.     public function createNamedNativeQuery($name);
  139.     /**
  140.      * Create a QueryBuilder instance
  141.      *
  142.      * @return QueryBuilder
  143.      */
  144.     public function createQueryBuilder();
  146.     /**
  147.      * Gets a reference to the entity identified by the given type and identifier
  148.      * without actually loading it, if the entity is not yet loaded.
  149.      *
  150.      * @param string $entityName The name of the entity type.
  151.      * @param mixed  $id         The entity identifier.
  152.      *
  153.      * @return object|null The entity reference.
  154.      *
  155.      * @throws ORMException
  156.      */
  157.     public function getReference($entityName, $id);
  159.     /**
  160.      * Gets a partial reference to the entity identified by the given type and identifier
  161.      * without actually loading it, if the entity is not yet loaded.
  162.      *
  163.      * The returned reference may be a partial object if the entity is not yet loaded/managed.
  164.      * If it is a partial object it will not initialize the rest of the entity state on access.
  165.      * Thus you can only ever safely access the identifier of an entity obtained through
  166.      * this method.
  167.      *
  168.      * The use-cases for partial references involve maintaining bidirectional associations
  169.      * without loading one side of the association or to update an entity without loading it.
  170.      * Note, however, that in the latter case the original (persistent) entity data will
  171.      * never be visible to the application (especially not event listeners) as it will
  172.      * never be loaded in the first place.
  173.      *
  174.      * @param string $entityName The name of the entity type.
  175.      * @param mixed  $identifier The entity identifier.
  176.      *
  177.      * @return object|null The (partial) entity reference.
  178.      */
  179.     public function getPartialReference($entityName, $identifier);
  181.     /**
  182.      * Closes the EntityManager. All entities that are currently managed
  183.      * by this EntityManager become detached. The EntityManager may no longer
  184.      * be used after it is closed.
  185.      *
  186.      * @return void
  187.      */
  188.     public function close();
  190.     /**
  191.      * Creates a copy of the given entity. Can create a shallow or a deep copy.
  192.      *
  193.      * @deprecated 2.7 This method is being removed from the ORM and won't have any replacement
  194.      *
  195.      * @param object  $entity The entity to copy.
  196.      * @param boolean $deep   FALSE for a shallow copy, TRUE for a deep copy.
  197.      *
  198.      * @return object The new entity.
  199.      *
  200.      * @throws \BadMethodCallException
  201.      */
  202.     public function copy($entity, $deep = false);
  204.     /**
  205.      * Acquire a lock on the given entity.
  206.      *
  207.      * @param object   $entity
  208.      * @param int      $lockMode
  209.      * @param int|null $lockVersion
  210.      *
  211.      * @return void
  212.      *
  213.      * @throws OptimisticLockException
  214.      * @throws PessimisticLockException
  215.      */
  216.     public function lock($entity, $lockMode, $lockVersion = null);
  218.     /**
  219.      * Gets the EventManager used by the EntityManager.
  220.      *
  221.      * @return \Doctrine\Common\EventManager
  222.      */
  223.     public function getEventManager();
  225.     /**
  226.      * Gets the Configuration used by the EntityManager.
  227.      *
  228.      * @return Configuration
  229.      */
  230.     public function getConfiguration();
  232.     /**
  233.      * Check if the Entity manager is open or closed.
  234.      *
  235.      * @return bool
  236.      */
  237.     public function isOpen();
  239.     /**
  240.      * Gets the UnitOfWork used by the EntityManager to coordinate operations.
  241.      *
  242.      * @return UnitOfWork
  243.      */
  244.     public function getUnitOfWork();
  246.     /**
  247.     * Gets a hydrator for the given hydration mode.
  248.     *
  249.     * This method caches the hydrator instances which is used for all queries that don't
  250.     * selectively iterate over the result.
  251.     *
  252.     * @deprecated
  253.     *
  254.     * @param string|int $hydrationMode
  255.     *
  256.     * @return \Doctrine\ORM\Internal\Hydration\AbstractHydrator
  257.     */
  258.     public function getHydrator($hydrationMode);
  260.     /**
  261.      * Create a new instance for the given hydration mode.
  262.      *
  263.      * @param string|int $hydrationMode
  264.      *
  265.      * @return \Doctrine\ORM\Internal\Hydration\AbstractHydrator
  266.      *
  267.      * @throws ORMException
  268.      */
  269.     public function newHydrator($hydrationMode);
  271.     /**
  272.      * Gets the proxy factory used by the EntityManager to create entity proxies.
  273.      *
  274.      * @return \Doctrine\ORM\Proxy\ProxyFactory
  275.      */
  276.     public function getProxyFactory();
  278.     /**
  279.      * Gets the enabled filters.
  280.      *
  281.      * @return \Doctrine\ORM\Query\FilterCollection The active filter collection.
  282.      */
  283.     public function getFilters();
  285.     /**
  286.      * Checks whether the state of the filter collection is clean.
  287.      *
  288.      * @return boolean True, if the filter collection is clean.
  289.      */
  290.     public function isFiltersStateClean();
  292.     /**
  293.      * Checks whether the Entity Manager has filters.
  294.      *
  295.      * @return boolean True, if the EM has a filter collection.
  296.      */
  297.     public function hasFilters();
  298. }