github.com

classOverviewPage

packages/sql-catalog/src/Reporter/Html/Page/OverviewPage.php:26
final class OverviewPage
Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

The page a reader opens first: the routes to a statement, and what needs looking at.

A reader comes to the catalog with a question — what touches this table, what does this class issue, where is SQL built from values the program does not control — and the overview is laid out as those routes rather than as a summary of counts. Every figure on it is a link to the statements it counts, so a number is never the end of a reading.

Constants§

public const TOP = 6
source§

How many entries a route shows before pointing at its own page.

Methods§

public function __construct(?HtmlText $text = null, ?Palette $palette = null)
source§

Wires the page to the rendering it is written with.

Parameters

$text?HtmlText
$palette?Palette
Calls 2
public function facts(ReportSite $site): string
source§

What the catalog holds, as a row of figures each leading to the listing it counts.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 12
public function tableRoute(ReportSite $site): string
source§

The route by table: what reads and writes each one.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 12
public function namespaceRoute(ReportSite $site): string
source§

The route by namespace: what each class and function issues.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 14
public function fileRoute(ReportSite $site): string
source§

The route by file: what is written where.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 11
public function kindRoute(ReportSite $site): string
source§

The route by what a statement does.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 8
public function route(
    string $label,
    string $href,
    int $count,
    string $noun,
    string $hint,
    string $items,
): string
source§

One route, as a card: where it leads, what it is for, the entries most worth starting from, and the way to all of them.

Parameters

$labelstring
$hrefstring
$countint
$nounstring
$hintstring
$itemsstring

Returns

string
Test cases 1
Called from 4
Calls 4
public function attention(ReportSite $site): string
source§

What the analysis flagged, by rule and by the functions it flagged most.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 14
public function coverage(ReportSite $site): string
source§

How far the analysis got, as one meter whose every segment leads to the statements it counts.

Parameters

$siteReportSite

Returns

string
Test cases 1
Called from 1
Calls 12

Private surface 2§

Implementation details, listed for orientation only.

private HtmlText $text
private Palette $palette

Test cases 14§

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

Dedicated tests 12
Other tests reaching this symbol 2

Relations§

Instantiated in 1
Method calls 1