. */ namespace Doctrine\ORM; /** * 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. * * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @link www.doctrine-project.org * @since 2.0 * @version $Revision$ * @author Roman Borschel */ class EntityRepository { private $_entityName; private $_em; private $_class; /** * Initializes a new EntityRepository. * * @param EntityManager $em The EntityManager to use. * @param ClassMetadata $classMetadata The class descriptor. */ public function __construct($em, \Doctrine\ORM\Mapping\ClassMetadata $class) { $this->_entityName = $class->name; $this->_em = $em; $this->_class = $class; } /** * Creates a new Doctrine_Query object and adds the component name * of this table as the query 'from' part. * * @param string Optional alias name for component aliasing. * @return Doctrine_Query */ protected function _createQuery($alias = '') { if ( ! empty($alias)) { $alias = ' ' . trim($alias); } return $this->_em->createQuery()->from($this->_entityName . $alias); } /** * Clears the repository, causing all managed entities to become detached. */ public function clear() { $this->_em->clear($this->_class->rootEntityName); } /** * Finds an entity by its primary key / identifier. * * @param $id The identifier. * @param int $hydrationMode The hydration mode to use. * @return mixed Array or Object or false if no result. */ public function find($id, $hydrationMode = null) { // Check identity map first if ($entity = $this->_em->getUnitOfWork()->tryGetById($id, $this->_class->rootEntityName)) { return $entity; // Hit! } if ( ! is_array($id) || count($id) <= 1) { $value = is_array($id) ? array_values($id) : array($id); $id = array_combine($this->_class->identifier, $value); } return $this->_em->getUnitOfWork()->getEntityPersister($this->_entityName)->load($id); } /** * Finds all entities in the repository. * * @param int $hydrationMode * @return mixed */ 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) { $results = $this->_createQuery()->where($fieldName . ' = ?') ->setMaxResults(1) ->execute(array($value), $hydrationMode); return $hydrationMode === Query::HYDRATE_ARRAY ? array_shift($results) : $results->getFirst(); } /** * Adds support for magic finders. * findByColumnName, findByRelationAlias * findById, findByContactId, etc. * * @return void * @throws BadMethodCallException If the method called is an invalid find* method * 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 { throw new BadMethodCallException("Undefined method '$method'."); } if (isset($by)) { if ( ! isset($arguments[0])) { throw DoctrineException::updateMe('You must specify the value to findBy.'); } $fieldName = Doctrine::tableize($by); $hydrationMode = isset($arguments[1]) ? $arguments[1]:null; if ($this->_class->hasField($fieldName)) { return $this->$method($fieldName, $arguments[0], $hydrationMode); } else if ($this->_class->hasRelation($by)) { $relation = $this->_class->getRelation($by); if ($relation['type'] === Doctrine_Relation::MANY) { throw DoctrineException::updateMe('Cannot findBy many relationship.'); } return $this->$method($relation['local'], $arguments[0], $hydrationMode); } else { throw DoctrineException::updateMe('Cannot find by: ' . $by . '. Invalid field or relationship alias.'); } } } }