classReferenceEvaluator

packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:25

final class ReferenceEvaluator

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

Reads the value behind a name: a variable, a property, a constant or an element.

Methods§

public function __construct(ProgramIndex $index, ExternalInput $external, NodeText $text)

source §

Wires the reader to the declarations it resolves names against.

Parameters

`$index`	`ProgramIndex`
`$external`	`ExternalInput`
`$text`	`NodeText`

Calls 1

new ConstantReader line 45

public function evaluate(
    Expr $node,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): ?Domain

source §

The value behind the reference, or null when the expression is not one.

Parameters

`$node`	`Expr`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Returns

?Domain

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\ExpressionEvaluator::evaluate() packages/sql-catalog/src/Core/Analysis/ExpressionEvaluator.php:79

Calls 9

method-call ReferenceEvaluator::readVariable() line 58
method-call ReferenceEvaluator::readArray() line 61
method-call ReferenceEvaluator::readElement() line 64
method-call ConstantReader::readConstant() line 67
method-call ConstantReader::readClassConstant() line 70
method-call ReferenceEvaluator::readProperty() line 74
method-call ReferenceEvaluator::readInstance() line 77
static-call Domain::of() line 80
new ObjectTerm line 80

public function readVariable(
    Variable $node,
    Environment $environment,
    FunctionScope $scope,
): Domain

source §

The value bound to a variable, or what is known about it when it is external.

Parameters

`$node`	`Variable`
`$environment`	`Environment`
`$scope`	`FunctionScope`

Returns

Domain

Test cases 4

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::evaluate() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:58

Calls 9

function-call is_string line 91
static-call Domain::opaque() line 92
static-call TypeShape::unknown() line 92
class-const Origin::Unresolved() line 92
static-call Domain::of() line 97
new ObjectTerm line 97
method-call ExternalInput::isVariable() line 99
class-const Origin::External() line 100
method-call Environment::read() line 103

public function readArray(
    Array_ $node,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): Domain

source §

The array an array literal builds.

Parameters

`$node`	`Array_`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Returns

Domain

Test cases 3

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::evaluate() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:61

Calls 4

new ArrayEntry line 122
method-call ExpressionEvaluator::evaluate() line 123
static-call Domain::of() line 128
new ArrayTerm line 128

public function readElement(
    ArrayDimFetch $node,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): Domain

source §

The value of an array element.

A key that resolved reads the element written under it. A key that did not — self::TABLES[$kind] with $kind coming from a request — reads every element the array holds: whatever the key turns out to be, the value is one of them, and an array written out in full lists them all.

Parameters

`$node`	`ArrayDimFetch`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Returns

Domain

Test cases 1

ReferenceEvaluatorTest::testReadElementIsCalledWithTheExpressionItself calls

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::evaluate() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:64

Calls 5

method-call ExpressionEvaluator::evaluate() line 145
method-call NodeText::render() line 148
static-call Domain::opaque() line 150
static-call TypeShape::unknown() line 150
method-call ReferenceEvaluator::originOf() line 150

public function originOf(Domain $domain): Origin

source §

Where the unresolved parts of a domain come from.

Parameters

$domain Domain

Returns

Origin

Test cases 2

Called from 2

Calls 2

class-const Origin::Unresolved() line 158
class-const Origin::External() line 160

public function readProperty(
    PropertyFetch|NullsafePropertyFetch|StaticPropertyFetch $node,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): Domain

source §

The value of a property read, resolving a settled default when there is one.

A static property is read the same way: self::$tables declared with a default and assigned nowhere else holds that default for the life of the process, which makes it a constant spelled as a property.

Parameters

`$node`	`PropertyFetch\|NullsafePropertyFetch\|StaticPropertyFetch`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Returns

Domain

Test cases 4

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::evaluate() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:74

Calls 13

method-call ReferenceEvaluator::trackedName() line 184
method-call Environment::has() line 185
method-call Environment::read() line 186
method-call ConstantReader::resolveClassName() line 191
method-call ExpressionEvaluator::evaluate() line 193
static-call Domain::opaque() line 197
static-call TypeShape::unknown() line 197
class-const Origin::Property() line 197
method-call NodeText::render() line 197
method-call ReferenceEvaluator::readEnumProperty() line 200
method-call ProgramIndex::lineage() line 205
new Environment line 208
method-call ProgramIndex::findPropertyType() line 212

public function readEnumProperty(
    Domain $receiver,
    string $owner,
    string $property,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): ?Domain

source §

The value behind ->value or ->name on an enum.

A value typed as a backed enum can only ever be one of that enum's cases, so reading its backing value resolves to the union of them. That is what turns a parameter typed Status into the handful of strings the column can hold rather than an opaque string.

Parameters

`$receiver`	`Domain`
`$owner`	`string`
`$property`	`string`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Returns

?Domain

Test cases 3

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::readProperty() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:200

Calls 5

method-call ProgramIndex::findClass() line 232
method-call Domain::soleObject() line 237
static-call Domain::literal() line 244
method-call ExpressionEvaluator::evaluate() line 245
new Environment line 245

public function readInstance(New_ $node, FunctionScope $scope): Domain

source §

The object an instantiation produces.

Parameters

`$node`	`New_`
`$scope`	`FunctionScope`

Returns

Domain

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::evaluate() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:77

Calls 6

method-call ConstantReader::resolveClassName() line 257
static-call Domain::opaque() line 260
static-call TypeShape::of() line 260
class-const Origin::Unresolved() line 260
static-call Domain::of() line 261
new ObjectTerm line 261

public function trackedName(Expr $target): ?string

source §

The name a target is tracked under in the environment, or null when it is not tracked.

A variable is tracked under its name, and a property of $this under this->property, so that assigning it earlier in a body is seen when it is read later in the same body.

Parameters

$target Expr

Returns

?string

Test cases 1

ReferenceEvaluatorTest::testTrackedNameNamesAVariableOrAPropertyOfThis calls

Called from 4

Calls 1

function-call is_string line 274

public function assign(
    Expr $target,
    Domain $value,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): void

source §

Writes a value to whatever the target expression names.

Parameters

`$target`	`Expr`
`$value`	`Domain`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Test cases 1

ReferenceEvaluatorTest::testAssignLeavesATargetItDoesNotTrackAlone calls

Called from 4

Calls 8

new WriteEffects line 295
method-call ReferenceEvaluator::trackedName() line 297
method-call Environment::write() line 299
method-call ExpressionEvaluator::evaluate() line 304
method-call Environment::objects() line 307
new ObjectTerm line 307
method-call ReferenceEvaluator::assignElement() line 314
method-call ReferenceEvaluator::assignList() line 319

public function assignList(
    List_|Array_ $target,
    Domain $value,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): void

source §

Writes the elements of an array into the targets a destructuring assignment lists.

Parameters

`$target`	`List_\|Array_`
`$value`	`Domain`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Test cases 5

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::assign() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:319

Calls 7

method-call Domain::soleArray() line 333
method-call ExpressionEvaluator::evaluate() line 340
method-call ReferenceEvaluator::assign() line 342
static-call Domain::opaque() line 344
static-call TypeShape::unknown() line 344
method-call ReferenceEvaluator::originOf() line 344
method-call NodeText::render() line 344

public function assignElement(
    ArrayDimFetch $target,
    Domain $value,
    Environment $environment,
    FunctionScope $scope,
    ExpressionEvaluator $expressions,
): void

source §

Writes a value into an array held by a tracked name, keeping the key when one is written.

A write one level down, such as $parts['where'][] = …, is not followed element by element: the array it goes into is marked as no longer known in full, so reading it back never claims to have seen all of it.

Parameters

`$target`	`ArrayDimFetch`
`$value`	`Domain`
`$environment`	`Environment`
`$scope`	`FunctionScope`
`$expressions`	`ExpressionEvaluator`

Test cases 3

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::assign() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:314

Calls 11

method-call ReferenceEvaluator::trackedName() line 366
method-call ReferenceEvaluator::assign() line 373
static-call Domain::unknown() line 373
method-call ReferenceEvaluator::loseTrack() line 375
method-call ExpressionEvaluator::evaluate() line 379
method-call Environment::has() line 380
method-call Environment::read() line 380
new ArrayEntry line 382
method-call Environment::write() line 384
static-call Domain::of() line 384
new ArrayTerm line 384

public function loseTrack(Expr $target, Environment $environment): void

source §

Marks the array a nested write goes into as no longer known in full.

Parameters

`$target`	`Expr`
`$environment`	`Environment`

Test cases 3

Called from 1

method-call SqlCatalog\Core\Analysis\ReferenceEvaluator::assignElement() packages/sql-catalog/src/Core/Analysis/ReferenceEvaluator.php:375

Calls 6

method-call ReferenceEvaluator::trackedName() line 395
method-call Environment::has() line 396
method-call Environment::read() line 396
method-call Environment::write() line 398
static-call Domain::of() line 398
new ArrayTerm line 398

Private surface 5§

Implementation details, listed for orientation only.

private ProgramIndex $index

private ExternalInput $external

private NodeText $text

private ConstantReader $constants

private ?WriteEffects $effects = null

Test cases 57§

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

Dedicated tests 34

Other tests reaching this symbol 23

Relations§

Instantiated in 1

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

Method calls 3

Type declarations 3