Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Collections;
Chris@0: 
Chris@0: /**
Chris@0:  * Interface for collections that allow efficient filtering with an expression API.
Chris@0:  *
Chris@0:  * Goal of this interface is a backend independent method to fetch elements
Chris@0:  * from a collections. {@link Expression} is crafted in a way that you can
Chris@0:  * implement queries from both in-memory and database-backed collections.
Chris@0:  *
Chris@0:  * For database backed collections this allows very efficient access by
Chris@0:  * utilizing the query APIs, for example SQL in the ORM. Applications using
Chris@0:  * this API can implement efficient database access without having to ask the
Chris@0:  * EntityManager or Repositories.
Chris@0:  *
Chris@0:  * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0:  * @since  2.3
Chris@0:  */
Chris@0: interface Selectable
Chris@0: {
Chris@0:     /**
Chris@0:      * Selects all elements from a selectable that match the expression and
Chris@0:      * returns a new collection containing these elements.
Chris@0:      *
Chris@0:      * @param Criteria $criteria
Chris@0:      *
Chris@0:      * @return Collection
Chris@0:      */
Chris@0:     public function matching(Criteria $criteria);
Chris@0: }