classPalette

packages/sql-catalog/src/Reporter/Html/Palette.php:26

final class Palette

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

Which hue each fact about a statement is written in.

The hues are doc-ui's tones. What a statement does and what the analyzer managed to establish about it are two different things, and the report keeps them apart by hue. The kind carries an identity tone — blue, teal, violet, pink, indigo, slate — because it is a property of the statement; the resolution and the findings carry state tones — ok, warn, danger, neutral — because they are judgements about the reading. A search the analyzer left open is the common case in a real application, so it is written quietly, as an outline, and the loud tones are kept for what is rare and worth a look: input from outside the program, and a finding of some severity.

Constants§

public const OPEN = 'chip-ghost'

source §

The quiet writing of a state that is ordinary: an outline with no tint.

Methods§

public function kind(string $kind): string

source §

The identity tone a statement of that kind is written in.

Parameters

$kind string

Returns

string

Test cases 1

PaletteTest::testKindWritesEachKindInItsOwnHue calls

Called from 5

Calls 1

method-call Palette::kindGroup() line 38

public function kindGroup(string $kind): string

source §

The group a kind is coloured as, which is also how the report sections a table's statements.

Parameters

$kind string

Returns

string

Test cases 1

PaletteTest::testKindGroupFallsBackForAKindItDoesNotKnow calls

Called from 1

method-call SqlCatalog\Reporter\Html\Palette::kind() packages/sql-catalog/src/Reporter/Html/Palette.php:38

public function resolution(Resolution $resolution): string

source §

The state tone a resolution is written in.

Parameters

$resolution Resolution

Returns

string

Test cases 1

PaletteTest::testResolutionWritesTheStateOfTheReading calls

Called from 4

Calls 6

class-const Resolution::Resolved() line 69
class-const Resolution::ExternalInput() line 70
class-const Resolution::IncompleteModel() line 71
class-const Resolution::Incomplete() line 71
class-const Palette::OPEN() line 71
class-const Resolution::NotAnalyzed() line 72

public function severity(Severity $severity): string

source §

The state tone a severity is written in.

Parameters

$severity Severity

Returns

string

Test cases 1

PaletteTest::testSeverityWritesHowMuchAttentionIsWanted calls

Called from 5

Calls 4

public function bar(string $chipRole): string

source §

The class a segment of a meter carries for a chip role.

A tone is a tone on a meter as on a chip; the quiet outline of an open search is a hatched segment, which is how doc-ui draws what is not settled.

Parameters

$chipRole string

Returns

string

Test cases 1

PaletteTest::testBarKeepsAToneAndHatchesAnOpenSearch calls

Called from 1

method-call SqlCatalog\Reporter\Html\Page\OverviewPage::coverage() packages/sql-catalog/src/Reporter/Html/Page/OverviewPage.php:240

Calls 1

class-const Palette::OPEN() line 97

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

Relations§

Instantiated in 5

Method calls 15

Type declarations 10