Documentation

PredicateSet
in package

Predicate set class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

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

version
6.5.0

Table of Contents

Properties

$conjunction  : string|null
Conjunction
$nextConjunction  : string
Next conjunction
$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
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 =
getConjunction()  : string|null
Get the conjunction
getNextConjunction()  : string
Get the next conjunction
getPredicates()  : array<string|int, mixed>
Get predicates
getPredicateSets()  : array<string|int, mixed>
Get predicates
greaterThan()  : PredicateSet
Predicate for >
greaterThanOrEqualTo()  : PredicateSet
Predicate for >=
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
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 !=
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

Properties

$conjunction

Conjunction

protected string|null $conjunction = null

$nextConjunction

Next conjunction

protected string $nextConjunction = 'AND'

$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

addExpressions()

Add a predicates from string expressions

public addExpressions(array<string|int, mixed> $expressions) : PredicateSet
Parameters
$expressions : 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, string $value1, string $value2) : PredicateSet
Parameters
$column : string
$value1 : string
$value2 : string
Return values
PredicateSet

getConjunction()

Get the conjunction

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

getNextConjunction()

Get the next conjunction

public getNextConjunction() : string
Return values
string

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, string $value) : PredicateSet
Parameters
$column : string
$value : string
Return values
PredicateSet

hasPredicates()

Has predicates

public hasPredicates() : bool
Return values
bool

hasPredicateSets()

Has predicates

public hasPredicateSets() : bool
Return values
bool

lessThanOrEqualTo()

Predicate for <=

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

notBetween()

Predicate for NOT BETWEEN

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

render()

Predicate set render method

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

        
On this page

Search results