Documentation

Having extends PredicateSet
in package

Where predicate class

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
7.0.0

Table of Contents

Properties

$conjunction  : string|null
Conjunction
$nextConjunction  : string
Next conjunction
$parameters  : array<string|int, mixed>
Parameters (for binding)
$predicates  : array<string|int, mixed>
Predicates
$predicateSets  : array<string|int, mixed>
Nested predicate sets
$sql  : AbstractSql|null
SQL object

Methods

__construct()  : mixed
Constructor
__toString()  : string
Return predicate set string
add()  : PredicateSet
Add a predicate from a string expression
addExpressions()  : PredicateSet
Add a predicates from string expressions
addParameter()  : PredicateSet
Add parameter
addParameters()  : PredicateSet
Add parameters
addPredicate()  : PredicateSet
Add predicate
addPredicates()  : PredicateSet
Add predicates
addPredicateSet()  : PredicateSet
Add predicate set
addPredicateSets()  : PredicateSet
Add predicate sets
and()  : PredicateSet
Add an AND predicate from a string expression
andNest()  : PredicateSet
Add a nested predicate set with the AND conjunction
andPredicate()  : PredicateSet
Add AND predicate
between()  : PredicateSet
Predicate for BETWEEN
equalTo()  : PredicateSet
Predicate for =
exists()  : PredicateSet
Predicate for EXISTS
extractValues()  : array<string|int, mixed>
Extract values
getConjunction()  : string|null
Get the conjunction
getNextConjunction()  : string
Get the next conjunction
getParameter()  : mixed
Get parameter
getParameters()  : array<string|int, mixed>
Get parameters
getPredicates()  : array<string|int, mixed>
Get predicates
getPredicateSets()  : array<string|int, mixed>
Get predicates
greaterThan()  : PredicateSet
Predicate for >
greaterThanOrEqualTo()  : PredicateSet
Predicate for >=
hasParameter()  : bool
Has parameter
hasParameters()  : bool
Has parameters
hasPredicates()  : bool
Has predicates
hasPredicateSets()  : bool
Has predicates
in()  : PredicateSet
Predicate for IN
isNotNull()  : PredicateSet
Predicate for IS NOT NULL
isNull()  : PredicateSet
Predicate for IS NULL
jsonContains()  : PredicateSet
Predicate for JSON containment (MySQL/PostgreSQL only)
jsonEqualTo()  : PredicateSet
Predicate for JSON path equal to
jsonNotEqualTo()  : PredicateSet
Predicate for JSON path not equal to
lessThan()  : PredicateSet
Predicate for <
lessThanOrEqualTo()  : PredicateSet
Predicate for <=
like()  : PredicateSet
Predicate for LIKE
nest()  : PredicateSet
Add a nested predicate set
notBetween()  : PredicateSet
Predicate for NOT BETWEEN
notEqualTo()  : PredicateSet
Predicate for !=
notExists()  : PredicateSet
Predicate for NOT EXISTS
notIn()  : PredicateSet
Predicate for NOT IN
notLike()  : PredicateSet
Predicate for NOT LIKE
or()  : PredicateSet
Add an OR predicate from a string expression
orNest()  : PredicateSet
Add a nested predicate set with the OR conjunction
orPredicate()  : PredicateSet
Add OR predicate
render()  : string
Predicate set render method
setConjunction()  : PredicateSet
Get the conjunction
setNextConjunction()  : PredicateSet
Get the next conjunction
setParameters()  : PredicateSet
Set parameters
bindPlaceholder()  : mixed
Bind the resolved value as a parameter and return the placeholder token to render in its place
resolveExpressionValue()  : mixed
Resolve a parsed expression value against any bound parameters it references
splitBetweenValue()  : mixed
Split a BETWEEN/NOT BETWEEN value of the form 'value1 AND value2' into its two boundary values

Properties

$conjunction

Conjunction

protected string|null $conjunction = null

$nextConjunction

Next conjunction

protected string $nextConjunction = 'AND'

$parameters

Parameters (for binding)

protected array<string|int, mixed> $parameters = []

$predicates

Predicates

protected array<string|int, mixed> $predicates = []

$predicateSets

Nested predicate sets

protected array<string|int, mixed> $predicateSets = []

Methods

__construct()

Constructor

public __construct(AbstractSql $sql[, mixed $predicates = null ][, string|null $conjunction = null ]) : mixed

Instantiate the predicate set object

Parameters
$sql : AbstractSql
$predicates : mixed = null
$conjunction : string|null = null
Tags
throws
Exception

__toString()

Return predicate set string

public __toString() : string
Return values
string

add()

Add a predicate from a string expression

public add(string $expression[, mixed $placeholder = false ]) : PredicateSet
Parameters
$expression : string
$placeholder : mixed = false
Return values
PredicateSet

addExpressions()

Add a predicates from string expressions

public addExpressions(array<string|int, mixed> $expressions) : PredicateSet
Parameters
$expressions : array<string|int, mixed>
Return values
PredicateSet

addParameters()

Add parameters

public addParameters(array<string|int, mixed> $parameters) : PredicateSet
Parameters
$parameters : array<string|int, mixed>
Return values
PredicateSet

addPredicates()

Add predicates

public addPredicates(array<string|int, mixed> $predicates) : PredicateSet
Parameters
$predicates : array<string|int, mixed>
Return values
PredicateSet

addPredicateSets()

Add predicate sets

public addPredicateSets(array<string|int, mixed> $predicateSets) : PredicateSet
Parameters
$predicateSets : array<string|int, mixed>
Return values
PredicateSet

between()

Predicate for BETWEEN

public between(string $column, mixed $value1, mixed $value2) : PredicateSet
Parameters
$column : string
$value1 : mixed
$value2 : mixed
Return values
PredicateSet

extractValues()

Extract values

public extractValues([bool $placeholder = false ]) : array<string|int, mixed>
Parameters
$placeholder : bool = false
Return values
array<string|int, mixed>

getConjunction()

Get the conjunction

public getConjunction() : string|null
Return values
string|null

getNextConjunction()

Get the next conjunction

public getNextConjunction() : string
Return values
string

getParameter()

Get parameter

public getParameter(mixed $name) : mixed
Parameters
$name : mixed

getParameters()

Get parameters

public getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPredicates()

Get predicates

public getPredicates() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPredicateSets()

Get predicates

public getPredicateSets() : array<string|int, mixed>
Return values
array<string|int, mixed>

greaterThanOrEqualTo()

Predicate for >=

public greaterThanOrEqualTo(string $column, mixed $value) : PredicateSet
Parameters
$column : string
$value : mixed
Return values
PredicateSet

hasParameter()

Has parameter

public hasParameter(mixed $name) : bool
Parameters
$name : mixed
Return values
bool

hasParameters()

Has parameters

public hasParameters() : bool
Return values
bool

hasPredicates()

Has predicates

public hasPredicates() : bool
Return values
bool

hasPredicateSets()

Has predicates

public hasPredicateSets() : bool
Return values
bool

jsonContains()

Predicate for JSON containment (MySQL/PostgreSQL only)

public jsonContains(string $column, string $path, mixed $value) : PredicateSet
Parameters
$column : string
$path : string
$value : mixed
Return values
PredicateSet

jsonEqualTo()

Predicate for JSON path equal to

public jsonEqualTo(string $column, string $path, mixed $value) : PredicateSet
Parameters
$column : string
$path : string
$value : mixed
Return values
PredicateSet

jsonNotEqualTo()

Predicate for JSON path not equal to

public jsonNotEqualTo(string $column, string $path, mixed $value) : PredicateSet
Parameters
$column : string
$path : string
$value : mixed
Return values
PredicateSet

lessThanOrEqualTo()

Predicate for <=

public lessThanOrEqualTo(string $column, mixed $value) : PredicateSet
Parameters
$column : string
$value : mixed
Return values
PredicateSet

notBetween()

Predicate for NOT BETWEEN

public notBetween(string $column, mixed $value1, mixed $value2) : PredicateSet
Parameters
$column : string
$value1 : mixed
$value2 : mixed
Return values
PredicateSet

render()

Predicate set render method

public render() : string
Tags
throws
Exception
Return values
string

setParameters()

Set parameters

public setParameters(array<string|int, mixed> $parameters) : PredicateSet
Parameters
$parameters : array<string|int, mixed>
Return values
PredicateSet

bindPlaceholder()

Bind the resolved value as a parameter and return the placeholder token to render in its place

protected bindPlaceholder(string $column, mixed $value, mixed $placeholder) : mixed
Parameters
$column : string
$value : mixed
$placeholder : mixed

resolveExpressionValue()

Resolve a parsed expression value against any bound parameters it references

protected resolveExpressionValue(string $column, mixed $value) : mixed
Parameters
$column : string
$value : mixed

splitBetweenValue()

Split a BETWEEN/NOT BETWEEN value of the form 'value1 AND value2' into its two boundary values

protected static splitBetweenValue(mixed $value) : mixed
Parameters
$value : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results