classProgramIndexBuilder

packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:26

final class ProgramIndexBuilder

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

Collects every declaration of a parsed source tree into one index.

Methods§

public function __construct(?TypeReader $types = null)

source §

Builds a collector that reads declarations with the given type reader.

Parameters

$types ?TypeReader

Calls 2

new NodeFinder line 37
new TypeReader line 38

public function build(list<ParsedFile> $files): ProgramIndex

source §

The index of every declaration in the given files.

Parameters

$files list<ParsedFile>

Returns

ProgramIndex

Test cases 178

Called from 1

method-call SqlCatalog\Facade\Analyzer::entriesOf() packages/sql-catalog/src/Facade/Analyzer.php:160

Calls 8

method-call NodeFinder::findInstanceOf() line 53
class-const Node::class() line 53
method-call ProgramIndexBuilder::readClass() line 55
function-call strtolower line 57
new FunctionShape line 63
method-call ProgramIndexBuilder::readParameters() line 65
method-call TypeReader::read() line 66
new ProgramIndex line 80

public function readClass(ClassLike $node, string $file = ''): ?ClassShape

source §

The shape of one class-like declaration, or null when it has no resolvable name.

Parameters

`$node`	`ClassLike`
`$file`	`string`

Returns

?ClassShape

Test cases 3

Called from 1

method-call SqlCatalog\Core\Php\ProgramIndexBuilder::build() packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:55

Calls 8

method-call ClassLike::getMethods() line 95
function-call strtolower line 96
method-call ProgramIndexBuilder::readMethod() line 96
method-call ProgramIndexBuilder::readPromotedProperties() line 97
method-call ProgramIndexBuilder::readMembers() line 99
new ClassShape line 101
method-call ProgramIndexBuilder::readParentNames() line 104
function-call array_merge line 109

public function readMembers(ClassLike $node): array{traits: list<string>, constants: array<string, Expr>, cases: array<string, Expr|null>, properties: array<string, TypeShape>, defaults: array<string, Expr>, assigned: array<string, true>}

source §

Everything a class body declares, read in one pass over it.

The body is walked once and its declarations are sorted afterwards, which matters on a source tree with thousands of classes in it.

Parameters

$node ClassLike

Returns

array{traits: list<string>, constants: array<string, Expr>, cases: array<string, Expr|null>, properties: array<string, TypeShape>, defaults: array<string, Expr>, assigned: array<string, true>}

Test cases 1

ProgramIndexBuilderTest::testReadMembersReadsTheWholeClassBodyInOnePass calls

Called from 1

method-call SqlCatalog\Core\Php\ProgramIndexBuilder::readClass() packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:99

Calls 4

method-call NodeFinder::findInstanceOf() line 135
class-const Node::class() line 135
method-call TypeReader::read() line 151
method-call ProgramIndexBuilder::assignmentTarget() line 157

public function readAssignedProperties(ClassLike $node): array<string, true>

source §

The properties the class body assigns to, other than by promotion.

Parameters

$node ClassLike

Returns

array<string, true>

Test cases 1

ProgramIndexBuilderTest::testReadAssignedPropertiesFindsWritesInTheClassBody calls

Calls 3

method-call NodeFinder::findInstanceOf() line 174
class-const Expr::class() line 174
method-call ProgramIndexBuilder::assignmentTarget() line 175

public function assignmentTarget(Expr $expression): ?string

source §

The property name an expression assigns to, or null when it assigns to none.

Parameters

$expression Expr

Returns

?string

Test cases 1

ProgramIndexBuilderTest::testAssignmentTargetIsNullWhenNothingIsWrittenToAProperty calls

Called from 2

public function readParentNames(ClassLike $node): list<string>

source §

The interfaces the declaration implements or extends.

Parameters

$node ClassLike

Returns

list<string>

Test cases 2

Called from 1

method-call SqlCatalog\Core\Php\ProgramIndexBuilder::readClass() packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:104

public function readTraitNames(ClassLike $node): list<string>

source §

The traits the declaration uses.

Parameters

$node ClassLike

Returns

list<string>

Test cases 1

ProgramIndexBuilderTest::testReadTraitNamesCollectsUsedTraits calls

Calls 2

method-call NodeFinder::findInstanceOf() line 236
class-const TraitUse::class() line 236

public function readConstants(ClassLike $node): array<string, Expr>

source §

The class constant expressions declared on the class-like.

Parameters

$node ClassLike

Returns

array<string, Expr>

Test cases 1

ProgramIndexBuilderTest::testReadConstantsCollectsEveryDeclaration calls

Calls 2

method-call NodeFinder::findInstanceOf() line 253
class-const ClassConst::class() line 253

public function readEnumCases(ClassLike $node): array<string, Expr|null>

source §

The enum case backing expressions declared on the class-like.

Parameters

$node ClassLike

Returns

array<string, Expr|null>

Test cases 1

ProgramIndexBuilderTest::testReadEnumCasesKeepsACaseWithoutABackingValue calls

Calls 2

method-call NodeFinder::findInstanceOf() line 270
class-const EnumCase::class() line 270

public function readPromotedProperties(ClassMethod $method): array<string, TypeShape>

source §

The properties a constructor promotes.

Parameters

$method ClassMethod

Returns

array<string, TypeShape>

Test cases 1

ProgramIndexBuilderTest::testReadPromotedPropertiesOnlyLooksAtTheConstructor calls

Called from 1

method-call SqlCatalog\Core\Php\ProgramIndexBuilder::readClass() packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:97

Calls 3

function-call strtolower line 284
function-call is_string line 290
method-call TypeReader::read() line 291

public function readMethod(
    string $className,
    ClassMethod $method,
    string $file = '',
): MethodShape

source §

The shape of one method declaration.

Parameters

`$className`	`string`
`$method`	`ClassMethod`
`$file`	`string`

Returns

MethodShape

Test cases 1

ProgramIndexBuilderTest::testReadMethodRecordsTheSignature calls

Called from 1

method-call SqlCatalog\Core\Php\ProgramIndexBuilder::readClass() packages/sql-catalog/src/Core/Php/ProgramIndexBuilder.php:96

Calls 4

new MethodShape line 303
method-call ProgramIndexBuilder::readParameters() line 306
method-call TypeReader::read() line 307
method-call ClassMethod::isStatic() line 308

public function readParameters(array<array-key, Param> $params): list<ParameterShape>

source §

The shapes of a declaration's parameters, in order.

Parameters

$params array<array-key, Param>

Returns

list<ParameterShape>

Test cases 1

ProgramIndexBuilderTest::testReadParametersSkipsParametersWithoutAPlainName calls

Called from 2

Calls 3

function-call is_string line 324
new ParameterShape line 327
method-call TypeReader::read() line 329

Private surface 2§

Implementation details, listed for orientation only.

private NodeFinder $finder

private TypeReader $types

Test cases 199§

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

Dedicated tests 15

Other tests reaching this symbol 184

Relations§

Instantiated in 1

new SqlCatalog\Facade\Analyzer::__construct() packages/sql-catalog/src/Facade/Analyzer.php:67

Method calls 1

method-call SqlCatalog\Facade\Analyzer::entriesOf() packages/sql-catalog/src/Facade/Analyzer.php:160

Type declarations 1

type SqlCatalog\Facade\Analyzer packages/sql-catalog/src/Facade/Analyzer.php:54