classGrammar

packages/sql-catalog/src/Extension/Laravel/Grammar.php:20

final class Grammar

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

Laravel identifier wrapping and ordered SQL fragments for the selected grammar.

Constants§

public const EXPRESSION = 'Illuminate\Database\Query\Expression'

source §

The framework class of a raw expression.

Properties§

public ?Dialect $dialect

source §

Methods§

public function __construct(public ?Dialect $dialect)

source §

Uses the configured framework SQL grammar.

Parameters

$dialect ?Dialect

public function wrap(Domain $value): Domain

source §

Wraps an identifier; expressions already represent SQL and unresolved names stay open where they are.

Parameters

$value Domain

Returns

Domain

Test cases 5

Called from 23

Calls 11

method-call Domain::soleObject() line 39
class-const Grammar::EXPRESSION() line 40
static-call QueryState::from() line 41
static-call Domain::opaque() line 44
static-call TypeShape::of() line 44
class-const Origin::Call() line 44
function-call array_merge line 49
function-call is_string line 49
method-call Grammar::wrapName() line 49
method-call Grammar::opened() line 49
static-call Domain::fromTerms() line 52

public function wrapName(string $name): Domain

source §

A resolved identifier written with the grammar's delimiters, aliases and qualifiers.

Parameters

$name string

Returns

Domain

Test cases 1

GrammarTest::testWrapNameQuotesQualifiedNamesAndLeavesJsonSelectorsOpen calls

Called from 3

Calls 12

static-call Domain::opaque() line 61
static-call TypeShape::of() line 61
class-const Origin::Call() line 61
function-call str_contains line 63
function-call preg_split line 67
function-call count line 68
method-call Grammar::wrapName() line 69
static-call Domain::literal() line 69
function-call str_replace line 69
function-call array_map line 71
function-call explode line 71
function-call implode line 73

public function opened(Term $term): Domain

source §

The gap an unresolved identifier leaves, keeping where the value came from.

Parameters

$term Term

Returns

Domain

Test cases 1

GrammarTest::testOpenedKeepsNonLiteralTermsAndRejectsNonStringLiterals calls

Called from 1

method-call SqlCatalog\Extension\Laravel\Grammar::wrap() packages/sql-catalog/src/Extension/Laravel/Grammar.php:49

Calls 4

public function join(list<Domain> $parts, string $separator = ', '): Domain

source §

Parameters

`$parts`	`list<Domain>`	Joins fragments without discarding holes or alternatives.
`$separator`	`string`

Returns

Domain

Test cases 1

GrammarTest::testJoinPreservesOrderAndGaps calls

Called from 12

Calls 1

static-call Domain::literal() line 93

public function parameter(Domain $value): Domain

source §

A raw expression, or the marker for a bound value.

Parameters

$value Domain

Returns

Domain

Test cases 1

GrammarTest::testParameterOnlySplicesExplicitExpressions calls

Called from 5

Calls 4

method-call Domain::soleObject() line 106
class-const Grammar::EXPRESSION() line 108
static-call QueryState::from() line 108
static-call Domain::literal() line 108

public function bindings(list<Domain> $values): list<Domain>

source §

Parameters

$values list<Domain>

Returns

list<Domain> Values that occupy actual placeholders.

Test cases 1

GrammarTest::testBindingsExcludeExpressionsWithoutChangingValueOrder calls

Called from 5

Calls 4

function-call array_values line 117
function-call array_filter line 117
method-call Domain::soleObject() line 117
class-const Grammar::EXPRESSION() line 117

public function placeholders(Domain $values): Domain

source §

The gap a placeholder list of unknown length leaves, keeping where the values came from.

Parameters

$values Domain

Returns

Domain

Test cases 1

GrammarTest::testPlaceholdersStandForAListOfUnknownLengthFromTheSameOrigin calls

Called from 1

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

Calls 7

function-call count line 125
static-call Domain::of() line 127
new OpaqueTerm line 127
static-call TypeShape::of() line 127
static-call Domain::opaque() line 130
class-const Origin::Branch() line 130
class-const Origin::Unresolved() line 130

public function element(Domain $values): Domain

source §

One element of a list whose contents are unknown, keeping where the list came from.

Parameters

$values Domain

Returns

Domain

Test cases 1

GrammarTest::testElementIsOneUnknownValueFromTheListsOrigin calls

Called from 2

Calls 5

function-call count line 138
static-call Domain::of() line 140
new OpaqueTerm line 140
static-call TypeShape::unknown() line 140
static-call Domain::unknown() line 143

public function rawBindings(Domain $sql, Domain $values): list<Domain>|null

source §

Parameters

`$sql`	`Domain`
`$values`	`Domain`

Returns

list<Domain>|null The values a raw fragment binds, one per placeholder when the array is unknown.

Test cases 1

GrammarTest::testRawBindingsCountPlaceholdersWhenTheArrayIsUnknown calls

Called from 2

Calls 8

method-call Domain::soleArray() line 151
function-call array_map line 153
method-call Domain::soleLiteral() line 155
function-call is_string line 156
method-call Domain::soleObject() line 156
function-call array_fill line 160
function-call substr_count line 160
method-call Grammar::element() line 160

Test cases 72§

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 61

Relations§

Instantiated in 7

Method calls 50

Constant reads 1

class-const SqlCatalog\Extension\Laravel\WriteCompiler::step() packages/sql-catalog/src/Extension/Laravel/WriteCompiler.php:95

Type declarations 5