classTextReporter

packages/sql-catalog/src/Reporter/Text/TextReporter.php:18

final class TextReporter
    implements ReporterInterface

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

Writes the catalog as plain lines, for reading in a terminal.

Constants§

public const FILE = 'catalog.txt'

source §

The name the artifact is written under.

Methods§

public function name(): string

source §

The name the command line selects this reporter by.

Returns

string

Test cases 1

TextReporterTest::testNameIsHowTheCommandLineSelectsIt calls

public function description(): string

source §

What the reporter produces.

Returns

string

Test cases 1

TextReporterTest::testDescriptionMentionsWhatItProduces calls

public function render(Catalog $catalog): CatalogArtifacts

source §

The catalog rendered as plain text.

Parameters

$catalog Catalog

Returns

CatalogArtifacts

Test cases 3

Calls 7

method-call Catalog::sorted() line 50
method-call TextReporter::entryLines() line 51
function-call sprintf line 57
method-call TextReporter::summaryLine() line 60
static-call CatalogArtifacts::one() line 62
class-const TextReporter::FILE() line 62
function-call implode line 62

public function entryLines(CatalogEntry $entry): list<string>

source §

The lines one statement is written as.

Parameters

$entry CatalogEntry

Returns

list<string>

Test cases 3

Called from 1

method-call SqlCatalog\Reporter\Text\TextReporter::render() packages/sql-catalog/src/Reporter/Text/TextReporter.php:51

Calls 4

function-call sprintf line 73
function-call strtoupper line 73
method-call CatalogEntry::sql() line 75
method-call TextReporter::statusLine() line 76

public function statusLine(CatalogEntry $entry): string

source §

The line saying how far the analyzer got with a statement.

Parameters

$entry CatalogEntry

Returns

string

Test cases 2

Called from 1

method-call SqlCatalog\Reporter\Text\TextReporter::entryLines() packages/sql-catalog/src/Reporter/Text/TextReporter.php:76

Calls 4

method-call CatalogEntry::resolution() line 93
method-call CatalogEntry::searchClosed() line 94
function-call count line 100
function-call implode line 101

public function summaryLine(Catalog $catalog): string

source §

The closing line naming what the run found.

Parameters

$catalog Catalog

Returns

string

Test cases 1

TextReporterTest::testSummaryLineCountsWhatWasFound calls

Called from 1

method-call SqlCatalog\Reporter\Text\TextReporter::render() packages/sql-catalog/src/Reporter/Text/TextReporter.php:60

Calls 4

function-call count line 116
function-call sprintf line 119
method-call Catalog::count() line 121
method-call Catalog::problems() line 124

Test cases 17§

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

Dedicated tests 11

Other tests reaching this symbol 6

Relations§

Instantiated in 1

new SqlCatalog\Facade\Builtins::reporters() packages/sql-catalog/src/Facade/Builtins.php:45