classFileIndexPage

packages/sql-catalog/src/Reporter/Html/Page/FileIndexPage.php:20

final class FileIndexPage

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

Every file the statements are written in, under the directory that holds it.

A codebase without classes is still organised, by directory and file, and that is the route through it. The listing is the tree of the source as far as the statements reach, with what was found in each file beside it.

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 29

public function render(ReportSite $site): string

source §

The body of the files listing.

Parameters

$site ReportSite

Returns

string

Test cases 2

Called from 1

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

Calls 5

method-call ReportSite::index() line 37
method-call FileIndexPage::section() line 43
method-call HtmlText::count() line 46
function-call count line 46
method-call ReportSite::files() line 46

public function section(ReportSite $site, string $directory, list<string> $files): string

source §

One directory, with the files in it.

Parameters

`$site`	`ReportSite`
`$directory`	`string`
`$files`	`list<string>`

Returns

string

Test cases 1

FileIndexPageTest::testSectionIsASortableTableOfTheDirectorysFiles calls

Called from 1

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

Calls 6

method-call ReportSite::index() line 59
method-call FileIndexPage::row() line 64
method-call HtmlText::escape() line 68
method-call HtmlText::slug() line 68
method-call HtmlText::count() line 69
function-call count line 69

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

source §

One file as a row.

Parameters

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

Returns

string

Test cases 1

FileIndexPageTest::testRowCountsWhatWasFoundInTheFile calls

Called from 1

method-call SqlCatalog\Reporter\Html\Page\FileIndexPage::section() packages/sql-catalog/src/Reporter/Html/Page/FileIndexPage.php:64

Calls 7

method-call ReportSite::index() line 83
function-call strrpos line 85
function-call count line 86
method-call HtmlText::number() line 89
method-call HtmlText::link() line 92
function-call substr line 92
method-call ReportSite::filePage() line 92

public function anchors(ReportSite $site): list<array{string, string}>

source §

The sections of the page, for the navigation.

Parameters

$site ReportSite

Returns

list<array{string, string}>

Test cases 1

FileIndexPageTest::testAnchorsNameEveryDirectory calls

Called from 1

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

Calls 3

function-call array_keys line 103
method-call ReportSite::index() line 103
method-call HtmlText::slug() line 105

Private surface 1§

Implementation details, listed for orientation only.

private HtmlText $text

Test cases 7§

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

Dedicated tests 5

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:86

Method calls 2