classInterpreter

packages/sql-catalog/src/Core/Analysis/Interpreter.php:54

final class Interpreter

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

Reads the statements a source tree can issue, starting from every call that issues one.

Every call written the way a database call is written is a starting point. What it is called on is worked out first, which decides whether it is a database call at all; then what its arguments can be is worked out from the call backwards. Each way the arguments can be is one statement at the call, and a value bound later, by an execute() or a bindValue(), is attached to the statement the handle it is called on came from.

Methods§

public function __construct(
    ProgramIndex $index,
    list<SinkSpec> $sinks,
    EvaluationBudget|null $budget = null,
    DeclaredGlobals|null $globals = null,
    Registry|null $functions = null,
    private ?string $dialect = null,
    private list<ModelProviderInterface> $modelProviders = [],
)

source §

Parameters

`$index`	`ProgramIndex`	The declarations of the whole analyzed source tree
`$sinks`	`list<SinkSpec>`	The database calls the enabled extensions recognise
`$budget`	`EvaluationBudget\|null`	How much work one call may cost
`$globals`	`DeclaredGlobals\|null`	What the global variables the source declares are known to hold
`$functions`	`Registry\|null`	The function interpretations shared by the derivation
`$dialect`	`?string`
`$modelProviders`	`list<ModelProviderInterface>`	Enabled extension providers, instantiated for each derivation engine

Calls 5

static-call Registry::withBuiltins() line 92
new EvaluationBudget line 95
new DeclaredGlobals line 96
new NodeText line 97
new SinkFinder line 98

public function analyze(list<ParsedFile> $files): list<QueryRecord>

source §

Every statement the files can issue.

Parameters

$files list<ParsedFile>

Returns

list<QueryRecord>

Test cases 28

Called from 1

method-call SqlCatalog\Facade\Analyzer::entriesOf() packages/sql-catalog/src/Facade/Analyzer.php:169

Calls 13

method-call Interpreter::deriverFor() line 109
new SinkMatcher line 110
new StatementRecorder line 111
new ValueBinder line 112
method-call SinkFinder::findAll() line 115
method-call EvaluationBudget::reset() line 116
function-call array_merge line 117
method-call Interpreter::visit() line 117
function-call array_shift line 122
static-call Domain::unknown() line 122
method-call ValueBinder::bindValues() line 123
method-call ValueBinder::openRecords() line 123
method-call StatementRecorder::records() line 126

public function evaluatorFor(list<ParsedFile> $files = []): ExpressionEvaluator

source §

The expression evaluator the deriver for the given files reads values with.

Parameters

$files list<ParsedFile>

Returns

ExpressionEvaluator

Test cases 159

Calls 1

method-call Interpreter::deriverFor() line 136

public function deriverFor(list<ParsedFile> $files): Deriver

source §

The deriver wired over the given files.

Parameters

$files list<ParsedFile>

Returns

Deriver

Test cases 114

Called from 2

Calls 20

public function visit(
    CallLike $call,
    Deriver $deriver,
    SinkMatcher $matcher,
    StatementRecorder $recorder,
    ValueBinder $binder,
): list<array{SinkSpec, Solution}>

source §

Records what one call issues, and hands back the values it binds for later.

Parameters

`$call`	`CallLike`
`$deriver`	`Deriver`
`$matcher`	`SinkMatcher`
`$recorder`	`StatementRecorder`
`$binder`	`ValueBinder`

Returns

list<array{SinkSpec, Solution}>

Test cases 5

Called from 1

method-call SqlCatalog\Core\Analysis\Interpreter::analyze() packages/sql-catalog/src/Core/Analysis/Interpreter.php:117

Calls 16

method-call Deriver::scopeOf() line 205
method-call Interpreter::sinkOf() line 206
method-call Interpreter::unidentified() line 208
method-call Interpreter::recordUnmatched() line 209
class-const SinkRole::Compose() line 214
method-call EvaluationBudget::reset() line 217
method-call Interpreter::argumentsOf() line 218
class-const SinkRole::Modelled() line 219
method-call Interpreter::recordStatements() line 220
method-call ModelQueries::solve() line 220
new ModelQueries line 220
class-const SinkRole::Execute() line 224
class-const SinkRole::Bind() line 224
function-call array_map line 230
method-call Deriver::solve() line 232
function-call array_merge line 232

public function sinkOf(
    CallLike $call,
    Deriver $deriver,
    SinkMatcher $matcher,
    FunctionScope $scope,
): ?SinkSpec

source §

The database call a call is, or null when it is not one the enabled extensions recognise.

Parameters

`$call`	`CallLike`
`$deriver`	`Deriver`
`$matcher`	`SinkMatcher`
`$scope`	`FunctionScope`

Returns

?SinkSpec

Test cases 3

Called from 1

method-call SqlCatalog\Core\Analysis\Interpreter::visit() packages/sql-catalog/src/Core/Analysis/Interpreter.php:206

Calls 7

method-call SinkFinder::nameOf() line 248
method-call SinkMatcher::matchFunction() line 253
function-call in_array line 257
function-call strtolower line 257
method-call SinkMatcher::matchStatic() line 261
method-call SinkMatcher::matchMethod() line 264
method-call Interpreter::receiverOf() line 264

public function receiverOf(MethodCall|NullsafeMethodCall $call, Deriver $deriver): Domain

source §

Everything the receiver of a method call can be.

Parameters

`$call`	`MethodCall\|NullsafeMethodCall`
`$deriver`	`Deriver`

Returns

Domain

Test cases 2

Called from 2

Calls 2

method-call Deriver::solve() line 276
static-call Domain::unknown() line 280

public function unidentified(CallLike $call, Deriver $deriver, SinkMatcher $matcher): bool

source §

Whether a call that carries statement text could not be told apart from a database call.

A call on something whose class is known, and is not a database class, is simply not a database call. A call on something whose class could not be worked out might be one, and that is a gap worth reporting.

Parameters

`$call`	`CallLike`
`$deriver`	`Deriver`
`$matcher`	`SinkMatcher`

Returns

bool

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\Interpreter::visit() packages/sql-catalog/src/Core/Analysis/Interpreter.php:208

Calls 7

method-call SinkFinder::nameOf() line 295
method-call SinkMatcher::byName() line 297
class-const SinkCallKind::Method() line 297
class-const SinkRole::Query() line 298
class-const SinkRole::Prepare() line 298
class-const SinkRole::Modelled() line 298
method-call Interpreter::receiverOf() line 301

public function argumentsOf(CallLike $call): list<Expr>

source §

The expressions a call passes, in the order they are written.

Parameters

$call CallLike

Returns

list<Expr>

Test cases 1

InterpreterTest::testArgumentsOfListsTheExpressionsACallPasses calls

Called from 1

method-call SqlCatalog\Core\Analysis\Interpreter::visit() packages/sql-catalog/src/Core/Analysis/Interpreter.php:218

Calls 4

method-call CallLike::isFirstClassCallable() line 311
function-call array_values line 315
function-call array_map line 315
method-call CallLike::getArgs() line 315

public function recordStatements(
    CallLike $call,
    SinkSpec $sink,
    list<Solution> $solutions,
    FunctionScope $scope,
    StatementRecorder $recorder,
    ValueBinder $binder,
): void

source §

Records one statement for every way the call's statement text can be.

Parameters

`$call`	`CallLike`
`$sink`	`SinkSpec`
`$solutions`	`list<Solution>`
`$scope`	`FunctionScope`
`$recorder`	`StatementRecorder`
`$binder`	`ValueBinder`

Test cases 4

Called from 2

Calls 9

new CallSite line 331
method-call CallLike::getStartLine() line 331
method-call CallLike::getStartFilePos() line 332
method-call StatementRecorder::record() line 341
method-call ValueBinder::bindValues() line 343
function-call array_merge line 344
method-call Interpreter::unread() line 347
class-const SinkRole::Prepare() line 349
method-call StatementRecorder::filePrepared() line 350

public function recordUnmatched(
    CallLike $call,
    FunctionScope $scope,
    StatementRecorder $recorder,
): void

source §

Records a call written as a database call on something that could not be identified.

Parameters

`$call`	`CallLike`
`$scope`	`FunctionScope`
`$recorder`	`StatementRecorder`

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\Interpreter::visit() packages/sql-catalog/src/Core/Analysis/Interpreter.php:209

Calls 6

method-call StatementRecorder::record() line 359
new CallSite line 360
method-call CallLike::getStartLine() line 360
class-const CallSite::UNMATCHED() line 360
method-call CallLike::getStartFilePos() line 361
method-call Interpreter::unread() line 362

public function unread(CallLike $call): TextPattern

source §

The statement of a call nothing was read from: one gap, quoting the call.

Parameters

$call CallLike

Returns

TextPattern

Test cases 1

InterpreterTest::testUnreadQuotesTheCallInItsOnlyGap calls

Called from 2

Calls 5

static-call TextPattern::fromHole() line 371
new TextHole line 371
class-const Origin::Unreached() line 371
static-call TypeShape::unknown() line 371
method-call NodeText::render() line 371

Private surface 10§

Implementation details, listed for orientation only.

private Registry $functions

private ProgramIndex $index

private list<SinkSpec> $sinks

private EvaluationBudget $budget

private DeclaredGlobals $globals

private NodeText $text

private SinkFinder $finder

private ?ModelSet $models = null

private ?string $dialect = null

private list<ModelProviderInterface> $modelProviders = []

Test cases 314§

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

Dedicated tests 31

Other tests reaching this symbol 283

Relations§

Instantiated in 1

new SqlCatalog\Facade\Analyzer::entriesOf() packages/sql-catalog/src/Facade/Analyzer.php:159

Method calls 1

method-call SqlCatalog\Facade\Analyzer::entriesOf() packages/sql-catalog/src/Facade/Analyzer.php:169