ObjectRepository.php 2.5 KB

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