classEnvironment

packages/sql-catalog/src/Core/Evaluation/Environment.php:15

final class Environment

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

What the analyzer knows about each variable at one point in a function body.

Properties§

public bool $combined = false

source §

Whether joining branch states lost their pairing.

Methods§

public function __construct(
    array<string, Domain> $variables = [],
    ?ObjectMemory $objects = null,
)

source §

Parameters

`$variables`	`array<string, Domain>`	Initial bindings, keyed by variable name without the sigil
`$objects`	`?ObjectMemory`

Calls 4

method-call Environment::objects() line 41
function-call array_fill_keys line 44
function-call array_keys line 44
class-const Presence::Present() line 44

public function read(string $name): Domain

source §

The domain bound to a variable, or an unresolved domain when it has none.

Parameters

$name string

Returns

Domain

Test cases 52

Called from 11

Calls 7

method-call Environment::presence() line 52
class-const Presence::Absent() line 52
static-call Domain::literal() line 53
method-call Environment::refresh() line 56
static-call Domain::opaque() line 56
static-call TypeShape::unknown() line 56
class-const Origin::Unresolved() line 56

public function write(string $name, Domain $domain): void

source §

Binds a variable to a domain.

Parameters

`$name`	`string`
`$domain`	`Domain`

Test cases 2

Called from 9

Calls 3

method-call Domain::soleObject() line 66
method-call Environment::objects() line 68
class-const Presence::Present() line 70

public function narrow(string $name, Domain $domain): void

source §

Narrows a value while keeping a possible absence distinct from present null.

Parameters

`$name`	`string`
`$domain`	`Domain`

Test cases 1

EnvironmentTest::testNarrowDoesNotTurnPossibleAbsenceIntoPresentNull calls

Calls 4

method-call Environment::presence() line 78
method-call Environment::write() line 79
class-const Presence::Present() line 80
method-call Domain::type() line 80

public function has(string $name): bool

source §

Whether the variable has a binding.

Parameters

$name string

Returns

bool

Test cases 4

Called from 4

public function forget(string $name): void

source §

Drops the binding of a variable.

Parameters

$name string

Test cases 1

EnvironmentTest::testForgetDropsABinding calls

public function names(): list<string>

source §

The bound variable names.

Returns

list<string>

Test cases 13

Called from 2

Calls 1

function-call array_keys line 108

public function copy(): self

source §

An independent copy, so a branch can be analyzed without disturbing the caller.

Returns

self

Test cases 5

Called from 11

public function join(self $other): self

source §

The environment holding, for each variable, what either branch may leave in it.

A variable bound in only one branch keeps that branch's domain widened with the unresolved value it holds when the branch is not taken.

Parameters

$other self

Returns

self

Test cases 4

Called from 2

Calls 11

new self line 130
function-call array_unique line 131
function-call array_merge line 131
method-call Environment::names() line 131
method-call self::names() line 131
method-call Environment::presence() line 132
method-call self::presence() line 133
method-call Environment::read() line 134
method-call self::read() line 134
class-const Presence::Maybe() line 135
method-call Environment::equals() line 137

public function presence(string $name): Presence

source §

The existence of a variable, independently of what value it holds.

Parameters

$name string

Returns

Presence

Test cases 8

Called from 3

Calls 1

class-const Presence::Maybe() line 149

public function markAbsent(string $name): void

source §

Records that a variable is definitely undefined.

Parameters

$name string

Test cases 10

Called from 3

Calls 1

class-const Presence::Absent() line 158

public function invalidate(string $name, Origin $origin = Origin::Unresolved): void

source §

Forgets both the value and existence after an unmodelled write.

Parameters

`$name`	`string`
`$origin`	`Origin`

Test cases 2

Called from 1

method-call SqlCatalog\Core\Analysis\Effect\WriteEffects::apply() packages/sql-catalog/src/Core/Analysis/Effect/WriteEffects.php:135

Calls 5

class-const Origin::Unresolved() line 164
method-call Environment::read() line 166
static-call Domain::opaque() line 167
static-call TypeShape::unknown() line 167
class-const Presence::Maybe() line 168

public function replace(self $other): void

source §

Replaces this state with the result of evaluating alternatives.

Parameters

$other self

Test cases 2

Called from 4

public function signature(): string

source §

A canonical string used to compare environments.

Returns

string

Test cases 34

Called from 1

method-call SqlCatalog\Core\Evaluation\Environment::equals() packages/sql-catalog/src/Core/Evaluation/Environment.php:204

Calls 4

method-call Environment::read() line 189
class-const Presence::Present() line 190
function-call sort line 192
function-call implode line 196

public function equals(self $other): bool

source §

Whether the two environments bind the same names to the same values.

Parameters

$other self

Returns

bool

Test cases 3

Called from 1

method-call SqlCatalog\Core\Evaluation\Environment::join() packages/sql-catalog/src/Core/Evaluation/Environment.php:137

Calls 2

method-call Environment::signature() line 204
method-call self::signature() line 204

public function refresh(Domain $value): Domain

source §

Resolves an already-evaluated object reference after subsequent argument effects.

Parameters

$value Domain

Returns

Domain

Test cases 1

EnvironmentTest::testRefreshObservesLaterMutationsThroughAnAlreadyEvaluatedReference calls

Called from 2

public function objects(): ObjectMemory

source §

The object snapshots shared by this run's aliases.

Returns

ObjectMemory

Test cases 3

Called from 13

Calls 1

new ObjectMemory line 220

Private surface 3§

Implementation details, listed for orientation only.

private array<string, Domain> $variables

private ?ObjectMemory $objects

private array<string, Presence> $presence = []

Test cases 210§

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

Dedicated tests 22

Other tests reaching this symbol 188

Relations§

Instantiated in 15

Method calls 54

Type declarations 58