You are browsing a version that has not yet been released.
Maintained
3.0 (upcoming) 2.5 (upcoming) 2.4.0 (current)
Unmaintained
2.3 2.2 2.1 2.0 1.8 1.7 1.6

Expressions

The Doctrine\Common\Collections\Expr\Comparison class can be used to create comparison expressions to be used with the Doctrine\Common\Collections\Criteria class. It has the following operator constants:

  • Comparison::EQ
  • Comparison::NEQ
  • Comparison::LT
  • Comparison::LTE
  • Comparison::GT
  • Comparison::GTE
  • Comparison::IS
  • Comparison::IN
  • Comparison::NIN
  • Comparison::CONTAINS
  • Comparison::MEMBER_OF
  • Comparison::STARTS_WITH
  • Comparison::ENDS_WITH

The Doctrine\Common\Collections\Expr\CompositeExpression class can be used to create composite expressions to be used with the Doctrine\Common\Collections\Criteria class. It has the following operator constants:

  • CompositeExpression::TYPE_AND
  • CompositeExpression::TYPE_OR
  • CompositeExpression::TYPE_NOT

When using the TYPE_OR and TYPE_AND operators the CompositeExpression accepts multiple expressions as parameter but only one expression can be provided when using the NOT operator.

The Doctrine\Common\Collections\Criteria class has the following API to be used with expressions:

where

Sets the where expression to evaluate when this Criteria is searched for.

$expr = new Comparison('key', Comparison::EQ, 'value');$criteria->where($expr);

andWhere

Appends the where expression to evaluate when this Criteria is searched for using an AND with previous expression.

$expr = new Comparison('key', Comparison::EQ, 'value');$criteria->andWhere($expr);

orWhere

Appends the where expression to evaluate when this Criteria is searched for using an OR with previous expression.

$expr1 = new Comparison('key', Comparison::EQ, 'value1');$expr2 = new Comparison('key', Comparison::EQ, 'value2');$criteria->where($expr1);$criteria->orWhere($expr2);

orderBy

Sets the ordering of the result of this Criteria.

use Doctrine\Common\Collections\Order;$criteria->orderBy(['name' => Order::Ascending]);

setFirstResult

Set the number of first result that this Criteria should return.

$criteria->setFirstResult(0);

getFirstResult

Gets the current first result option of this Criteria.

$criteria->setFirstResult(10);echo $criteria->getFirstResult(); // 10

setMaxResults

Sets the max results that this Criteria should return.

$criteria->setMaxResults(20);

getMaxResults

Gets the current max results option of this Criteria.

$criteria->setMaxResults(20);echo $criteria->getMaxResults(); // 20