2008-05-06 17:41:22 +04:00
|
|
|
<?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
|
2009-05-11 14:43:27 +04:00
|
|
|
* <http://www.doctrine-project.org>.
|
2008-05-06 17:41:22 +04:00
|
|
|
*/
|
|
|
|
|
2009-01-22 22:38:10 +03:00
|
|
|
namespace Doctrine\ORM;
|
2008-05-30 16:09:24 +04:00
|
|
|
|
2008-05-06 17:41:22 +04:00
|
|
|
/**
|
2009-05-26 15:30:07 +04:00
|
|
|
* An EntityRepository serves as a repository for entities with generic as well as
|
|
|
|
* business specific methods for retrieving entities.
|
|
|
|
*
|
|
|
|
* This class is designed for inheritance and users can subclass this class to
|
|
|
|
* write their own repositories.
|
2008-05-06 17:41:22 +04:00
|
|
|
*
|
|
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
2008-09-13 14:36:58 +04:00
|
|
|
* @link www.doctrine-project.org
|
2008-05-06 17:41:22 +04:00
|
|
|
* @since 2.0
|
|
|
|
* @version $Revision$
|
|
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
|
|
*/
|
2009-01-22 22:38:10 +03:00
|
|
|
class EntityRepository
|
2008-05-06 17:41:22 +04:00
|
|
|
{
|
2009-07-30 19:16:02 +04:00
|
|
|
private $_entityName;
|
|
|
|
private $_em;
|
|
|
|
private $_class;
|
2008-05-06 17:41:22 +04:00
|
|
|
|
2009-07-30 19:16:02 +04:00
|
|
|
/**
|
|
|
|
* Initializes a new <tt>EntityRepository</tt>.
|
|
|
|
*
|
|
|
|
* @param EntityManager $em The EntityManager to use.
|
|
|
|
* @param ClassMetadata $classMetadata The class descriptor.
|
|
|
|
*/
|
|
|
|
public function __construct($em, \Doctrine\ORM\Mapping\ClassMetadata $class)
|
2008-05-06 17:41:22 +04:00
|
|
|
{
|
2009-07-30 19:16:02 +04:00
|
|
|
$this->_entityName = $class->name;
|
2009-01-07 20:46:02 +03:00
|
|
|
$this->_em = $em;
|
2009-07-30 19:16:02 +04:00
|
|
|
$this->_class = $class;
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2009-07-30 19:16:02 +04:00
|
|
|
* Creates a new Doctrine_Query object and adds the component name
|
|
|
|
* of this table as the query 'from' part.
|
2008-05-06 17:41:22 +04:00
|
|
|
*
|
|
|
|
* @param string Optional alias name for component aliasing.
|
|
|
|
* @return Doctrine_Query
|
|
|
|
*/
|
|
|
|
protected function _createQuery($alias = '')
|
|
|
|
{
|
|
|
|
if ( ! empty($alias)) {
|
|
|
|
$alias = ' ' . trim($alias);
|
|
|
|
}
|
2008-05-24 21:10:45 +04:00
|
|
|
return $this->_em->createQuery()->from($this->_entityName . $alias);
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2008-05-14 01:20:34 +04:00
|
|
|
* Clears the repository, causing all managed entities to become detached.
|
2008-05-06 17:41:22 +04:00
|
|
|
*/
|
|
|
|
public function clear()
|
|
|
|
{
|
2009-07-30 19:16:02 +04:00
|
|
|
$this->_em->clear($this->_class->rootEntityName);
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2009-07-30 19:16:02 +04:00
|
|
|
* Finds an entity by its primary key / identifier.
|
2008-05-06 17:41:22 +04:00
|
|
|
*
|
2009-07-30 19:16:02 +04:00
|
|
|
* @param $id The identifier.
|
|
|
|
* @param int $hydrationMode The hydration mode to use.
|
|
|
|
* @return mixed Array or Object or false if no result.
|
2008-05-06 17:41:22 +04:00
|
|
|
*/
|
|
|
|
public function find($id, $hydrationMode = null)
|
|
|
|
{
|
2009-01-07 20:46:02 +03:00
|
|
|
// Check identity map first
|
2009-07-30 19:16:02 +04:00
|
|
|
if ($entity = $this->_em->getUnitOfWork()->tryGetById($id, $this->_class->rootEntityName)) {
|
2009-01-07 20:46:02 +03:00
|
|
|
return $entity; // Hit!
|
|
|
|
}
|
2008-05-06 17:41:22 +04:00
|
|
|
|
2009-05-13 19:19:27 +04:00
|
|
|
if ( ! is_array($id) || count($id) <= 1) {
|
|
|
|
$value = is_array($id) ? array_values($id) : array($id);
|
2009-07-30 19:16:02 +04:00
|
|
|
$id = array_combine($this->_class->identifier, $value);
|
2009-05-11 14:43:27 +04:00
|
|
|
}
|
|
|
|
|
2009-05-13 19:19:27 +04:00
|
|
|
return $this->_em->getUnitOfWork()->getEntityPersister($this->_entityName)->load($id);
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2008-05-24 21:10:45 +04:00
|
|
|
* Finds all entities in the repository.
|
2008-05-06 17:41:22 +04:00
|
|
|
*
|
2008-05-24 21:10:45 +04:00
|
|
|
* @param int $hydrationMode
|
|
|
|
* @return mixed
|
2008-05-06 17:41:22 +04:00
|
|
|
*/
|
|
|
|
public function findAll($hydrationMode = null)
|
|
|
|
{
|
|
|
|
return $this->_createQuery()->execute(array(), $hydrationMode);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* findBy
|
|
|
|
*
|
|
|
|
* @param string $column
|
|
|
|
* @param string $value
|
|
|
|
* @param string $hydrationMode
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
protected function findBy($fieldName, $value, $hydrationMode = null)
|
|
|
|
{
|
|
|
|
return $this->_createQuery()->where($fieldName . ' = ?')->execute(array($value), $hydrationMode);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* findOneBy
|
|
|
|
*
|
|
|
|
* @param string $column
|
|
|
|
* @param string $value
|
|
|
|
* @param string $hydrationMode
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
protected function findOneBy($fieldName, $value, $hydrationMode = null)
|
|
|
|
{
|
2009-07-30 19:16:02 +04:00
|
|
|
$results = $this->_createQuery()->where($fieldName . ' = ?')
|
|
|
|
->setMaxResults(1)
|
|
|
|
->execute(array($value), $hydrationMode);
|
|
|
|
return $hydrationMode === Query::HYDRATE_ARRAY ? array_shift($results) : $results->getFirst();
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Adds support for magic finders.
|
|
|
|
* findByColumnName, findByRelationAlias
|
|
|
|
* findById, findByContactId, etc.
|
|
|
|
*
|
|
|
|
* @return void
|
2008-09-13 14:36:58 +04:00
|
|
|
* @throws BadMethodCallException If the method called is an invalid find* method
|
2008-05-06 17:41:22 +04:00
|
|
|
* or no find* method at all and therefore an invalid
|
|
|
|
* method call.
|
|
|
|
*/
|
|
|
|
public function __call($method, $arguments)
|
|
|
|
{
|
|
|
|
if (substr($method, 0, 6) == 'findBy') {
|
|
|
|
$by = substr($method, 6, strlen($method));
|
|
|
|
$method = 'findBy';
|
|
|
|
} else if (substr($method, 0, 9) == 'findOneBy') {
|
|
|
|
$by = substr($method, 9, strlen($method));
|
|
|
|
$method = 'findOneBy';
|
|
|
|
} else {
|
2008-09-13 14:36:58 +04:00
|
|
|
throw new BadMethodCallException("Undefined method '$method'.");
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($by)) {
|
|
|
|
if ( ! isset($arguments[0])) {
|
2009-05-13 19:19:27 +04:00
|
|
|
throw DoctrineException::updateMe('You must specify the value to findBy.');
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
$fieldName = Doctrine::tableize($by);
|
|
|
|
$hydrationMode = isset($arguments[1]) ? $arguments[1]:null;
|
|
|
|
|
2009-07-30 19:16:02 +04:00
|
|
|
if ($this->_class->hasField($fieldName)) {
|
2008-05-06 17:41:22 +04:00
|
|
|
return $this->$method($fieldName, $arguments[0], $hydrationMode);
|
2009-07-30 19:16:02 +04:00
|
|
|
} else if ($this->_class->hasRelation($by)) {
|
|
|
|
$relation = $this->_class->getRelation($by);
|
2008-05-06 17:41:22 +04:00
|
|
|
if ($relation['type'] === Doctrine_Relation::MANY) {
|
2009-05-13 19:19:27 +04:00
|
|
|
throw DoctrineException::updateMe('Cannot findBy many relationship.');
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
return $this->$method($relation['local'], $arguments[0], $hydrationMode);
|
|
|
|
} else {
|
2009-05-13 19:19:27 +04:00
|
|
|
throw DoctrineException::updateMe('Cannot find by: ' . $by . '. Invalid field or relationship alias.');
|
2008-05-06 17:41:22 +04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|