Class PredicateSet

Summary

Fully Qualified Name: Laminas\Db\Sql\Predicate\PredicateSet
Implements: PredicateInterface, Countable

Description

Methods

Name Description Defined By
__construct() Constructor PredicateSet
addPredicate() Add predicate to set PredicateSet
addPredicates() Add predicates to set PredicateSet
andPredicate() Add predicate using AND operator PredicateSet
count() Get count of attached predicates PredicateSet
getExpressionData() Get predicate parts for where statement PredicateSet
getPredicates() Return the predicates PredicateSet
orPredicate() Add predicate using OR operator PredicateSet

Method Details

__construct()

Constructor

Parameter Name Type Description
$predicates null|array
$defaultCombination string

Returns:

addPredicate()

Add predicate to set

Parameter Name Type Description
$predicate \PredicateInterface
$combination string

Returns: self Provides a fluent interface

addPredicates()

Add predicates to set

Parameter Name Type Description
$predicates \PredicateInterface|\Closure|string|array
$combination string

Returns: self Provides a fluent interface

andPredicate()

Add predicate using AND operator

Parameter Name Type Description
$predicate \PredicateInterface

Returns: self Provides a fluent interface

count()

Get count of attached predicates

Returns: int

getExpressionData()

Get predicate parts for where statement

Returns: array

getPredicates()

Return the predicates

Returns: \PredicateInterface[]

orPredicate()

Add predicate using OR operator

Parameter Name Type Description
$predicate \PredicateInterface

Returns: self Provides a fluent interface

Top