classModifiedNames

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

final class ModifiedNames

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

The names a statement may assign, wherever inside it the assignment is written.

Walking back over a statement that assigns none of the names still being looked for learns nothing, so this is what decides whether a branch has to be split into its arms at all. The answer is remembered per statement, because the same statement is walked back over once for every path that crosses it.

Methods§

public function __construct(?FreeNames $names = null, private ?ObjectEffects $objects = null)

source §

Builds the reader over the naming the rest of the derivation uses.

Parameters

`$names`	`?FreeNames`
`$objects`	`?ObjectEffects`

Calls 2

new FreeNames line 41
new WeakMap line 42

public function touches(Node $node, array<string, true> $wanted): bool

source §

Whether the node may assign any of the given names.

Parameters

`$node`	`Node`
`$wanted`	`array<string, true>`

Returns

bool

Test cases 2

Called from 3

Calls 3

method-call ModifiedNames::of() line 52
class-const WriteEffects::ALL() line 54
function-call array_intersect_key line 54

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

source §

Every name the node may assign.

Parameters

$node Node

Returns

array<string, true>

Test cases 1

ModifiedNamesTest::testOfNamesEverythingAStatementMayAssign calls

Called from 7

Calls 1

method-call ModifiedNames::collect() line 68

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

source §

Every name the node may assign, worked out from scratch.

Parameters

$node Node

Returns

array<string, true>

Test cases 1

ModifiedNamesTest::testCollectWorksTheAnswerOutFromScratch calls

Called from 1

method-call SqlCatalog\Core\Analysis\Derivation\ModifiedNames::of() packages/sql-catalog/src/Core/Analysis/Derivation/ModifiedNames.php:68

Calls 5

method-call ModifiedNames::own() line 84
new ReferenceEffects line 85
function-call get_object_vars line 87
function-call is_array line 88
method-call ModifiedNames::of() line 90

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

source §

The names the node itself assigns, leaving aside what its children assign.

Parameters

$node Node

Returns

array<string, true>

Test cases 2

Called from 6

Calls 5

method-call ModifiedNames::targets() line 106
method-call WriteEffects::own() line 106
new WriteEffects line 106
method-call ModifiedNames::all() line 113
new ReferenceEffects line 132

public function tracksObjects(): bool

source §

Whether object calls are retained as whole expression steps.

Returns

bool

Test cases 1

ModifiedNamesTest::testTracksObjectsRequiresAnExplicitEffectModel calls

Called from 2

public function targets(Node $target): array<string, true>

source §

The names written by assigning to the given target.

Parameters

$target Node

Returns

array<string, true>

Test cases 1

ModifiedNamesTest::testTargetsNameEveryVariableADestructuringWrites calls

Called from 16

Calls 3

method-call ModifiedNames::targets() line 153
method-call FreeNames::propertyName() line 155
method-call ModifiedNames::baseName() line 158

public function baseName(Node $target): ?string

source §

The name an assignment target writes into, looking through element writes.

$sql['where'][] = … writes into sql; $this->parts[] = … writes into this->parts. Anything else, such as a variable variable, has no name.

Parameters

$target Node

Returns

?string

Test cases 1

ModifiedNamesTest::testBaseNameLooksThroughElementWrites calls

Called from 3

Calls 3

method-call ModifiedNames::baseName() line 185
function-call is_string line 188
method-call FreeNames::propertyName() line 191

public function all(array<array-key, Node> $targets): array<string, true>

source §

The names written by each of the given targets.

Parameters

$targets array<array-key, Node>

Returns

array<string, true>

Test cases 1

ModifiedNamesTest::testAllNamesWhatEachTargetWrites calls

Called from 2

Calls 1

method-call ModifiedNames::targets() line 204

Private surface 4§

Implementation details, listed for orientation only.

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

private FreeNames $names

private ?ReferenceEffects $references = null

private ?ObjectEffects $objects = null

Test cases 65§

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 56

Relations§

Instantiated in 9

Method calls 25

Type declarations 10