interface ObjectRepository in Plug 7

Contract for a Doctrine persistence layer ObjectRepository class to implement.

@link www.doctrine-project.org @since 2.1 @author Benjamin Eberlei <[e-mail]> @author Jonathan Wage <[e-mail]>

Hierarchy

• interface \Doctrine\Common\Persistence\ObjectRepository

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/ObjectRepository.php, line 30

Namespace

Doctrine\Common\Persistence

interface ObjectRepository {

  /**
   * Finds an object by its primary key / identifier.
   *
   * @param mixed $id The identifier.
   *
   * @return object The object.
   */
  public function find($id);

  /**
   * Finds all objects in the repository.
   *
   * @return array The objects.
   */
  public function findAll();

  /**
   * Finds objects by a set of criteria.
   *
   * Optionally sorting and limiting details can be passed. An implementation may throw
   * an UnexpectedValueException if certain values of the sorting or limiting details are
   * not supported.
   *
   * @param array      $criteria
   * @param array|null $orderBy
   * @param int|null   $limit
   * @param int|null   $offset
   *
   * @return array The objects.
   *
   * @throws \UnexpectedValueException
   */
  public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null);

  /**
   * Finds a single object by a set of criteria.
   *
   * @param array $criteria The criteria.
   *
   * @return object The object.
   */
  public function findOneBy(array $criteria);

  /**
   * Returns the class name of the object managed by the repository.
   *
   * @return string
   */
  public function getClassName();

}

Members

Name	Modifiers	Type	Description	Overrides
ObjectRepository::find	public	function	Finds an object by its primary key / identifier.
ObjectRepository::findAll	public	function	Finds all objects in the repository.
ObjectRepository::findBy	public	function	Finds objects by a set of criteria.
ObjectRepository::findOneBy	public	function	Finds a single object by a set of criteria.
ObjectRepository::getClassName	public	function	Returns the class name of the object managed by the repository.