classPredicates

packages/sql-catalog/src/Extension/Laravel/Predicates.php:22

final class Predicates

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Predicate effects, retaining Laravel's clause and binding order.

A comparison value that is not a literal null is compiled as a bound placeholder, and a list whose contents are unknown as a placeholder list of unknown length. Laravel's null normalization and empty-set constants are reconstructed from literals only, since the null and emptiness guards that usually precede such calls are not evaluated.

Methods§

public function __construct(private Grammar $grammar)

source §

Uses the configured framework SQL grammar.

Parameters

$grammar Grammar

public function apply(QueryState $state, string $method, list<Domain> $arguments): ?QueryState

source §

Parameters

`$state`	`QueryState`
`$method`	`string`
`$arguments`	`list<Domain>`	A recognized predicate, or null for a different operation.

Returns

?QueryState

Test cases 2

Called from 1

method-call SqlCatalog\Extension\Laravel\BuilderCalls::mutate() packages/sql-catalog/src/Extension/Laravel/BuilderCalls.php:232

Calls 8

function-call str_starts_with line 38
function-call substr line 39
method-call Predicates::basic() line 42
method-call Predicates::nulls() line 43
method-call Predicates::in() line 44
method-call Predicates::between() line 45
method-call Predicates::column() line 46
method-call Predicates::raw() line 47

public function add(
    QueryState $state,
    Domain $sql,
    list<Domain> $bindings,
    string $boolean = 'and',
): QueryState

source §

Parameters

`$state`	`QueryState`
`$sql`	`Domain`
`$bindings`	`list<Domain>`	Appends one predicate and the values it binds.
`$boolean`	`string`

Returns

QueryState

Test cases 1

PredicatesTest::testAddDoesNotPrefixTheFirstPredicateWithABoolean calls

Called from 11

Calls 3

method-call QueryState::items() line 57
method-call QueryState::append() line 59
static-call Domain::literal() line 59

public function groupDisjunction(QueryState $state): QueryState

source §

Groups existing disjunctions before a global scope adds its predicate.

Parameters

$state QueryState

Returns

QueryState

Test cases 1

PredicatesTest::testGroupDisjunctionPreservesConjunctionsWithoutAddingParentheses calls

Called from 1

method-call SqlCatalog\Extension\Laravel\BuilderQueries::prepare() packages/sql-catalog/src/Extension/Laravel/BuilderQueries.php:114

Calls 7

method-call QueryState::items() line 67
function-call is_string line 69
function-call str_starts_with line 69
static-call Domain::literal() line 70
method-call Grammar::join() line 70
method-call QueryState::with() line 72
static-call QueryState::list() line 72

public function basic(QueryState $state, list<Domain> $arguments, string $boolean): QueryState

source §

Parameters

`$state`	`QueryState`
`$arguments`	`list<Domain>`	A scalar comparison, including Laravel's null normalization.
`$boolean`	`string`

Returns

QueryState

Test cases 5

Called from 5

Calls 11

function-call count line 84
method-call Predicates::group() line 85
function-call is_string line 89
function-call in_array line 89
function-call strtolower line 89
method-call QueryState::reject() line 90
function-call array_slice line 93
static-call Domain::literal() line 98
method-call Predicates::nulls() line 103
method-call Predicates::comparison() line 106
method-call Predicates::add() line 111

public function comparison(list<Domain> $arguments): array{Domain, list<Domain>}|null

source §

Parameters

$arguments list<Domain>

Returns

array{Domain, list<Domain>}|null A column, operator and bound value, or null for an unmodelled form.

Test cases 1

PredicatesTest::testComparisonBindsNullLiterallyForClausesWithoutNullNormalization calls

Called from 2

Calls 9

function-call in_array line 120
function-call count line 120
static-call Domain::literal() line 123
function-call is_string line 125
function-call strtolower line 125
class-const Predicates::OPERATORS() line 125
method-call Grammar::wrap() line 128
method-call Grammar::parameter() line 128
method-call Grammar::bindings() line 130

public function group(QueryState $state, ArrayTerm $entries, string $boolean): QueryState

source §

An array of comparisons, nested in parentheses the way Laravel adds them.

Parameters

`$state`	`QueryState`
`$entries`	`ArrayTerm`
`$boolean`	`string`

Returns

QueryState

Test cases 1

PredicatesTest::testGroupNestsArrayEntriesInParenthesesWithTheOuterBoolean calls

Called from 1

method-call SqlCatalog\Extension\Laravel\Predicates::basic() packages/sql-catalog/src/Extension/Laravel/Predicates.php:85

Calls 6

method-call QueryState::reject() line 139
new QueryState line 141
method-call Predicates::entry() line 143
static-call Domain::literal() line 151
method-call Grammar::join() line 151
method-call Predicates::add() line 153

public function entry(QueryState $inner, ArrayEntry $entry, string $boolean): QueryState

source §

One entry of a where array: a column keyed value, or a positional argument list.

Parameters

`$inner`	`QueryState`
`$entry`	`ArrayEntry`
`$boolean`	`string`

Returns

QueryState

Test cases 1

PredicatesTest::testEntryReadsKeyedComparisonsAndPositionalArgumentLists calls

Called from 1

method-call SqlCatalog\Extension\Laravel\Predicates::group() packages/sql-catalog/src/Extension/Laravel/Predicates.php:143

Calls 7

method-call ArrayEntry::scalarKey() line 161
function-call is_string line 162
method-call Predicates::basic() line 163
static-call Domain::literal() line 163
function-call count line 166
method-call QueryState::reject() line 167
function-call array_merge line 170

public function nulls(
    QueryState $state,
    list<Domain> $arguments,
    string $boolean,
    bool $not,
): QueryState

source §

Parameters

`$state`	`QueryState`
`$arguments`	`list<Domain>`	NULL tests on one or several columns.
`$boolean`	`string`
`$not`	`bool`

Returns

QueryState

Test cases 2

Called from 4

Calls 6

function-call count line 178
method-call QueryState::reject() line 179
function-call array_map line 185
method-call Predicates::add() line 187
method-call Grammar::wrap() line 187
static-call Domain::literal() line 187

public function in(
    QueryState $state,
    list<Domain> $arguments,
    string $boolean,
    bool $not,
): QueryState

source §

Parameters

`$state`	`QueryState`
`$arguments`	`list<Domain>`	IN values, including the empty-set constants.
`$boolean`	`string`
`$not`	`bool`

Returns

QueryState

Test cases 2

Called from 2

Calls 12

function-call count line 198
method-call QueryState::reject() line 199
method-call Grammar::wrap() line 203
static-call Domain::literal() line 203
method-call Grammar::placeholders() line 203
method-call Predicates::add() line 205
function-call array_map line 207
function-call array_filter line 208
method-call Domain::soleArray() line 208
method-call Grammar::join() line 213
method-call Grammar::parameter() line 213
method-call Grammar::bindings() line 215

public function between(
    QueryState $state,
    list<Domain> $arguments,
    string $boolean,
    bool $not,
): QueryState

source §

Parameters

`$state`	`QueryState`
`$arguments`	`list<Domain>`	An ordered pair of bounds.
`$boolean`	`string`
`$not`	`bool`

Returns

QueryState

Test cases 1

PredicatesTest::testBetweenKeepsBothBoundsInOrder calls

Called from 1

method-call SqlCatalog\Extension\Laravel\Predicates::apply() packages/sql-catalog/src/Extension/Laravel/Predicates.php:45

Calls 10

function-call count line 223
method-call QueryState::reject() line 224
method-call Grammar::element() line 228
function-call array_slice line 229
function-call array_map line 229
method-call Grammar::wrap() line 233
static-call Domain::literal() line 233
method-call Grammar::parameter() line 234
method-call Predicates::add() line 236
method-call Grammar::bindings() line 236

public function column(QueryState $state, list<Domain> $arguments, string $boolean): QueryState

source §

Parameters

`$state`	`QueryState`
`$arguments`	`list<Domain>`	A comparison between identifiers.
`$boolean`	`string`

Returns

QueryState

Test cases 1

PredicatesTest::testColumnDoesNotTurnTheRightIdentifierIntoABinding calls

Called from 1

method-call SqlCatalog\Extension\Laravel\Predicates::apply() packages/sql-catalog/src/Extension/Laravel/Predicates.php:46

Calls 7

function-call in_array line 244
function-call count line 244
method-call QueryState::reject() line 245
static-call Domain::literal() line 247
function-call is_string line 249
method-call Predicates::add() line 253
method-call Grammar::wrap() line 253

public function raw(QueryState $state, list<Domain> $arguments, string $boolean): QueryState

source §

Parameters

`$state`	`QueryState`
`$arguments`	`list<Domain>`	Explicit SQL with its bindings, one per placeholder when the array is unknown.
`$boolean`	`string`

Returns

QueryState

Test cases 1

PredicatesTest::testRawKeepsBindingsAndLeavesIncompleteArraysOpen calls

Called from 1

method-call SqlCatalog\Extension\Laravel\Predicates::apply() packages/sql-catalog/src/Extension/Laravel/Predicates.php:47

Calls 6

function-call in_array line 261
function-call count line 261
method-call Grammar::rawBindings() line 261
static-call QueryState::list() line 261
method-call QueryState::reject() line 263
method-call Predicates::add() line 266

Private surface 2§

Implementation details, listed for orientation only.

private const OPERATORS = ['=', '<', '>', '<=', '>=', '<>', '!=', 'like', 'not like']

private Grammar $grammar

Test cases 23§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 16

Other tests reaching this symbol 7

Relations§

Instantiated in 8

Method calls 11