Public Member Functions
	nest ()
	Begin nesting predicates.

	setUnnest (Predicate $predicate)
	Indicate what predicate will be unnested.

	unnest ()
	Indicate end of nested predicate.

	equalTo ($left, $right, $leftType=self::TYPE_IDENTIFIER, $rightType=self::TYPE_VALUE)
	Create "Equal To" predicate.

	notEqualTo ($left, $right, $leftType=self::TYPE_IDENTIFIER, $rightType=self::TYPE_VALUE)
	Create "Not Equal To" predicate.

	lessThan ($left, $right, $leftType=self::TYPE_IDENTIFIER, $rightType=self::TYPE_VALUE)
	Create "Less Than" predicate.

	greaterThan ($left, $right, $leftType=self::TYPE_IDENTIFIER, $rightType=self::TYPE_VALUE)
	Create "Greater Than" predicate.

	lessThanOrEqualTo ($left, $right, $leftType=self::TYPE_IDENTIFIER, $rightType=self::TYPE_VALUE)
	Create "Less Than Or Equal To" predicate.

	greaterThanOrEqualTo ($left, $right, $leftType=self::TYPE_IDENTIFIER, $rightType=self::TYPE_VALUE)
	Create "Greater Than Or Equal To" predicate.

	like ($identifier, $like)
	Create "Like" predicate.

	notLike ($identifier, $notLike)
	Create "notLike" predicate.

	expression ($expression, $parameters=null)
	Create an expression, with parameter placeholders.

	literal ($literal)
	Create "Literal" predicate.

	isNull ($identifier)
	Create "IS NULL" predicate.

	isNotNull ($identifier)
	Create "IS NOT NULL" predicate.

	in ($identifier, $valueSet=null)
	Create "IN" predicate.

	notIn ($identifier, $valueSet=null)
	Create "NOT IN" predicate.

	between ($identifier, $minValue, $maxValue)
	Create "between" predicate.

	notBetween ($identifier, $minValue, $maxValue)
	Create "NOT BETWEEN" predicate.

	predicate (PredicateInterface $predicate)
	Use given predicate directly.

	__get ($name)
	Overloading.

Public Member Functions inherited from PredicateSet
	__construct (array $predicates=null, $defaultCombination=self::COMBINED_BY_AND)
	Constructor.

	addPredicate (PredicateInterface $predicate, $combination=null)
	Add predicate to set.

	addPredicates ($predicates, $combination=self::OP_AND)
	Add predicates to set.

	getPredicates ()
	Return the predicates.

	orPredicate (PredicateInterface $predicate)
	Add predicate using OR operator.

	andPredicate (PredicateInterface $predicate)
	Add predicate using AND operator.

	count ()
	Get count of attached predicates.

Protected Attributes
	$unnest = null

	$nextPredicateCombineOperator = null

Protected Attributes inherited from PredicateSet
	$defaultCombination = self::COMBINED_BY_AND

	$predicates = []

Additional Inherited Members
Public Attributes inherited from PredicateSet
const	COMBINED_BY_AND = 'AND'

const	OP_AND = 'AND'

const	COMBINED_BY_OR = 'OR'

const	OP_OR = 'OR'

Member Function Documentation

__get ( $name )

Overloading.

Overloads "or", "and", "nest", and "unnest"

Parameters

string $name

Returns: Predicate

between	(	$identifier,
		$minValue,
		$maxValue
	)

Create "between" predicate.

Utilizes Between predicate

Parameters

string	$identifier
int \| float \| string	$minValue
int \| float \| string	$maxValue

Returns: Predicate

equalTo	(	$left,
		$right,
		$leftType = `self::TYPE_IDENTIFIER`,
		$rightType = `self::TYPE_VALUE`
	)

Create "Equal To" predicate.

Utilizes Operator predicate

Parameters

int \| float \| bool \| string	$left
int \| float \| bool \| string	$right
string	$leftType	TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {

See Also: allowedTypes}

Parameters

string $rightType TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {

See Also: allowedTypes}

Returns: Predicate

expression	(	$expression,
		$parameters = `null`
	)

Create an expression, with parameter placeholders.

Parameters

$expression
$parameters

Returns: $this

greaterThan	(	$left,
		$right,
		$leftType = `self::TYPE_IDENTIFIER`,
		$rightType = `self::TYPE_VALUE`
	)

Create "Greater Than" predicate.

Utilizes Operator predicate

Parameters

int \| float \| bool \| string	$left
int \| float \| bool \| string	$right
string	$leftType	TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {

See Also: allowedTypes}

Parameters

string $rightType TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {

See Also: allowedTypes}

Returns: Predicate

greaterThanOrEqualTo	(	$left,
		$right,
		$leftType = `self::TYPE_IDENTIFIER`,
		$rightType = `self::TYPE_VALUE`
	)

Create "Greater Than Or Equal To" predicate.

Utilizes Operator predicate

Parameters

int \| float \| bool \| string	$left
int \| float \| bool \| string	$right
string	$leftType	TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {

See Also: allowedTypes}

Parameters

string $rightType TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {

See Also: allowedTypes}

Returns: Predicate

in	(	$identifier,
		$valueSet = `null`
	)

Create "IN" predicate.

Utilizes In predicate

Parameters

string	$identifier
array \| \Zend\Db\Sql\Select	$valueSet

Returns: Predicate

isNotNull ( $identifier )

Create "IS NOT NULL" predicate.

Utilizes IsNotNull predicate

Parameters

string $identifier

Returns: Predicate

isNull ( $identifier )

Create "IS NULL" predicate.

Utilizes IsNull predicate

Parameters

string $identifier

Returns: Predicate

lessThan	(	$left,
		$right,
		$leftType = `self::TYPE_IDENTIFIER`,
		$rightType = `self::TYPE_VALUE`
	)

Create "Less Than" predicate.

Utilizes Operator predicate

Parameters

int \| float \| bool \| string	$left
int \| float \| bool \| string	$right
string	$leftType	TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {

See Also: allowedTypes}

Parameters

string $rightType TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {

See Also: allowedTypes}

Returns: Predicate

lessThanOrEqualTo	(	$left,
		$right,
		$leftType = `self::TYPE_IDENTIFIER`,
		$rightType = `self::TYPE_VALUE`
	)

Create "Less Than Or Equal To" predicate.

Utilizes Operator predicate

Parameters

int \| float \| bool \| string	$left
int \| float \| bool \| string	$right
string	$leftType	TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {

See Also: allowedTypes}

Parameters

string $rightType TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {

See Also: allowedTypes}

Returns: Predicate

like	(	$identifier,
		$like
	)

Create "Like" predicate.

Utilizes Like predicate

Parameters

string	$identifier
string	$like

Returns: Predicate

literal ( $literal )

Create "Literal" predicate.

Literal predicate, for parameters, use expression()

Parameters

string $literal

Returns: Predicate

nest ( )

Begin nesting predicates.

Returns: Predicate

notBetween	(	$identifier,
		$minValue,
		$maxValue
	)

Create "NOT BETWEEN" predicate.

Utilizes NotBetween predicate

Parameters

string	$identifier
int \| float \| string	$minValue
int \| float \| string	$maxValue

Returns: Predicate

notEqualTo	(	$left,
		$right,
		$leftType = `self::TYPE_IDENTIFIER`,
		$rightType = `self::TYPE_VALUE`
	)

Create "Not Equal To" predicate.

Utilizes Operator predicate

Parameters

int \| float \| bool \| string	$left
int \| float \| bool \| string	$right
string	$leftType	TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {

See Also: allowedTypes}

Parameters

string $rightType TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {

See Also: allowedTypes}

Returns: Predicate

notIn	(	$identifier,
		$valueSet = `null`
	)

Create "NOT IN" predicate.

Utilizes NotIn predicate

Parameters

string	$identifier
array \| \Zend\Db\Sql\Select	$valueSet

Returns: Predicate

notLike	(	$identifier,
		$notLike
	)

Create "notLike" predicate.

Utilizes In predicate

Parameters

string	$identifier
string	$notLike

Returns: Predicate

predicate ( PredicateInterface $predicate )

Use given predicate directly.

Contrary to addPredicate() this method respects formerly set AND / OR combination operator, thus allowing generic predicates to be used fluently within where chains as any other concrete predicate.

Parameters

PredicateInterface $predicate

Returns: Predicate

setUnnest ( Predicate $predicate )

Indicate what predicate will be unnested.

Parameters

Predicate $predicate

Returns: void

unnest ( )

Indicate end of nested predicate.

Returns: Predicate

Exceptions

RuntimeException

Member Data Documentation

$nextPredicateCombineOperator = null

protected

$unnest = null

protected

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation