classHtmlText

packages/sql-catalog/src/Reporter/Html/HtmlText.php:12

final class HtmlText

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

The text primitives every page of the report is written with.

Methods§

public function escape(string $text): string

source §

Text made safe to place inside the document.

Parameters

$text string

Returns

string

Test cases 1

HtmlTextTest::testEscapeMakesTextSafeForTheDocument calls

Called from 93

Calls 1

function-call htmlspecialchars line 19

public function chip(string $text, string $role = '', string $title = ''): string

source §

One labelled chip, tinted by the tone named in the class.

Parameters

`$text`	`string`
`$role`	`string`	The role classes the chip carries, such as `tone-blue` or `chip-ghost`
`$title`	`string`

Returns

string

Test cases 1

HtmlTextTest::testChipCarriesItsRoleAndTitle calls

Called from 10

Calls 1

method-call HtmlText::escape() line 29

public function chipLink(
    string $text,
    string $href,
    string $role = '',
    string $title = '',
): string

source §

One chip that is also a link.

Parameters

`$text`	`string`
`$href`	`string`
`$role`	`string`
`$title`	`string`

Returns

string

Test cases 1

HtmlTextTest::testChipLinkIsAChipThatLeadsSomewhere calls

Called from 5

Calls 1

method-call HtmlText::escape() line 39

public function chipCount(string $text, string $href, int $count, string $role = ''): string

source §

One chip that is a link and carries how many it stands for.

Parameters

`$text`	`string`
`$href`	`string`
`$count`	`int`
`$role`	`string`

Returns

string

Test cases 1

HtmlTextTest::testChipCountCarriesHowManyTheChipStandsFor calls

Called from 3

Calls 2

method-call HtmlText::escape() line 49
method-call HtmlText::number() line 50

public function link(string $text, string $href, string $class = ''): string

source §

One link.

Parameters

`$text`	`string`
`$href`	`string`
`$class`	`string`

Returns

string

Test cases 1

HtmlTextTest::testLinkEscapesItsTextAndAddress calls

Called from 28

Calls 1

method-call HtmlText::escape() line 58

public function marked(string $name): string

source §

A name with every gap in it marked, the way a gap in a statement is.

Parameters

$name string

Returns

string

Test cases 1

HtmlTextTest::testMarkedMarksEveryGapInAName calls

Called from 2

Calls 2

function-call str_replace line 67
method-call HtmlText::escape() line 70

public function number(int $value): string

source §

A count written the way a reader scans it.

Parameters

$value int

Returns

string

Test cases 1

HtmlTextTest::testNumberIsWrittenForScanning calls

Called from 22

Calls 1

function-call number_format line 79

public function noun(int $value, string $noun): string

source §

The noun a count is written with, singular or plural.

Parameters

`$value`	`int`
`$noun`	`string`

Returns

string

Test cases 1

HtmlTextTest::testNounAgreesWithTheCount calls

Called from 2

public function plural(int $value, string $noun): string

source §

A count with the noun it counts, singular or plural.

Parameters

`$value`	`int`
`$noun`	`string`

Returns

string

Test cases 1

HtmlTextTest::testPluralAgreesWithTheCount calls

Called from 13

Calls 2

method-call HtmlText::number() line 95
method-call HtmlText::noun() line 95

public function percent(int $value, int $total): string

source §

A share of a total, as a percentage with no decimals.

Parameters

`$value`	`int`
`$total`	`int`

Returns

string

Test cases 1

HtmlTextTest::testPercentIsWholeAndSafeOnZero calls

Called from 1

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

Calls 1

function-call round line 103

public function slug(string $text): string

source §

A string turned into something that can be written as an identifier.

Parameters

$text string

Returns

string

Test cases 1

HtmlTextTest::testSlugIsWritableAsAnIdentifier calls

Called from 8

Calls 3

function-call strtolower line 111
function-call preg_replace line 111
function-call trim line 113

public function collapse(string $text): string

source §

Text with every run of whitespace written as one space.

Parameters

$text string

Returns

string

Test cases 1

HtmlTextTest::testCollapseWritesEveryRunOfWhitespaceAsOneSpace calls

Called from 1

method-call SqlCatalog\Reporter\Html\HtmlText::truncate() packages/sql-catalog/src/Reporter/Html/HtmlText.php:129

Calls 2

function-call trim line 121
function-call preg_replace line 121

public function truncate(string $text, int $length): string

source §

Text shortened to fit, with an ellipsis where it was cut.

Parameters

`$text`	`string`
`$length`	`int`

Returns

string

Test cases 1

HtmlTextTest::testTruncateCollapsesAndCuts calls

Called from 2

Calls 3

method-call HtmlText::collapse() line 129
function-call strlen line 131
function-call substr line 131

public function count(int $value, string $noun = ''): string

source §

A count beside a label, the way a heading carries one.

Parameters

`$value`	`int`
`$noun`	`string`

Returns

string

Test cases 1

HtmlTextTest::testCountIsWrittenBesideAHeading calls

Called from 21

Calls 3

Test cases 33§

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

Dedicated tests 14

Other tests reaching this symbol 19

Relations§

Instantiated in 17

Method calls 193

Type declarations 34