Zend Framework
Back to top  

 Methods

Constructor

__construct(array $predicates, string $defaultCombination) 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::__construct()

Parameters

$predicates

nullarray

$defaultCombination

string

Overloading

__get(string $name) : \Zend\Db\Sql\Predicate\Predicate

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

Parameters

$name

string

Returns

\Zend\Db\Sql\Predicate\Predicate

Add predicate to set

addPredicate(\Zend\Db\Sql\Predicate\PredicateInterface $predicate, string $combination) : \Zend\Db\Sql\Predicate\PredicateSet
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::addPredicate()

Parameters

$predicate

\Zend\Db\Sql\Predicate\PredicateInterface

$combination

string

Returns

\Zend\Db\Sql\Predicate\PredicateSet

Add predicates to set

addPredicates(\Zend\Db\Sql\Predicate\PredicateInterface | \Closure | string | array $predicates, string $combination) : \Zend\Db\Sql\Predicate\PredicateSet
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::addPredicates()

Parameters

$predicates

\Zend\Db\Sql\Predicate\PredicateInterface\Closurestringarray

$combination

string

Returns

\Zend\Db\Sql\Predicate\PredicateSet

Add predicate using AND operator

andPredicate(\Zend\Db\Sql\Predicate\PredicateInterface $predicate) : \Zend\Db\Sql\Predicate\PredicateSet
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::andPredicate()

Parameters

$predicate

\Zend\Db\Sql\Predicate\PredicateInterface

Returns

\Zend\Db\Sql\Predicate\PredicateSet

Create "between" predicate

between(string $identifier, int | float | string $minValue, int | float | string $maxValue) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Between predicate

Parameters

$identifier

string

$minValue

intfloatstring

$maxValue

intfloatstring

Returns

\Zend\Db\Sql\Predicate\Predicate

Get count of attached predicates

count() : int
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::count()

Returns

int

Create "Equal To" predicate

equalTo(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Operator predicate

Parameters

$left

intfloatboolstring

$right

intfloatboolstring

$leftType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {@see allowedTypes}

$rightType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {@see allowedTypes}

Returns

\Zend\Db\Sql\Predicate\Predicate

Create an expression, with parameter placeholders

expression($expression, $parameters) : \Zend\Db\Sql\Predicate\$this

Parameters

$expression

$parameters

Returns

\Zend\Db\Sql\Predicate\$this

Get predicate parts for where statement

getExpressionData() : array
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::getExpressionData()

Returns

array

Return the predicates

getPredicates() : \Zend\Db\Sql\Predicate\PredicateInterface[]
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::getPredicates()

Returns

\Zend\Db\Sql\Predicate\PredicateInterface[]

Create "Greater Than" predicate

greaterThan(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Operator predicate

Parameters

$left

intfloatboolstring

$right

intfloatboolstring

$leftType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {@see allowedTypes}

$rightType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {@see allowedTypes}

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "Greater Than Or Equal To" predicate

greaterThanOrEqualTo(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Operator predicate

Parameters

$left

intfloatboolstring

$right

intfloatboolstring

$leftType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {@see allowedTypes}

$rightType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {@see allowedTypes}

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "IN" predicate

in(string $identifier, array | \Zend\Db\Sql\Select $valueSet) : \Zend\Db\Sql\Predicate\Predicate

Utilizes In predicate

Parameters

$identifier

string

$valueSet

array\Zend\Db\Sql\Select

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "IS NOT NULL" predicate

isNotNull(string $identifier) : \Zend\Db\Sql\Predicate\Predicate

Utilizes IsNotNull predicate

Parameters

$identifier

string

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "IS NULL" predicate

isNull(string $identifier) : \Zend\Db\Sql\Predicate\Predicate

Utilizes IsNull predicate

Parameters

$identifier

string

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "Less Than" predicate

lessThan(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Operator predicate

Parameters

$left

intfloatboolstring

$right

intfloatboolstring

$leftType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {@see allowedTypes}

$rightType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {@see allowedTypes}

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "Less Than Or Equal To" predicate

lessThanOrEqualTo(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Operator predicate

Parameters

$left

intfloatboolstring

$right

intfloatboolstring

$leftType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {@see allowedTypes}

$rightType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {@see allowedTypes}

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "Literal" predicate

literal(string $literal) : \Zend\Db\Sql\Predicate\Predicate

Literal predicate, for parameters, use expression()

Parameters

$literal

string

Returns

\Zend\Db\Sql\Predicate\Predicate

Begin nesting predicates

nest() : \Zend\Db\Sql\Predicate\Predicate

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "Not Equal To" predicate

notEqualTo(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate

Utilizes Operator predicate

Parameters

$left

intfloatboolstring

$right

intfloatboolstring

$leftType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_IDENTIFIER {@see allowedTypes}

$rightType

string

TYPE_IDENTIFIER or TYPE_VALUE by default TYPE_VALUE {@see allowedTypes}

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "NOT IN" predicate

notIn(string $identifier, array | \Zend\Db\Sql\Select $valueSet) : \Zend\Db\Sql\Predicate\Predicate

Utilizes NotIn predicate

Parameters

$identifier

string

$valueSet

array\Zend\Db\Sql\Select

Returns

\Zend\Db\Sql\Predicate\Predicate

Create "notLike" predicate

notLike(string $identifier, string $notLike) : \Zend\Db\Sql\Predicate\Predicate

Utilizes In predicate

Parameters

$identifier

string

$notLike

string

Returns

\Zend\Db\Sql\Predicate\Predicate

Add predicate using OR operator

orPredicate(\Zend\Db\Sql\Predicate\PredicateInterface $predicate) : \Zend\Db\Sql\Predicate\PredicateSet
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::orPredicate()

Parameters

$predicate

\Zend\Db\Sql\Predicate\PredicateInterface

Returns

\Zend\Db\Sql\Predicate\PredicateSet

Use given predicate directly

predicate(\Zend\Db\Sql\Predicate\PredicateInterface $predicate) : \Zend\Db\Sql\Predicate\Predicate

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

$predicate

\Zend\Db\Sql\Predicate\PredicateInterface

Returns

\Zend\Db\Sql\Predicate\Predicate

Indicate what predicate will be unnested

setUnnest(\Zend\Db\Sql\Predicate\Predicate $predicate) : void

Parameters

$predicate

\Zend\Db\Sql\Predicate\Predicate

Indicate end of nested predicate

unnest() : \Zend\Db\Sql\Predicate\Predicate

Exceptions

\Zend\Db\Sql\Exception\RuntimeException

Returns

\Zend\Db\Sql\Predicate\Predicate

 Properties

 

$AND

$AND : \Zend\Db\Sql\Predicate\Predicate

magic
property
 

$NEST

$NEST : \Zend\Db\Sql\Predicate\Predicate

magic
property
 

$OR

$OR : \Zend\Db\Sql\Predicate\Predicate

magic
property
 

$UNNEST

$UNNEST : \Zend\Db\Sql\Predicate\Predicate

magic
property
 

$and

$and : \Zend\Db\Sql\Predicate\Predicate

magic
property
 

$or

$or : \Zend\Db\Sql\Predicate\Predicate

magic
property
 

$defaultCombination

$defaultCombination 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::$$defaultCombination
 

$nextPredicateCombineOperator

$nextPredicateCombineOperator 

 

$predicates

$predicates 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::$$predicates
 

$unnest

$unnest 

 Constants

 

COMBINED_BY_AND

COMBINED_BY_AND 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::COMBINED_BY_AND
 

COMBINED_BY_OR

COMBINED_BY_OR 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::COMBINED_BY_OR
 

OP_AND

OP_AND 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::OP_AND
 

OP_OR

OP_OR 
Inherited

inherited_from \Zend\Db\Sql\Predicate\PredicateSet::OP_OR