classTableIndexPage

packages/sql-catalog/src/Reporter/Html/Page/TableIndexPage.php:23

final class TableIndexPage

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

Every table the catalog names, with how each is used.

A table is the unit a schema change is made in, so the listing answers the question that precedes one: how much reads this, how much writes it, and how much of that the analysis is unsure about. Tables qualified with a schema are listed under it, so a catalog spanning databases reads database by database.

Methods§

public function __construct(?HtmlText $text = null)

source §

Wires the page to the escaping it writes through.

Parameters

$text ?HtmlText

Calls 1

new HtmlText line 32

public function render(ReportSite $site): string

source §

The body of the tables listing.

Parameters

$site ReportSite

Returns

string

Test cases 3

Called from 1

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

Calls 7

method-call ReportSite::index() line 40
method-call TableIndexPage::bySchema() line 44
function-call count line 48
method-call HtmlText::escape() line 48
method-call HtmlText::slug() line 48
method-call HtmlText::count() line 49
method-call TableIndexPage::table() line 50

public function bySchema(array<string, list<CatalogEntry>> $tables): array<string, array<string, list<CatalogEntry>>>

source §

The tables under each schema, the unqualified ones under an empty name.

Parameters

$tables array<string, list<CatalogEntry>>

Returns

array<string, array<string, list<CatalogEntry>>>

Test cases 1

TableIndexPageTest::testBySchemaPutsUnqualifiedTablesUnderAnEmptyName calls

Called from 1

method-call SqlCatalog\Reporter\Html\Page\TableIndexPage::render() packages/sql-catalog/src/Reporter/Html/Page/TableIndexPage.php:44

Calls 3

method-call TableName::schema() line 70
new TableName line 70
function-call ksort line 72

public function table(ReportSite $site, array<string, list<CatalogEntry>> $tables): string

source §

One listing of tables, sortable by any column.

Parameters

`$site`	`ReportSite`
`$tables`	`array<string, list<CatalogEntry>>`

Returns

string

Test cases 1

TableIndexPageTest::testTableIsSortableByEveryColumn calls

Called from 1

method-call SqlCatalog\Reporter\Html\Page\TableIndexPage::render() packages/sql-catalog/src/Reporter/Html/Page/TableIndexPage.php:50

Calls 1

method-call TableIndexPage::row() line 86

public function row(ReportSite $site, string $table, list<CatalogEntry> $entries): string

source §

One table as a row.

Parameters

`$site`	`ReportSite`
`$table`	`string`
`$entries`	`list<CatalogEntry>`

Returns

string

Test cases 1

TableIndexPageTest::testRowCountsHowTheTableIsUsedAndMarksAGapInItsName calls

Called from 1

method-call SqlCatalog\Reporter\Html\Page\TableIndexPage::table() packages/sql-catalog/src/Reporter/Html/Page/TableIndexPage.php:86

Calls 9

method-call ReportSite::index() line 103
new TableName line 105
function-call count line 106
method-call HtmlText::number() line 109
method-call TableName::isUnknown() line 112
method-call HtmlText::escape() line 112
method-call ReportSite::tablePage() line 112
method-call TableName::label() line 113
method-call HtmlText::marked() line 113

Private surface 1§

Implementation details, listed for orientation only.

private HtmlText $text

Test cases 8§

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

Dedicated tests 6

Other tests reaching this symbol 2

ReporterInterfaceTest calls
HtmlReporterTest calls

Relations§

Instantiated in 1

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

Method calls 1

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