classUnit

packages/requirements/src/Source/Unit.php:20

final class Unit

Public API: explicitly declared with @visibility public.

A complete unit of source text at a stable location, such as a paragraph or a line.

Normalizing whitespace the way quotations are compareddoctest

\Requirements\Source\Unit::normalize("  Names\n\tstart  with a letter. ") // => 'Names start with a letter.'

Identifying a unit within its sourcedoctest

$unit = new \Requirements\Source\Unit('line:1', 'Names start with a letter.');
    strlen($unit->key(new \Requirements\Model\Source('notes', 'notes.txt', 'text', 'lines:1'))) // => 64

Properties§

public string $location

source §

public string $text

source §

Methods§

public function __construct(public string $location, public string $text)

source §

Parameters

`$location`	`string`	The stable location of the unit within its source
`$text`	`string`	The complete normalized text of the unit

public function key(Source $source): string

source §

Identifies the unit by its source URI, format and location.

Parameters

$source Source The source the unit belongs to

Returns

string The SHA-256 hex digest identifying the unit

Test cases 16

Calls 1

function-call hash line 39

public static function normalize(string $text): string

source §

Collapses whitespace, including no-break spaces, and trims the text.

Parameters

$text string The text

Returns

string The normalized text

Test cases 1

UnitTest::testNormalize calls

Called from 9

Calls 2

function-call trim line 51
function-call preg_replace line 51

Test cases 72§

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

Dedicated tests 4

Other tests reaching this symbol 68

Relations§

Instantiated in 3

Static calls 9

Type declarations 2