Methods
Constructor
__construct(array $predicates, string $defaultCombination)
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::__construct() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::__construct() |
Parameters
$predicates
nullarray
$defaultCombination
string
Overloading
__get(string $name) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Overloads "or", "and", "nest", and "unnest"
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::__get() |
Parameters
$name
string
Returns
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() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::addPredicate() |
Parameters
$combination
string
Returns
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() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::andPredicate() |
Parameters
Returns
Create "between" predicate
between(string $identifier, int | float | string $minValue, int | float | string $maxValue) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes Between predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::between() |
Parameters
$identifier
string
$minValue
intfloatstring
$maxValue
intfloatstring
Returns
Get count of attached predicates
count() : int
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::count() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::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
Inherited
Utilizes Operator predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::equalTo() |
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
Create an expression, with parameter placeholders
expression($expression, $parameters) : \Zend\Db\Sql\Predicate\$this
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::expression() |
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() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::getExpressionData() |
Returns
array
Return the predicates
getPredicates() : \Zend\Db\Sql\Predicate\PredicateInterface[]
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::getPredicates() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::getPredicates() |
Returns
Create "Greater Than" predicate
greaterThan(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes Operator predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::greaterThan() |
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
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
Inherited
Utilizes Operator predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::greaterThanOrEqualTo() |
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
Create "IS NOT NULL" predicate
isNotNull(string $identifier) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes IsNotNull predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::isNotNull() |
Parameters
$identifier
string
Returns
Create "IS NULL" predicate
isNull(string $identifier) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes IsNull predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::isNull() |
Parameters
$identifier
string
Returns
Create "Less Than" predicate
lessThan(int | float | bool | string $left, int | float | bool | string $right, string $leftType, string $rightType) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes Operator predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::lessThan() |
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
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
Inherited
Utilizes Operator predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::lessThanOrEqualTo() |
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
Create "Like" predicate
like(string $identifier, string $like) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes Like predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::like() |
Parameters
$identifier
string
$like
string
Returns
Create "Literal" predicate
literal(string $literal) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Literal predicate, for parameters, use expression()
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::literal() |
Parameters
$literal
string
Returns
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
Inherited
Utilizes Operator predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::notEqualTo() |
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
Create "NOT IN" predicate
notIn(string $identifier, array | \Zend\Db\Sql\Select $valueSet) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes NotIn predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::notIn() |
Parameters
$identifier
string
Returns
Create "notLike" predicate
notLike(string $identifier, string $notLike) : \Zend\Db\Sql\Predicate\Predicate
Inherited
Utilizes In predicate
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::notLike() |
Parameters
$identifier
string
$notLike
string
Returns
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() |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::orPredicate() |
Parameters
Returns
Use given predicate directly
predicate(\Zend\Db\Sql\Predicate\PredicateInterface $predicate) : \Zend\Db\Sql\Predicate\Predicate
Inherited
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.
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::predicate() |
Parameters
Returns
Indicate what predicate will be unnested
setUnnest(\Zend\Db\Sql\Predicate\Predicate $predicate) : void
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::setUnnest() |
Parameters
Indicate end of nested predicate
unnest() : \Zend\Db\Sql\Predicate\Predicate
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::unnest() |
Exceptions
Returns
Properties
$defaultCombination
$defaultCombination
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::$$defaultCombination |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::$$defaultCombination |
$nextPredicateCombineOperator
$nextPredicateCombineOperator
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::$$nextPredicateCombineOperator |
$predicates
$predicates
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::$$predicates |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::$$predicates |
$unnest
$unnest
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::$$unnest |
Constants
COMBINED_BY_AND
COMBINED_BY_AND
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::COMBINED_BY_AND |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::COMBINED_BY_AND |
COMBINED_BY_OR
COMBINED_BY_OR
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::COMBINED_BY_OR |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::COMBINED_BY_OR |
OP_AND
OP_AND
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::OP_AND |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::OP_AND |
OP_OR
OP_OR
Inherited
inherited_from |
\Zend\Db\Sql\Predicate\PredicateSet::OP_OR |
inherited_from |
\Zend\Db\Sql\Predicate\Predicate::OP_OR |