classObjectEffects

packages/sql-catalog/src/Core/Analysis/Derivation/Objects/ObjectEffects.php:19

final class ObjectEffects

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

Conservative alias dependencies for calls that may mutate an object.

Methods§

public function __construct(list<ParsedFile> $files = [])

source §

Indexes possible file-scope aliases; function scopes are indexed on demand.

Parameters

$files list<ParsedFile>

Calls 3

new WeakMap line 33
method-call ObjectEffects::graph() line 35
new Namespace_ line 35

public function writes(Node $node): array<string, true>

source §

Parameters

$node Node

Returns

array<string, true> Names whose objects a call may change.

Test cases 3

Calls 10

method-call Node::isFirstClassCallable() line 52
method-call ObjectEffects::root() line 57
method-call Node::getArgs() line 62
method-call ObjectEffects::storedRoots() line 63
method-call FreeNames::read() line 67
new FreeNames line 67
method-call ObjectEffects::owner() line 70
method-call ObjectEffects::graph() line 71
function-call array_keys line 73
function-call array_shift line 75

public function root(Node $node): ?string

source §

The variable through which an expression reaches an object.

Parameters

$node Node

Returns

?string

Test cases 1

ObjectEffectsTest::testRootFindsTheBaseOfFluentCallsAndArrayElements calls

Called from 5

Calls 4

function-call is_string line 92
method-call ObjectEffects::root() line 95
method-call FreeNames::propertyName() line 98
new FreeNames line 98

public function owner(Node $node): Node

source §

The lexical body in which alias assignments are relevant.

Parameters

$node Node

Returns

Node

Test cases 1

ObjectEffectsTest::testOwnerStopsAtTheEnclosingFunction calls

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\Objects\ObjectEffects::writes() packages/sql-catalog/src/Core/Analysis/Derivation/Objects/ObjectEffects.php:70

Calls 1

method-call Node::getAttribute() line 106

public function graph(Node $owner): array<string, array<string, true>>

source §

Parameters

$owner Node

Returns

array<string, array<string, true>> Possible aliases, without claiming equal runtime identity.

Test cases 1

ObjectEffectsTest::testGraphDoesNotTreatClonesAsAliases calls

Called from 2

Calls 3

method-call ObjectEffects::assignments() line 124
method-call ObjectEffects::root() line 125
method-call ObjectEffects::storedRoots() line 126

public function storedRoots(Expr $expression): list<string>

source §

Possible object references stored by an assignment, including array elements.

Parameters

$expression Expr

Returns

list<string>

Test cases 2

Called from 3

Calls 3

method-call ObjectEffects::root() line 144
function-call array_merge line 151
method-call ObjectEffects::storedRoots() line 151

public function assignments(Node $node, bool $root = false): list<Assign|AssignRef>

source §

Parameters

`$node`	`Node`
`$root`	`bool`

Returns

list<Assign|AssignRef> Assignments outside nested declarations.

Test cases 1

ObjectEffectsTest::testAssignmentsExcludesNestedFunctionsAndClasses calls

Called from 2

Calls 4

function-call get_object_vars line 167
function-call is_array line 168
function-call array_merge line 170
method-call ObjectEffects::assignments() line 170

Private surface 1§

Implementation details, listed for orientation only.

private WeakMap<Node, array<string, array<string, true>>> $aliases

Test cases 23§

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

Dedicated tests 9

Other tests reaching this symbol 14

Relations§

Instantiated in 2

Method calls 1

method-call SqlCatalog\Core\Analysis\Derivation\Objects\CallbackEffects::supported() packages/sql-catalog/src/Core/Analysis/Derivation/Objects/CallbackEffects.php:87

Type declarations 1

type SqlCatalog\Core\Analysis\Derivation\ModifiedNames packages/sql-catalog/src/Core/Analysis/Derivation/ModifiedNames.php:39