annotate vendor/doctrine/collections/lib/Doctrine/Common/Collections/Selectable.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /*
Chris@0 3 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0 4 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0 5 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0 6 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0 7 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0 8 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0 9 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0 10 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0 11 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0 12 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0 13 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0 14 *
Chris@0 15 * This software consists of voluntary contributions made by many individuals
Chris@0 16 * and is licensed under the MIT license. For more information, see
Chris@0 17 * <http://www.doctrine-project.org>.
Chris@0 18 */
Chris@0 19
Chris@0 20 namespace Doctrine\Common\Collections;
Chris@0 21
Chris@0 22 /**
Chris@0 23 * Interface for collections that allow efficient filtering with an expression API.
Chris@0 24 *
Chris@0 25 * Goal of this interface is a backend independent method to fetch elements
Chris@0 26 * from a collections. {@link Expression} is crafted in a way that you can
Chris@0 27 * implement queries from both in-memory and database-backed collections.
Chris@0 28 *
Chris@0 29 * For database backed collections this allows very efficient access by
Chris@0 30 * utilizing the query APIs, for example SQL in the ORM. Applications using
Chris@0 31 * this API can implement efficient database access without having to ask the
Chris@0 32 * EntityManager or Repositories.
Chris@0 33 *
Chris@0 34 * @author Benjamin Eberlei <kontakt@beberlei.de>
Chris@0 35 * @since 2.3
Chris@0 36 */
Chris@0 37 interface Selectable
Chris@0 38 {
Chris@0 39 /**
Chris@0 40 * Selects all elements from a selectable that match the expression and
Chris@0 41 * returns a new collection containing these elements.
Chris@0 42 *
Chris@0 43 * @param Criteria $criteria
Chris@0 44 *
Chris@0 45 * @return Collection
Chris@0 46 */
Chris@0 47 public function matching(Criteria $criteria);
Chris@0 48 }