79 lines
2.5 KiB
PHP
79 lines
2.5 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 LGPL. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\Common\Persistence;
|
|
|
|
/**
|
|
* Contract for a Doctrine persistence layer ObjectRepository class to implement.
|
|
*
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.doctrine-project.org
|
|
* @since 2.1
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
* @author Jonathan Wage <jonwage@gmail.com>
|
|
*/
|
|
interface ObjectRepository
|
|
{
|
|
/**
|
|
* Finds an object by its primary key / identifier.
|
|
*
|
|
* @param $id The identifier.
|
|
* @return object The object.
|
|
*/
|
|
function find($id);
|
|
|
|
/**
|
|
* Finds all objects in the repository.
|
|
*
|
|
* @return mixed The objects.
|
|
*/
|
|
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.
|
|
*
|
|
* @throws UnexpectedValueException
|
|
* @param array $criteria
|
|
* @param array|null $orderBy
|
|
* @param int|null $limit
|
|
* @param int|null $offset
|
|
* @return mixed The objects.
|
|
*/
|
|
function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null);
|
|
|
|
/**
|
|
* Finds a single object by a set of criteria.
|
|
*
|
|
* @param array $criteria
|
|
* @return object The object.
|
|
*/
|
|
function findOneBy(array $criteria);
|
|
|
|
/**
|
|
* Returns the class name of the object managed by the repository
|
|
*
|
|
* @return string
|
|
*/
|
|
function getClassName();
|
|
}
|