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 */
19
20namespace Doctrine\Common\Persistence;
21
22/**
23 * Contract for a Doctrine persistence layer ObjectRepository class to implement.
24 *
25 * @link   www.doctrine-project.org
26 * @since  2.1
27 * @author Benjamin Eberlei <kontakt@beberlei.de>
28 * @author Jonathan Wage <jonwage@gmail.com>
29 */
30interface ObjectRepository
31{
32    /**
33     * Finds an object by its primary key / identifier.
34     *
35     * @param mixed $id The identifier.
36     *
37     * @return object|null The object.
38     */
39    public function find($id);
40
41    /**
42     * Finds all objects in the repository.
43     *
44     * @return array The objects.
45     */
46    public function findAll();
47
48    /**
49     * Finds objects by a set of criteria.
50     *
51     * Optionally sorting and limiting details can be passed. An implementation may throw
52     * an UnexpectedValueException if certain values of the sorting or limiting details are
53     * not supported.
54     *
55     * @param array      $criteria
56     * @param array|null $orderBy
57     * @param int|null   $limit
58     * @param int|null   $offset
59     *
60     * @return array The objects.
61     *
62     * @throws \UnexpectedValueException
63     */
64    public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null);
65
66    /**
67     * Finds a single object by a set of criteria.
68     *
69     * @param array $criteria The criteria.
70     *
71     * @return object|null The object.
72     */
73    public function findOneBy(array $criteria);
74
75    /**
76     * Returns the class name of the object managed by the repository.
77     *
78     * @return string
79     */
80    public function getClassName();
81}
82