classSourceCode

packages/sql-catalog/src/Reporter/Html/Source/SourceCode.php:16

final class SourceCode

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

The analyzed PHP source, with numbered lines and the database calls marked.

Constants§

public const CONTEXT = 8

source §

The lines shown before and after a call on its statement page.

Methods§

public function __construct(?HtmlText $text = null)

source §

Wires source rendering to the escaping used throughout the report.

Parameters

$text ?HtmlText

Calls 1

new HtmlText line 30

public function excerpt(ReportSite $site, CatalogEntry $entry): string

source §

A call's surrounding code, linked to the complete file at the same line.

Parameters

`$site`	`ReportSite`
`$entry`	`CatalogEntry`

Returns

string

Test cases 3

Called from 1

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

Calls 9

method-call ReportSite::catalog() line 38
function-call max line 42
class-const SourceCode::CONTEXT() line 42
function-call array_slice line 44
method-call SourceCode::split() line 44
method-call ReportSite::filePage() line 45
method-call HtmlText::escape() line 48
method-call HtmlText::link() line 49
method-call SourceCode::lines() line 50

public function file(ReportSite $site, string $file): string

source §

A file's complete source, including files that could not be parsed.

Parameters

`$site`	`ReportSite`
`$file`	`string`

Returns

string

Test cases 1

SourceCodeTest::testFileIncludesAllLinesAndMarksEveryCall calls

Called from 1

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

Calls 4

method-call ReportSite::catalog() line 58
method-call ReportSite::index() line 63
method-call SourceCode::lines() line 68
method-call SourceCode::split() line 68

public function lines(
    list<string> $lines,
    int $first,
    list<int> $calls,
    string $target = '',
): string

source §

Source lines with their original indentation, escaped before embedding.

Parameters

`$lines`	`list<string>`
`$first`	`int`
`$calls`	`list<int>`	The line numbers to highlight
`$target`	`string`	The full source page, or empty for links within this page

Returns

string

Test cases 1

SourceCodeTest::testLinesEscapesMarkupQuotesAndInvalidUtf8WithoutDroppingTheSource calls

Called from 2

Calls 3

function-call array_fill_keys line 81
method-call HtmlText::escape() line 85
function-call implode line 89

public function split(string $source): list<string>

source §

Lines split using PHP's newline conventions, retaining a trailing empty line.

Parameters

$source string

Returns

list<string>

Test cases 1

SourceCodeTest::testSplitPreservesEmptyLinesAndRecognizesPhpNewlines calls

Called from 2

Calls 2

function-call explode line 99
function-call str_replace line 99

Private surface 1§

Implementation details, listed for orientation only.

private HtmlText $text

Test cases 9§

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 3

Relations§

Instantiated in 2

Method calls 2