Skip to content

classReportSite

packages/sql-catalog/src/Reporter/Html/ReportSite.php:21

final class ReportSite

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

The pages the report is made of, and the address of everything on them.

A reader reaches a statement by a route — the table it names, the class or file it is written in, the finding reported on it — and each route is a page of its own. Once every table, class, file and statement has an address, any page can point at any other rather than repeating it, which is what lets a statement be found from wherever the reader started.

Constants§

public const INDEX = 'index.html'

The page a reader opens first.

public const STATEMENTS = 'statements.html'

The page listing every statement, for narrowing down.

public const TABLES = 'tables.html'

The page listing every table the catalog names.

public const NAMESPACES = 'namespaces.html'

The page listing every namespace, with its classes and functions.

public const FILES = 'files.html'

The page listing every file the statements are written in.

public const FINDINGS = 'findings.html'

The page listing every finding.

Properties§

public SqlFormatter $formatter = new \SqlCatalog\Reporter\Html\SqlFormatter()

Methods§

public function __construct(
    Catalog $catalog,
    ?HtmlText $text = null,
    public SqlFormatter $formatter = new \SqlCatalog\Reporter\Html\SqlFormatter(),
)

Lays a catalog out as pages.

Parameters

`$catalog`	`Catalog`
`$text`	`?HtmlText`
`$formatter`	`SqlFormatter`

Calls 10

new SqlFormatter line 79
new HtmlText line 81
method-call Catalog::sorted() line 82
new CatalogIndex line 83
new CatalogStatistics line 84
method-call ReportSite::pagesFor() line 85
function-call array_keys line 85
method-call CatalogIndex::byTable() line 85
method-call CatalogIndex::byClass() line 86
method-call CatalogIndex::byFile() line 87

public function catalog(): Catalog

The catalog, in reporting order.

Returns

Catalog

Test cases 1

ReportSiteTest::testCatalogIsHeldInReportingOrder calls

Called from 7

public function index(): CatalogIndex

The catalog grouped along every route.

Returns

CatalogIndex

Test cases 1

ReportSiteTest::testIndexGroupsTheCatalog calls

Called from 39

public function statistics(): CatalogStatistics

The counts the pages are read through.

Returns

CatalogStatistics

Test cases 1

ReportSiteTest::testStatisticsCountTheCatalog calls

Called from 8

public function pagesFor(list<string> $keys, string $directory): array<string, string>

One page name per key, unique even when two keys slug alike.

Parameters

`$keys`	`list<string>`
`$directory`	`string`

Returns

array<string, string>

Test cases 1

ReportSiteTest::testPagesForKeepsNamesApartWhenTheySlugAlike calls

Called from 3

Calls 1

method-call HtmlText::slug() line 125

public function statementPage(string $id): string

The page one statement is written on.

Parameters

$id string

Returns

string

Test cases 1

ReportSiteTest::testStatementPageIsNamedAfterTheIdentifier calls

Called from 5

public function tablePage(string $table): string

The page one table is written on, or the tables listing for a table the catalog does not name.

Parameters

$table string

Returns

string

Test cases 1

ReportSiteTest::testTablePageFallsBackToTheListingForAnUnknownTable calls

Called from 13

Calls 1

class-const ReportSite::TABLES() line 151

public function classPage(string $class): string

The page one class is written on, or the namespaces listing for a class the catalog does not know.

Parameters

$class string

Returns

string

Test cases 1

ReportSiteTest::testClassPageFallsBackToTheListingForAnUnknownClass calls

Called from 8

Calls 1

class-const ReportSite::NAMESPACES() line 159

public function filePage(string $file): string

The page one file is written on, or the files listing for a file the catalog does not hold.

Parameters

$file string

Returns

string

Test cases 1

ReportSiteTest::testFilePageFallsBackToTheListingForAnUnknownFile calls

Called from 15

Calls 1

class-const ReportSite::FILES() line 167

public function functionAnchor(string $function): string

The identifier a function's statements are grouped under on a class or file page.

Parameters

$function string

Returns

string

Test cases 1

ReportSiteTest::testFunctionAnchorIsWhatAFunctionsStatementsAreGroupedUnder calls

Called from 5

Calls 2

method-call HtmlText::slug() line 175
static-call Scope::of() line 175

public function functionUrl(CatalogEntry $entry): string

The address of the section listing what one function issues.

A method is listed on its class's page; a function, and top-level code, on the page of the file it is written in.

Parameters

$entry CatalogEntry

Returns

string

Test cases 1

ReportSiteTest::testFunctionUrlLeadsToTheClassPageForAMethodAndTheFilePageOtherwise calls

Called from 8

Calls 4

static-call Scope::of() line 186
method-call ReportSite::filePage() line 187
method-call ReportSite::classPage() line 187
method-call ReportSite::functionAnchor() line 189

public function tables(): list<string>

Every table that has a page, most named first.

Returns

list<string>

Test cases 1

ReportSiteTest::testTablesAreMostNamedFirst calls

Called from 4

Calls 1

function-call array_keys line 199

public function classes(): list<string>

Every class that has a page, in name order.

Returns

list<string>

Test cases 1

ReportSiteTest::testClassesAreInNameOrder calls

Called from 1

method-call SqlCatalog\Reporter\Html\HtmlReporter::classPages() packages/sql-catalog/src/Reporter/Html/HtmlReporter.php:131

Calls 1

function-call array_keys line 209

public function files(): list<string>

Every file that has a page, in path order.

Returns

list<string>

Test cases 1

ReportSiteTest::testFilesAreInPathOrder calls

Called from 5

Calls 1

function-call array_keys line 219

public function prefixOf(string $page): string

What a link from that page has to be written through to reach the root.

Parameters

$page string

Returns

string

Test cases 1

ReportSiteTest::testPrefixOfIsWhatALinkFromThatPageGoesThrough calls

Called from 4

Calls 2

function-call str_repeat line 227
function-call substr_count line 227

Private surface 7§

Implementation details, listed for orientation only.

private Catalog $catalog

private CatalogIndex $index

private CatalogStatistics $statistics

private HtmlText $text

private array<string, string> $tablePages

private array<string, string> $classPages

private array<string, string> $filePages

Test cases 101§

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

Dedicated tests 14

Other tests reaching this symbol 87

Relations§

Instantiated in 1

new SqlCatalog\Reporter\Html\HtmlReporter::render() packages/sql-catalog/src/Reporter/Html/HtmlReporter.php:72

Method calls 119

Constant reads 45

Type declarations 59