classTableName

packages/sql-catalog/src/Reporter/Html/TableName.php:18

final class TableName

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

A table name as the report reads it: the schema it is qualified with, and how much of it is known.

A statement whose table was assembled from a value the analyzer could not follow names its table with a gap in it. The report still groups by that name — every statement on {$}posts belongs together — but it says which part of the name is known and which is not, and it gives a table that is nothing but a gap a label a reader can understand.

Constants§

public const GAP = '{$}'

source §

The marker a gap in a name is written as.

Properties§

public string $name

source §

Methods§

public function __construct(public string $name)

source §

Reads a table name as the catalog wrote it.

Parameters

$name string

public function schema(): ?string

source §

The schema the name is qualified with, or null when it is not.

A qualifier that is itself a gap is no schema a reader can browse to, so it is read as no qualifier at all.

Returns

?string

Test cases 1

TableNameTest::testSchemaIsTheQualifierWhenOneIsKnown calls

Called from 1

method-call SqlCatalog\Reporter\Html\Page\TableIndexPage::bySchema() packages/sql-catalog/src/Reporter/Html/Page/TableIndexPage.php:70

Calls 4

function-call strpos line 40
function-call substr line 44
function-call str_contains line 46
class-const TableName::GAP() line 46

public function local(): string

source §

The name without its schema.

Returns

string

Test cases 1

TableNameTest::testLocalDropsTheSchema calls

Calls 2

function-call strrpos line 54
function-call substr line 56

public function hasGap(): bool

source §

Whether any part of the name is a value the analyzer could not pin down.

Returns

bool

Test cases 1

TableNameTest::testHasGapSaysWhetherPartOfTheNameIsUnknown calls

Calls 2

function-call str_contains line 64
class-const TableName::GAP() line 64

public function isUnknown(): bool

source §

Whether nothing of the name is known.

Returns

bool

Test cases 1

TableNameTest::testIsUnknownOnlyWhenNothingOfTheNameIsKnown calls

Called from 5

Calls 1

class-const TableName::GAP() line 72

public function label(): string

source §

The name written for a reader.

Returns

string

Test cases 1

TableNameTest::testLabelExplainsAWhollyUnknownName calls

Called from 12

Calls 1

method-call TableName::isUnknown() line 80

Test cases 20§

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 15

ReporterInterfaceTest calls
HtmlReporterTest calls
ClassPageTest calls
FileIndexPageTest calls
FilePageTest calls
FindingPageTest calls
NamespacePageTest calls
OverviewPageTest calls
StatementIndexPageTest calls
StatementPageTest calls
TableIndexPageTest calls
TablePageTest::testSummaryIsSilentAboutFindingsWhenThereAreNone calls
TablePageTest::testSummaryMentionsWhatNeedsAttention calls
PageShellTest calls
StatementListTest calls

Relations§

Instantiated in 13

Method calls 17

Type declarations 1

type SqlCatalog\Reporter\Html\Page\TablePage packages/sql-catalog/src/Reporter/Html/Page/TablePage.php:69