Selectable.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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\Collections;
  20. /**
  21. * Interface for collections that allow efficient filtering with an expression API.
  22. *
  23. * Goal of this interface is a backend independent method to fetch elements
  24. * from a collections. {@link Expression} is crafted in a way that you can
  25. * implement queries from both in-memory and database-backed collections.
  26. *
  27. * For database backed collections this allows very efficient access by
  28. * utilizing the query APIs, for example SQL in the ORM. Applications using
  29. * this API can implement efficient database access without having to ask the
  30. * EntityManager or Repositories.
  31. *
  32. * @author Benjamin Eberlei <kontakt@beberlei.de>
  33. * @since 2.3
  34. */
  35. interface Selectable
  36. {
  37. /**
  38. * Selects all elements from a selectable that match the expression and
  39. * returns a new collection containing these elements.
  40. *
  41. * @param Criteria $criteria
  42. *
  43. * @return Collection
  44. */
  45. function matching(Criteria $criteria);
  46. }