classSelectCompiler

packages/sql-catalog/src/Extension/Laravel/SelectCompiler.php:16

final class SelectCompiler

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

Compiles a read after all query mutations have run.

Constants§

public const READS = ['get', 'all', 'first', 'firstorfail', 'find', 'findorfail', 'sole', 'value', '…

source §

The execution calls this compiler reads as one SELECT.

Methods§

public function __construct(private Grammar $grammar)

source §

Uses the configured framework SQL grammar.

Parameters

$grammar Grammar

public function compile(
    QueryState $state,
    string $method,
    list<Domain> $arguments,
): array{Domain, Domain}

source §

Parameters

`$state`	`QueryState`
`$method`	`string`
`$arguments`	`list<Domain>`

Returns

array{Domain, Domain} SQL and ordered bindings.

Test cases 5

Called from 1

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

Calls 13

function-call in_array line 36
static-call Domain::literal() line 37
method-call SelectCompiler::key() line 43
static-call Domain::unknown() line 43
function-call array_slice line 44
method-call SelectCompiler::page() line 47
method-call SelectCompiler::aggregate() line 51
static-call QueryState::list() line 54
method-call Clauses::select() line 55
new Clauses line 55
function-call count line 57
method-call SelectCompiler::select() line 60
method-call Grammar::wrap() line 62

public function key(QueryState $state, Domain $id): QueryState

source §

The primary key predicate of a find: one row for a scalar, a list for an array.

Parameters

`$state`	`QueryState`
`$id`	`Domain`

Returns

QueryState

Test cases 1

SelectCompilerTest::testKeyComparesScalarsAndListsAgainstThePrimaryKey calls

Called from 2

Calls 12

new Predicates line 73
method-call Domain::soleArray() line 74
method-call Domain::type() line 74
method-call QueryState::string() line 75
method-call Predicates::basic() line 76
method-call QueryState::get() line 76
static-call Domain::literal() line 76
function-call in_array line 79
method-call Predicates::in() line 80
method-call Predicates::add() line 88
method-call Grammar::wrap() line 91
method-call Grammar::join() line 91

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

source §

Parameters

`$state`	`QueryState`
`$method`	`string`
`$arguments`	`list<Domain>`	The page window of a chunked or paginated read; the page itself comes from the request or the loop.

Returns

QueryState

Test cases 1

SelectCompilerTest::testPageWindowsChunksByTheLoopAndPagesByTheRequest calls

Called from 1

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

Calls 9

function-call in_array line 99
static-call Domain::literal() line 100
function-call is_int line 107
method-call Clauses::number() line 110
new Clauses line 110
static-call Domain::opaque() line 112
static-call TypeShape::of() line 112
class-const Origin::Loop() line 112
class-const Origin::External() line 112

public function select(QueryState $state): array{Domain, Domain}

source §

Parameters

$state QueryState

Returns

array{Domain, Domain} A SELECT with component-ordered bindings.

Test cases 3

Called from 3

Calls 8

static-call Domain::literal() line 120
method-call QueryState::get() line 120
method-call Grammar::join() line 121
method-call QueryState::items() line 121
method-call Grammar::wrap() line 121
function-call in_array line 124
function-call array_merge line 136
static-call QueryState::list() line 142

public function aggregate(
    QueryState $state,
    string $method,
    list<Domain> $arguments,
): array{Domain, Domain}

source §

Parameters

`$state`	`QueryState`
`$method`	`string`
`$arguments`	`list<Domain>`

Returns

array{Domain, Domain} An aggregate with Laravel's projection reset.

Test cases 2

Called from 2

Calls 6

function-call count line 151
method-call QueryState::items() line 151
static-call Domain::literal() line 154
method-call Grammar::wrap() line 156
static-call QueryState::list() line 157
method-call SelectCompiler::select() line 162

public function total(QueryState $state): array{Domain, Domain}

source §

Parameters

$state QueryState

Returns

array{Domain, Domain} The row count Laravel reads before a page, without the page's ordering and window.

Test cases 1

SelectCompilerTest::testTotalCountsWithoutTheWindowOrOrdering calls

Called from 1

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

Calls 7

static-call Domain::literal() line 170
static-call QueryState::list() line 170
method-call SelectCompiler::aggregate() line 172
method-call Clauses::select() line 175
new Clauses line 175
method-call SelectCompiler::select() line 177
method-call Grammar::wrap() line 178

Private surface 1§

Implementation details, listed for orientation only.

private Grammar $grammar

Test cases 15§

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

Dedicated tests 11

Other tests reaching this symbol 4

Relations§

Instantiated in 3

Method calls 3

Constant reads 2