classStatementList
final class StatementList
A listing of statements that a reader can narrow down on the page.
Every listing in the report is the same component, doc-ui's listing with its facets: the rows, and above them the facets the rows can be narrowed by — what the statements do, how far the analysis got, and how much attention they need — each showing how many rows it would keep. A facet that every row shares is not offered, since choosing it would change nothing.
Methods§
public function __construct(
?HtmlText $text = null,
?StatementRow $row = null,
?Palette $palette = null,
)Wires the listing to the row and text rendering it is written with.
Parameters
$text | ?HtmlText | |
$row | ?StatementRow | |
$palette | ?Palette |
public function rows(
ReportSite $site,
string $page,
list<CatalogEntry> $entries,
list<string> $omit = [],
): stringThe rows of a listing.
Parameters
$site | ReportSite | |
$page | string | |
$entries | list<CatalogEntry> | |
$omit | list<string> | The facts the listing already states, out of `function`, `file` and `tables` |
Returns
stringTest cases 1
Called from 7
- method-call SqlCatalog\Reporter\Html\Page\ClassPage::sections() packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:110
- method-call SqlCatalog\Reporter\Html\Page\FilePage::sections() packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:123
- method-call SqlCatalog\Reporter\Html\Page\FindingPage::section() packages/sql-catalog/src/Reporter/Html/Page/FindingPage.php:102
- method-call SqlCatalog\Reporter\Html\Page\StatementIndexPage::render() packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:50
- method-call SqlCatalog\Reporter\Html\Page\StatementPage::related() packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:310
- method-call SqlCatalog\Reporter\Html\Page\StatementPage::related() packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:321
- method-call SqlCatalog\Reporter\Html\Page\TablePage::groups() packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:165
Calls 1
- method-call StatementRow::render() line 53
public function facets(list<CatalogEntry> $entries): stringThe facets a listing can be narrowed by, with a search over its rows.
Parameters
$entries | list<CatalogEntry> |
Returns
stringTest cases 2
Called from 4
- method-call SqlCatalog\Reporter\Html\Page\ClassPage::render() packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:59
- method-call SqlCatalog\Reporter\Html\Page\FilePage::render() packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:54
- method-call SqlCatalog\Reporter\Html\Page\StatementIndexPage::render() packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:48
- method-call SqlCatalog\Reporter\Html\Page\TablePage::render() packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:61
Calls 7
- function-call
arsortline 76 - method-call StatementList::group() line 82
- method-call Palette::kind() line 82
- method-call Palette::resolution() line 83
- static-call Resolution::from() line 83
- method-call Palette::severity() line 84
- static-call Severity::from() line 84
public function group(
string $facet,
array<string, int> $counts,
callable(string): string $role,
callable(string): string|null $label = null,
): stringOne facet, as a chip per value with how many rows it keeps.
Parameters
$facet | string | |
$counts | array<string, int> | |
$role | callable(string): string | |
$label | callable(string): string|null |
Returns
stringTest cases 1
Called from 3
- method-call SqlCatalog\Reporter\Html\StatementList::facets() packages/sql-catalog/src/Reporter/Html/StatementList.php:82
- method-call SqlCatalog\Reporter\Html\StatementList::facets() packages/sql-catalog/src/Reporter/Html/StatementList.php:83
- method-call SqlCatalog\Reporter\Html\StatementList::facets() packages/sql-catalog/src/Reporter/Html/StatementList.php:84
Calls 3
- function-call
countline 99 - method-call HtmlText::escape() line 104
- method-call HtmlText::number() line 107
Private surface 3§
Implementation details, listed for orientation only.
private HtmlText $textprivate StatementRow $rowprivate Palette $paletteTest cases 17§
Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.
Dedicated tests 4
Other tests reaching this symbol 13
ReporterInterfaceTestcallsHtmlReporterTestcallsClassPageTestcallsFileIndexPageTestcallsFilePageTestcallsFindingPageTestcallsNamespacePageTestcallsOverviewPageTestcallsStatementIndexPageTestcallsStatementPageTestcallsTableIndexPageTestcallsTablePageTestcallsPageShellTestcalls
Relations§
Instantiated in 6
- new SqlCatalog\Reporter\Html\Page\ClassPage::__construct() packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:36
- new SqlCatalog\Reporter\Html\Page\FilePage::__construct() packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:37
- new SqlCatalog\Reporter\Html\Page\FindingPage::__construct() packages/sql-catalog/src/Reporter/Html/Page/FindingPage.php:38
- new SqlCatalog\Reporter\Html\Page\StatementIndexPage::__construct() packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:34
- new SqlCatalog\Reporter\Html\Page\StatementPage::__construct() packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:67
- new SqlCatalog\Reporter\Html\Page\TablePage::__construct() packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:42
Method calls 11
- method-call SqlCatalog\Reporter\Html\Page\ClassPage::render() packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:59
- method-call SqlCatalog\Reporter\Html\Page\ClassPage::sections() packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:110
- method-call SqlCatalog\Reporter\Html\Page\FilePage::render() packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:54
- method-call SqlCatalog\Reporter\Html\Page\FilePage::sections() packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:123
- method-call SqlCatalog\Reporter\Html\Page\FindingPage::section() packages/sql-catalog/src/Reporter/Html/Page/FindingPage.php:102
- method-call SqlCatalog\Reporter\Html\Page\StatementIndexPage::render() packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:48
- method-call SqlCatalog\Reporter\Html\Page\StatementIndexPage::render() packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:50
- method-call SqlCatalog\Reporter\Html\Page\StatementPage::related() packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:310
- method-call SqlCatalog\Reporter\Html\Page\StatementPage::related() packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:321
- method-call SqlCatalog\Reporter\Html\Page\TablePage::render() packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:61
- method-call SqlCatalog\Reporter\Html\Page\TablePage::groups() packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:165
Type declarations 12
- type SqlCatalog\Reporter\Html\Page\ClassPage packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:28
- type SqlCatalog\Reporter\Html\Page\ClassPage packages/sql-catalog/src/Reporter/Html/Page/ClassPage.php:33
- type SqlCatalog\Reporter\Html\Page\FilePage packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:29
- type SqlCatalog\Reporter\Html\Page\FilePage packages/sql-catalog/src/Reporter/Html/Page/FilePage.php:34
- type SqlCatalog\Reporter\Html\Page\FindingPage packages/sql-catalog/src/Reporter/Html/Page/FindingPage.php:28
- type SqlCatalog\Reporter\Html\Page\FindingPage packages/sql-catalog/src/Reporter/Html/Page/FindingPage.php:35
- type SqlCatalog\Reporter\Html\Page\StatementIndexPage packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:26
- type SqlCatalog\Reporter\Html\Page\StatementIndexPage packages/sql-catalog/src/Reporter/Html/Page/StatementIndexPage.php:31
- type SqlCatalog\Reporter\Html\Page\StatementPage packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:50
- type SqlCatalog\Reporter\Html\Page\StatementPage packages/sql-catalog/src/Reporter/Html/Page/StatementPage.php:61
- type SqlCatalog\Reporter\Html\Page\TablePage packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:34
- type SqlCatalog\Reporter\Html\Page\TablePage packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:39