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 LGPL. For more information, see

    17  * <http://www.doctrine-project.org>.

    18  */

    19 

    20 namespace Doctrine\Common\Persistence;

    21 

    22 /**

    23  * Contract for a Doctrine persistence layer ObjectRepository class to implement.

    24  *

    25  * @license http://www.opensource.org/licenses/lgpl-license.php LGPL

    26  * @link    www.doctrine-project.org

    27  * @since   2.1

    28  * @author  Benjamin Eberlei <kontakt@beberlei.de>

    29  * @author  Jonathan Wage <jonwage@gmail.com>

    30  */

    31 interface ObjectRepository

    32 {

    33     /**

    34      * Finds an object by its primary key / identifier.

    35      *

    36      * @param $id The identifier.

    37      * @return object The object.

    38      */

    39     public function find($id);

    40 

    41     /**

    42      * Finds all objects in the repository.

    43      *

    44      * @return mixed 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      * @throws UnexpectedValueException

    56      * @param array $criteria

    57      * @param array|null $orderBy

    58      * @param int|null $limit

    59      * @param int|null $offset

    60      * @return mixed The objects.

    61      */

    62     public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null);

    63 

    64     /**

    65      * Finds a single object by a set of criteria.

    66      *

    67      * @param array $criteria

    68      * @return object The object.

    69      */

    70     public function findOneBy(array $criteria);

    71 }