github.com

classTablePage

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

One table: what reads it, what writes it, what alters it, and from where.

This is the page opened before a column is renamed or an index dropped. The writes are listed before the reads because they are the ones a schema change breaks first, and the functions issuing them are listed by themselves because the places to edit matter as much as the statements.

Constants§

public const GROUPS = ['writes' => 'Writes', 'reads' => 'Reads', 'schema' => 'Schema changes', 'other…
source§

The groups a table's statements are listed in, in order.

Methods§

public function __construct(?HtmlText $text = null, ?StatementList $list = null)
source§

Wires the page to the rendering it is written with.

Parameters

$text?HtmlText
$list?StatementList
Calls 2
public function summary(
    TableName $name,
    array{reads: int, writes: int, schema: int, other: int, attention: int} $usage,
): string
source§

How the table is used, in one sentence.

Parameters

$nameTableName
$usagearray{reads: int, writes: int, schema: int, other: int, attention: int}

Returns

string
Test cases 2
Called from 1
Calls 3
public function usedFrom(ReportSite $site, list<CatalogEntry> $entries): string
source§

The functions issuing statements on the table, most first.

Parameters

$siteReportSite
$entrieslist<CatalogEntry>

Returns

string
Test cases 1
Called from 1
Calls 10
public function verbs(array{reads: int, writes: int, schema: int, other: int, attention: int} $usage): string
source§

What a set of statements does to the table, as a short phrase.

Parameters

$usagearray{reads: int, writes: int, schema: int, other: int, attention: int}

Returns

string
Test cases 1
Called from 1
Calls 1
public function alongside(ReportSite $site, string $table): string
source§

The tables named in the same statements, most often first.

Parameters

$siteReportSite
$tablestring

Returns

string
Test cases 1
Called from 1
Calls 5
public function groups(ReportSite $site, string $table, list<CatalogEntry> $entries): string
source§

The statements in the groups a schema change is reasoned about in.

Parameters

$siteReportSite
$tablestring
$entrieslist<CatalogEntry>

Returns

string
Test cases 1
Called from 1
Calls 7
public function context(
    ReportSite $site,
    string $table,
): list<array{string, list<array{string, string, int|null, bool}>, string|null}>
source§

What the page is best left from: the other tables, and its own sections.

Parameters

$siteReportSite
$tablestring

Returns

list<array{string, list<array{string, string, int|null, bool}>, string|null}>
Test cases 2
Called from 1
Calls 7
public function anchors(CatalogIndex $index, string $table): list<array{string, string}>
source§

The sections of the page, for the navigation.

Parameters

$indexCatalogIndex
$tablestring

Returns

list<array{string, string}>
Test cases 1
Called from 1
Calls 4

Private surface 2§

Implementation details, listed for orientation only.

private HtmlText $text
private StatementList $list

Test cases 13§

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

Dedicated tests 10
Other tests reaching this symbol 3

Relations§

Instantiated in 1
Method calls 2