classStatementRow

packages/sql-catalog/src/Reporter/Html/StatementRow.php:24

final class StatementRow

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

One statement as a row of a listing.

A row is a doc-ui listing row. A listing is for scanning, so a row shows the statement itself first — the SQL in doc-ui's multiline code block — and then where it is issued, with every place it names linked to the page for it. What the analyzer thinks of the statement is shown only when it is not the ordinary case: a resolved statement with nothing reported carries no state chips at all, so the ones that do stand out.

Methods§

public function __construct(
    ?HtmlText $text = null,
    ?SqlHighlighter $sql = null,
    ?Palette $palette = null,
    ?SqlFormatter $formatter = null,
)

source §

Wires the row to the text and SQL rendering it is written with.

Parameters

`$text`	`?HtmlText`
`$sql`	`?SqlHighlighter`
`$palette`	`?Palette`
`$formatter`	`?SqlFormatter`

Calls 4

public function render(
    ReportSite $site,
    string $page,
    CatalogEntry $entry,
    list<string> $omit = [],
): string

source §

The row, with its links written relative to the page it is on.

Parameters

`$site`	`ReportSite`
`$page`	`string`
`$entry`	`CatalogEntry`
`$omit`	`list<string>`	The facts the listing already states, out of `function`, `file` and `tables`

Returns

string

Test cases 1

StatementRowTest::testRenderLinksTheStatementAndWhereItIsIssuedRelativeToThePage calls

Called from 1

method-call SqlCatalog\Reporter\Html\StatementList::rows() packages/sql-catalog/src/Reporter/Html/StatementList.php:53

Calls 9

method-call ReportSite::prefixOf() line 52
method-call StatementRow::attributes() line 54
method-call HtmlText::escape() line 55
method-call ReportSite::statementPage() line 55
method-call HtmlText::chip() line 56
function-call strtoupper line 56
method-call Palette::kind() line 56
method-call StatementRow::sql() line 57
method-call StatementRow::meta() line 58

public function attributes(CatalogEntry $entry): string

source §

The facts a listing can be narrowed by, written as attributes.

Parameters

$entry CatalogEntry

Returns

string

Test cases 2

Called from 1

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

Calls 7

static-call Scope::of() line 67
method-call CatalogEntry::resolution() line 74
method-call CatalogEntry::severity() line 75
function-call implode line 76
function-call array_unique line 76
method-call CatalogEntry::searchClosed() line 78
method-call HtmlText::escape() line 87

public function sql(CatalogEntry $entry, ?SqlFormatter $formatter = null): string

source §

The formatted statement, or the call it was not read from.

Parameters

`$entry`	`CatalogEntry`
`$formatter`	`?SqlFormatter`

Returns

string

Test cases 2

Called from 1

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

Calls 6

method-call CatalogEntry::resolution() line 98
class-const Resolution::NotAnalyzed() line 98
method-call SqlHighlighter::render() line 99
method-call CatalogEntry::parts() line 99
method-call CatalogEntry::firstGap() line 101
method-call HtmlText::escape() line 104

public function meta(
    ReportSite $site,
    string $prefix,
    CatalogEntry $entry,
    list<string> $omit,
): string

source §

Where the statement is issued and what is known about the reading.

Parameters

`$site`	`ReportSite`
`$prefix`	`string`
`$entry`	`CatalogEntry`
`$omit`	`list<string>`

Returns

string

Test cases 2

Called from 1

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

Calls 15

static-call Scope::of() line 114
function-call in_array line 116
method-call HtmlText::link() line 117
method-call ReportSite::filePage() line 117
method-call ReportSite::functionUrl() line 120
method-call HtmlText::chipLink() line 124
method-call ReportSite::tablePage() line 124
method-call CatalogEntry::resolution() line 127
class-const Resolution::Resolved() line 128
method-call HtmlText::chip() line 129
method-call Palette::resolution() line 129
method-call CatalogEntry::severity() line 131
class-const Severity::Medium() line 131
method-call Palette::severity() line 132
function-call implode line 135

Private surface 4§

Implementation details, listed for orientation only.

private HtmlText $text

private SqlHighlighter $sql

private Palette $palette

private SqlFormatter $formatter

Test cases 21§

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

Dedicated tests 7

Other tests reaching this symbol 14

Relations§

Instantiated in 1

new SqlCatalog\Reporter\Html\StatementList::__construct() packages/sql-catalog/src/Reporter/Html/StatementList.php:36

Method calls 1

method-call SqlCatalog\Reporter\Html\StatementList::rows() packages/sql-catalog/src/Reporter/Html/StatementList.php:53

Type declarations 2