classCatalog

packages/sql-catalog/src/Core/Catalog/Catalog.php:24

final class Catalog
    implements IteratorAggregate<int, CatalogEntry>, Countable

Public API: explicitly declared with @visibility public.

Every statement the analyzed application can issue, and what stopped the analyzer.

Reading an empty catalogdoctest

$catalog = new \SqlCatalog\Core\Catalog\Catalog();
    $catalog->count() // => 0
    $catalog->entries() // => []

Methods§

public function __construct(
    list<CatalogEntry> $entries = [],
    list<AnalysisProblem> $problems = [],
    array<string, string> $sources = [],
)

source §

Parameters

`$entries`	`list<CatalogEntry>`	The statements found, in reporting order
`$problems`	`list<AnalysisProblem>`	The files that could not be analyzed
`$sources`	`array<string, string>`	Source snapshots keyed by the reported file path

public function entries(): list<CatalogEntry>

source §

The statements, in reporting order.

Returns

list<CatalogEntry>

Test cases 1

CatalogTest::testEntriesAreReturnedInTheOrderTheyWereGiven calls

public function problems(): list<AnalysisProblem>

source §

The files that could not be analyzed.

Returns

list<AnalysisProblem>

Test cases 1

CatalogTest::testProblemsAreKept calls

Called from 2

public function source(string $file): ?string

source §

The source as it was analyzed, or null when no snapshot was supplied.

Parameters

$file string

Returns

?string

Test cases 1

CatalogTest::testSourceSurvivesFilteringSortingAndMerging calls

Called from 1

method-call SqlCatalog\Reporter\Html\CatalogIndex::__construct() packages/sql-catalog/src/Reporter/Html/CatalogIndex.php:41

public function find(string $id): ?CatalogEntry

source §

The statement of that identifier, or null when the catalog has none.

Parameters

$id string

Returns

?CatalogEntry

Test cases 1

CatalogTest::testFindLooksUpAStatementByItsIdentifier calls

public function filter(callable(CatalogEntry): bool $keep): self

source §

A catalog holding only the statements the given test keeps.

Parameters

$keep callable(CatalogEntry): bool

Returns

self

Test cases 3

Called from 1

method-call SqlCatalog\Core\Filter\CatalogFilter::apply() packages/sql-catalog/src/Core/Filter/CatalogFilter.php:61

Calls 3

new self line 102
function-call array_values line 102
function-call array_filter line 102

public function merge(self $other): self

source §

A catalog holding these statements and the given ones.

Parameters

$other self

Returns

self

Test cases 2

Calls 3

new self line 110
function-call array_merge line 111
function-call array_replace line 113

public function sorted(): self

source §

The statements sorted by where they are issued, so two runs compare cleanly.

Returns

self

Test cases 1

CatalogTest::testSortedOrdersByWhereTheStatementIsIssued calls

Called from 8

Calls 2

function-call usort line 123
new self line 131

public function count(): int

source §

How many statements the catalog holds.

Returns

int

Called from 3

Calls 1

function-call count line 140

public function getIterator(): Traversable<int, CatalogEntry>

source §

The statements, so a catalog can be walked directly.

Returns

Traversable<int, CatalogEntry>

Calls 1

new ArrayIterator line 151

Private surface 3§

Implementation details, listed for orientation only.

private list<CatalogEntry> $entries

private list<AnalysisProblem> $problems

private array<string, string> $sources

Test cases 161§

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 152

Relations§

Instantiated in 2

Method calls 15

Type declarations 18