classWriteCompiler

packages/sql-catalog/src/Extension/Laravel/WriteCompiler.php:15

final class WriteCompiler

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

Compiles literal-shaped writes while preserving their value domains.

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 6

Called from 1

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

Calls 16

method-call QueryState::items() line 30
method-call QueryState::get() line 30
method-call WriteCompiler::unknown() line 31
function-call count line 33
method-call Predicates::basic() line 34
new Predicates line 34
static-call Domain::literal() line 34
static-call Domain::unknown() line 36
method-call Grammar::wrap() line 37
method-call WriteCompiler::where() line 37
static-call QueryState::list() line 37
function-call in_array line 39
method-call WriteCompiler::step() line 40
method-call WriteCompiler::update() line 47
method-call WriteCompiler::insert() line 50
method-call WriteCompiler::insertGetId() line 53

public function update(QueryState $state, ArrayTerm $values): array{Domain, Domain}

source §

Parameters

`$state`	`QueryState`
`$values`	`ArrayTerm`

Returns

array{Domain, Domain} Update assignments followed by WHERE bindings.

Test cases 1

WriteCompilerTest::testUpdateOrdersAssignmentsBeforePredicateBindings calls

Called from 2

Calls 14

method-call ArrayTerm::named() line 64
function-call count line 64
method-call WriteCompiler::unknown() line 65
method-call Grammar::wrap() line 72
static-call Domain::literal() line 72
method-call Grammar::parameter() line 72
method-call QueryState::get() line 74
method-call Grammar::join() line 75
method-call WriteCompiler::where() line 75
static-call QueryState::list() line 77
function-call array_merge line 77
method-call Grammar::bindings() line 77
function-call array_values line 77
method-call QueryState::items() line 77

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

source §

Parameters

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

Returns

array{Domain, Domain} An increment or decrement written as Laravel's raw arithmetic update.

Test cases 1

WriteCompilerTest::testStepWritesLaravelsRawArithmeticBeforeExtraColumns calls

Called from 1

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

Calls 17

static-call Domain::unknown() line 86
static-call Domain::literal() line 87
static-call QueryState::list() line 88
function-call is_string line 89
function-call count line 89
method-call WriteCompiler::unknown() line 90
function-call is_numeric line 93
method-call Grammar::wrapName() line 94
new ObjectTerm line 95
class-const Grammar::EXPRESSION() line 95
method-call QueryState::array() line 95
new QueryState line 95
new ArrayTerm line 96
function-call array_merge line 96
new ArrayEntry line 96
static-call Domain::of() line 96
method-call WriteCompiler::update() line 98

public function insert(
    QueryState $state,
    ArrayTerm $values,
    bool $ignore,
): array{Domain, Domain}

source §

Parameters

`$state`	`QueryState`
`$values`	`ArrayTerm`
`$ignore`	`bool`

Returns

array{Domain, Domain} Inserts one or more complete rows.

Test cases 5

Called from 2

Calls 13

method-call WriteCompiler::rows() line 106
method-call WriteCompiler::unknown() line 108
function-call array_keys line 110
function-call array_values line 117
static-call Domain::literal() line 118
method-call Grammar::join() line 118
function-call array_map line 118
method-call Grammar::parameter() line 118
function-call array_merge line 119
method-call Grammar::bindings() line 119
method-call Grammar::wrap() line 122
method-call QueryState::get() line 122
static-call QueryState::list() line 127

public function insertGetId(
    QueryState $state,
    ArrayTerm $values,
    Domain $sequence,
): array{Domain, Domain}

source §

Parameters

`$state`	`QueryState`
`$values`	`ArrayTerm`
`$sequence`	`Domain`

Returns

array{Domain, Domain} A single-row insert whose generated key the grammar may have to return.

Test cases 2

Called from 1

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

Calls 7

method-call ArrayTerm::named() line 135
function-call count line 135
method-call WriteCompiler::unknown() line 136
method-call WriteCompiler::insert() line 138
method-call Domain::soleLiteral() line 143
static-call Domain::literal() line 145
method-call Grammar::wrap() line 145

public function rows(ArrayTerm $values): list<array<string, Domain>>

source §

Parameters

$values ArrayTerm

Returns

list<array<string, Domain>> Single rows retain order; bulk rows sort their keys.

Test cases 1

WriteCompilerTest::testRowsSortsBulkKeysAndRejectsIncompleteRows calls

Called from 1

method-call SqlCatalog\Extension\Laravel\WriteCompiler::insert() packages/sql-catalog/src/Extension/Laravel/WriteCompiler.php:106

Calls 4

method-call ArrayTerm::named() line 153
function-call count line 154
method-call ArrayTerm::positional() line 157
function-call ksort line 163

public function where(QueryState $state): Domain

source §

The shared WHERE clause of an update or delete.

Parameters

$state QueryState

Returns

Domain

Test cases 1

WriteCompilerTest::testWhereDoesNotInventAnEmptyPredicate calls

Called from 2

Calls 3

method-call QueryState::items() line 175
static-call Domain::literal() line 175
method-call Grammar::join() line 175

public function unknown(string $reason): array{Domain, Domain}

source §

Parameters

$reason string

Returns

array{Domain, Domain} A visible gap, never a fabricated exact write.

Test cases 1

WriteCompilerTest::testUnknownProducesAnIncompleteSqlDomain calls

Called from 9

Calls 3

method-call QueryState::reject() line 183
new QueryState line 183
static-call Domain::unknown() line 183

Private surface 1§

Implementation details, listed for orientation only.

private Grammar $grammar

Test cases 18§

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

Dedicated tests 13

Other tests reaching this symbol 5

DialectTest::testInsertPrefixComesFromThePolicy calls
DialectTest::testInsertSuffixComesFromThePolicy calls
DialectTest::testReturningSuffixComesFromThePolicy calls
BuilderQueriesTest calls
AnalyzerTest calls

Relations§

Instantiated in 1

new SqlCatalog\Extension\Laravel\BuilderQueries::dispatch() packages/sql-catalog/src/Extension/Laravel/BuilderQueries.php:138

Method calls 1

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