Skip to content

classEntryBinder

packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:37

final class EntryBinder

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

Binds what a path still needs when it reaches the start of its body.

A parameter is bound to what each call of the body passes for it, which is worked out at the call the same way the statement was worked out at the database call. A property of $this is bound to each value the class can leave it holding. A name read at the top of a file is bound to what an extension says it holds. Whatever cannot be bound this way is left open, and says why: nothing calls the body, the budget ran out, or the name is simply not defined anywhere the analysis can see.

Methods§

public function __construct(
    Callers $callers,
    ExpressionEvaluator $expressions,
    EvaluationBudget $budget,
    ?DeclaredGlobals $globals = null,
    ?PropertyWrites $properties = null,
)

Wires the binder to what it looks for callers and property values with.

Parameters

`$callers`	`Callers`
`$expressions`	`ExpressionEvaluator`
`$budget`	`EvaluationBudget`
`$globals`	`?DeclaredGlobals`
`$properties`	`?PropertyWrites`

Calls 2

new DeclaredGlobals line 64
new TypeReader line 66

public function affordable(list<Binding> $bindings, int $limit): list<Binding>

The ways in, with those beyond what the budget can run one at a time joined into one.

Every way in runs the whole path, so a long path with many ways in costs their product. The ways the budget cannot pay for are joined value by value into a single way in: every value is still there, and the result says that its values were paired without knowing they go together.

Parameters

`$bindings`	`list<Binding>`
`$limit`	`int`

Returns

list<Binding>

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\Deriver::run() packages/sql-catalog/src/Core/Analysis/Derivation/Deriver.php:166

Calls 5

function-call count line 82
function-call array_slice line 85
function-call max line 85
new Binding line 94
new Environment line 94

public function bindings(Arrival $arrival, int $depth, Deriver $deriver): list<Binding>

The ways into the body a path arrived at the start of, each binding what the path still needs.

Parameters

`$arrival`	`Arrival`
`$depth`	`int`
`$deriver`	`Deriver`

Returns

list<Binding>

Test cases 1

EntryBinderTest::testBindingsLeaveThePropertiesAloneWithoutAReaderOfPropertyWrites calls

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\Deriver::run() packages/sql-catalog/src/Core/Analysis/Derivation/Deriver.php:166

Calls 8

method-call EntryBinder::parameterBindings() line 106
method-call Deriver::classOf() line 107
function-call str_starts_with line 113
class-const FreeNames::THIS() line 113
function-call substr line 114
function-call strlen line 114
function-call count line 115
method-call EntryBinder::withProperty() line 116

public function withProperty(
    list<Binding> $bindings,
    string $name,
    list<Domain> $values,
    bool $combined = false,
): list<Binding>

The ways in, one for each value a property can hold on each of them.

Properties are worked out one at a time, so once more than one of them can hold several values, the pairings are not known to occur together and the ways in say so.

Parameters

`$bindings`	`list<Binding>`
`$name`	`string`
`$values`	`list<Domain>`
`$combined`	`bool`

Returns

list<Binding>

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::bindings() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:116

Calls 5

new Binding line 144
function-call count line 147
class-const Deriver::MAX_SOLUTIONS() line 147
function-call array_map line 151
function-call array_slice line 153

public function parameterValues(
    FunctionLike $body,
    string $name,
    int $depth,
    Deriver $deriver,
): list<Domain>

What a parameter of a body can be, for every way into the body.

Parameters

`$body`	`FunctionLike`
`$name`	`string`
`$depth`	`int`
`$deriver`	`Deriver`

Returns

list<Domain>

Calls 3

method-call EntryBinder::parameterBindings() line 165
new Arrival line 165
static-call Pending::needing() line 165

public function evaluateConstant(Expr $expression, ?string $className): Domain

The value of an expression that reads nothing but constants, such as a property default.

Parameters

`$expression`	`Expr`
`$className`	`?string`

Returns

Domain

Calls 4

method-call ExpressionEvaluator::evaluate() line 177
new Environment line 177
new FunctionScope line 177
class-const FunctionScope::MAIN() line 177

public function parameterBindings(Arrival $arrival, int $depth, Deriver $deriver): list<Binding>

The ways into the body, each binding the parameters and other names the path still needs.

A local with no reaching definition starts absent. Reading it yields null; its existence remains separate from the values assigned later. Parameters, declared globals and exhausted paths keep their open values.

Parameters

`$arrival`	`Arrival`
`$depth`	`int`
`$deriver`	`Deriver`

Returns

list<Binding>

Called from 2

Calls 18

class-const FunctionScope::MAIN() line 192
method-call Deriver::nameOf() line 192
new Binding line 195
method-call EntryBinder::leaveOpen() line 195
class-const Origin::Budget() line 195
method-call EntryBinder::fileScope() line 198
method-call EntryBinder::parametersOf() line 201
new Environment line 202
function-call array_diff_key line 203
class-const FreeNames::THIS() line 204
function-call str_starts_with line 204
method-call Environment::markAbsent() line 205
method-call EvaluationBudget::isExhausted() line 211
method-call EntryBinder::withParameters() line 212
method-call Callers::of() line 214
method-call EntryBinder::openOrigin() line 216
class-const Origin::Parameter() line 216
method-call EntryBinder::fromCallers() line 221

public function fromCallers(
    CallerSet $callers,
    array<string, array{int, Param}> $parameters,
    Environment $outside,
    string $name,
    int $depth,
    Deriver $deriver,
): list<Binding>

One way in for every way each call can pass the arguments the path needs.

When not every caller could be asked — there are more than the limit, the budget ran out partway, or a call might reach the body without that being certain — every way in found is marked as cut short, not only the ones found after the search stopped: the set as a whole is what is incomplete.

Parameters

`$callers`	`CallerSet`
`$parameters`	`array<string, array{int, Param}>`
`$outside`	`Environment`
`$name`	`string`
`$depth`	`int`
`$deriver`	`Deriver`

Returns

list<Binding>

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::parameterBindings() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:221

Calls 13

function-call count line 241
class-const Deriver::MAX_CALLERS() line 241
function-call array_slice line 243
method-call EvaluationBudget::isExhausted() line 244
method-call EntryBinder::argumentsFor() line 248
function-call array_values line 249
function-call array_filter line 249
method-call Deriver::solve() line 250
method-call Environment::copy() line 251
method-call EntryBinder::defaultOf() line 255
function-call array_map line 262
new Binding line 263
function-call array_merge line 265

public function argumentsFor(
    CallLike $call,
    array<string, array{int, Param}> $parameters,
): array<string, Expr|null>

The argument a call passes for each needed parameter, or null where it passes none.

Parameters

`$call`	`CallLike`
`$parameters`	`array<string, array{int, Param}>`

Returns

array<string, Expr|null>

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::fromCallers() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:248

Calls 2

method-call CallLike::isFirstClassCallable() line 282
method-call CallLike::getArgs() line 282

public function defaultOf(Param $parameter): Domain

What a parameter holds when a call does not pass it.

Parameters

$parameter Param

Returns

Domain

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::fromCallers() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:255

Calls 7

function-call is_string line 301
method-call ExpressionEvaluator::evaluate() line 303
new Environment line 303
new FunctionScope line 303
static-call Domain::opaque() line 306
method-call TypeReader::read() line 306
class-const Origin::Parameter() line 306

public function openOrigin(): Origin

Why a parameter no caller could be asked about is left open: the budget, or there being no caller.

Returns

Origin

Called from 2

Calls 3

method-call EvaluationBudget::isExhausted() line 314
class-const Origin::Budget() line 314
class-const Origin::Parameter() line 314

public function parametersOf(
    FunctionLike $body,
    array<string, true> $needs,
): array<string, array{int, Param}>

The parameters of a body among the names a path needs, with their positions.

Parameters

`$body`	`FunctionLike`
`$needs`	`array<string, true>`

Returns

array<string, array{int, Param}>

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::parameterBindings() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:201

Calls 2

method-call FunctionLike::getParams() line 326
function-call is_string line 327

public function withParameters(
    Environment $environment,
    array<string, array{int, Param}> $parameters,
    Origin $origin,
): Environment

The environment with every needed parameter left open, for the given reason.

Parameters

`$environment`	`Environment`
`$parameters`	`array<string, array{int, Param}>`
`$origin`	`Origin`

Returns

Environment

Called from 3

Calls 3

method-call Environment::copy() line 343
static-call Domain::opaque() line 345
method-call TypeReader::read() line 345

public function leaveOpen(array<string, true> $needs, Origin $origin): Environment

Every needed name left open, for the given reason.

Parameters

`$needs`	`array<string, true>`
`$origin`	`Origin`

Returns

Environment

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::parameterBindings() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:195

Calls 4

new Environment line 358
method-call Environment::write() line 360
static-call Domain::opaque() line 360
static-call TypeShape::unknown() line 360

public function fileScope(array<string, true> $needs): Environment

What the names code at the top of a file reads without defining are known to hold.

Such code runs in the global scope, so a name it reads was set by whatever ran before it. An extension may say what that is; otherwise it is left open.

Parameters

$needs array<string, true>

Returns

Environment

Test cases 1

EntryBinderTest::testFileScopeBindsTheGlobalsAnExtensionDeclares calls

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\EntryBinder::parameterBindings() packages/sql-catalog/src/Core/Analysis/Derivation/EntryBinder.php:198

Calls 8

new Environment line 377
method-call DeclaredGlobals::declared() line 379
method-call Environment::write() line 380
static-call Domain::of() line 381
new ObjectTerm line 381
static-call Domain::opaque() line 382
static-call TypeShape::unknown() line 382
class-const Origin::Unresolved() line 382

Private surface 6§

Implementation details, listed for orientation only.

private Callers $callers

private ExpressionEvaluator $expressions

private EvaluationBudget $budget

private DeclaredGlobals $globals

private ?PropertyWrites $properties

private TypeReader $types

Test cases 28§

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

Dedicated tests 2

Other tests reaching this symbol 26

CatalogCommandTest calls
CallEvaluatorTest calls
ConstantReaderTest calls
CalleeReturnsTest calls
CallersTest calls
DeriverTest::testBinderIsTheEntryBinderTheDeriverWasWiredWith calls
DeriverTest::testEvaluatorIsTheEvaluatorTheDeriverWasWiredWith calls
DeriverTest::testSolveReadsWhatTheGoalsNeedWithTheNamesItWasGiven calls
CallbackEffectsTest calls
PropertyWritesTest::testValuesOfCollectsWhatEveryWriterLeaves calls
PropertyWritesTest::testValuesOfSkipsTheWritersOnceTheBudgetIsSpent calls
SliceExecutorTest calls
ExpressionEvaluatorTest calls
RegistryTest calls
InterpreterTest calls
ModelQueriesTest calls
ReferenceEvaluatorTest calls
CallContextTest calls
QueryModelInterfaceTest calls
BuilderCallsTest calls
BuilderQueriesTest calls
CallbackModelTest calls
CallModelTest calls
AnalyzerTest calls
JsonReporterTest calls
TextReporterTest calls

Relations§

Instantiated in 1

new SqlCatalog\Core\Analysis\Interpreter::deriverFor() packages/sql-catalog/src/Core/Analysis/Interpreter.php:181

Method calls 2

Type declarations 3