classProgramIndex

packages/sql-catalog/src/Core/Php/ProgramIndex.php:17

final class ProgramIndex

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

Every declaration the analyzed source tree contains, looked up by name.

Resolution follows parents, traits and interfaces, so a repository method inherited from an abstract base is found from the subclass the call names.

Properties§

public array<string, ClassShape> $classes = []

source §

public array<string, FunctionShape> $functions = []

source §

public array<string, Expr> $constants = []

source §

Methods§

public function __construct(
    public array<string, ClassShape> $classes = [],
    public array<string, FunctionShape> $functions = [],
    public array<string, Expr> $constants = [],
)

source §

Parameters

`$classes`	`array<string, ClassShape>`	Class-likes, keyed by lower-case fully qualified name
`$functions`	`array<string, FunctionShape>`	Functions, keyed by lower-case fully qualified name
`$constants`	`array<string, Expr>`	Global constant expressions, keyed by fully qualified name

public function findClass(?string $name): ?ClassShape

source §

The class-like of that name, or null when the source tree does not declare it.

Parameters

$name ?string

Returns

?ClassShape

Test cases 1

ProgramIndexTest::testFindClassIgnoresCaseAndLeadingBackslashes calls

Called from 9

Calls 2

function-call strtolower line 36
function-call ltrim line 36

public function findFunction(string $name): ?FunctionShape

source §

The function of that name, or null when the source tree does not declare it.

Parameters

$name string

Returns

?FunctionShape

Test cases 1

ProgramIndexTest::testFindFunctionIgnoresCase calls

Called from 3

Calls 2

function-call strtolower line 44
function-call ltrim line 44

public function findConstant(string $name): ?Expr

source §

The global constant expression of that name, or null when there is none.

Parameters

$name string

Returns

?Expr

Test cases 1

ProgramIndexTest::testFindConstantReadsTheDeclaredExpression calls

Called from 2

Calls 1

function-call ltrim line 52

public function findMethod(?string $className, string $method): ?MethodShape

source §

The method of that name on the class or anything it inherits from.

Parameters

`$className`	`?string`
`$method`	`string`

Returns

?MethodShape

Called from 3

Calls 2

function-call strtolower line 60
method-call ProgramIndex::lineage() line 61

public function findClassConstant(?string $className, string $constant): ?Expr

source §

The class constant expression of that name on the class or anything it inherits from.

Parameters

`$className`	`?string`
`$constant`	`string`

Returns

?Expr

Called from 2

Calls 1

method-call ProgramIndex::lineage() line 75

public function findPropertyType(?string $className, string $property): ?TypeShape

source §

The declared type of a property on the class or anything it inherits from.

Parameters

`$className`	`?string`
`$property`	`string`

Returns

?TypeShape

Called from 1

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

Calls 1

method-call ProgramIndex::lineage() line 89

public function isInstanceOf(?string $className, string $expected): bool

source §

Whether the class is, or inherits from, the named one.

The walk follows written names rather than indexed declarations, so a class that extends one the analyzed source does not declare — a driver class, or a framework base class — is still recognised as inheriting it.

Parameters

`$className`	`?string`
`$expected`	`string`

Returns

bool

Called from 11

Calls 4

function-call strtolower line 107
function-call ltrim line 107
function-call array_shift line 112
method-call ProgramIndex::findClass() line 120

public function lineage(?string $className): list<ClassShape>

source §

The class and everything it inherits from, nearest first, without repeats.

Parameters

$className ?string

Returns

list<ClassShape>

Called from 9

Calls 4

method-call ProgramIndex::findClass() line 135
function-call strtolower line 140
function-call array_shift line 144
function-call ltrim line 147

public function implementationsOf(
    ?string $className,
    string $method,
    int $limit = 8,
): list<MethodShape>

source §

The concrete implementations of a method, for a call the declaration cannot answer.

A call on an abstract class or an interface names a method whose body is somewhere else. Collecting the bodies the source tree does declare is what lets a statement built by a subclass resolve instead of becoming a gap.

Parameters

`$className`	`?string`
`$method`	`string`
`$limit`	`int`	How many implementations to return before giving up on enumerating them

Returns

list<MethodShape>

Called from 1

method-call SqlCatalog\Core\Analysis\CallEvaluator::dispatch() packages/sql-catalog/src/Core/Analysis/CallEvaluator.php:248

Calls 3

function-call strtolower line 175
method-call ProgramIndex::isInstanceOf() line 182
function-call count line 185

public function merge(self $other): self

source §

The index holding the declarations of both, with this one taking precedence.

Parameters

$other self

Returns

self

Test cases 1

ProgramIndexTest::testMergePrefersTheDeclarationsOfThisIndex calls

Calls 1

new self line 198

Test cases 250§

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

Dedicated tests 4

Other tests reaching this symbol 246

Relations§

Instantiated in 1

new SqlCatalog\Core\Php\ProgramIndexBuilder::build() packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:80

Method calls 34

Type declarations 22