classCitation

packages/requirements/src/Config/Markdown/Citation.php:18

final class Citation

Links quoted evidence to the unit of the definition's source it quotes.

A citation links to the source resource, relative to the Markdown file for a local source, with an element-ID anchor or an exact Text Fragment that identifies the quoted unit.

Methods§

public function __construct(
    private Source $source,
    private string $file,
    private string $directory,
)

source §

Parameters

`$source`	`Source`	The definition's source
`$file`	`string`	The Markdown definition file
`$directory`	`string`	The configuration directory that the source URI resolves against

public function selector(string $url, string $quote, string|null $selector): string

source §

Derives the evidence selector from a citation link.

Parameters

`$url`	`string`	The citation link
`$quote`	`string`	The quoted text
`$selector`	`string\|null`	The selector written in a comment, if any

Returns

string The selector

Throws

InvalidInputException When the link points elsewhere, disagrees with the selector or identifies no unit

Test cases 2

Calls 11

function-call explode line 42
function-call preg_match line 44
static-call LocalPath::normalize() line 46
function-call dirname line 46
function-call rawurldecode line 46
new InvalidInputException line 48
static-call TextFragment::isFragment() line 51
static-call TextFragment::text() line 52
static-call Unit::normalize() line 52
static-call Citation::isId() line 58
function-call in_array line 63

public function validate(string $selector, string $quote): void

source §

Checks that a Text Fragment selector identifies the complete quoted HTML unit.

Parameters

`$selector`	`string`	The selector
`$quote`	`string`	The quoted text

Throws

InvalidInputException When a fragment is used outside HTML or selects other text

Test cases 2

Calls 4

static-call TextFragment::isFragment() line 79
static-call TextFragment::text() line 79
static-call Unit::normalize() line 79
new InvalidInputException line 80

public function url(string $selector, string $quote): string

source §

Creates the citation link for an evidence entry.

Parameters

`$selector`	`string`	The selector
`$quote`	`string`	The quoted text

Returns

string The link, relative to the Markdown file for a local source

Test cases 1

CitationTest::testUrlCreatesTheCitationLink calls

Calls 15

function-call explode line 94
function-call preg_match line 95
static-call LocalPath::normalize() line 96
function-call dirname line 97
function-call array_shift line 99
function-call str_repeat line 102
function-call count line 102
function-call implode line 102
function-call array_map line 102
function-call rawurlencode line 102
static-call TextFragment::isFragment() line 104
function-call in_array line 107
static-call Citation::isId() line 107
function-call substr line 108
static-call TextFragment::create() line 110

public static function isId(string $selector): bool

source §

Tells whether a selector is a single element ID.

Parameters

$selector string The selector

Returns

bool True for #id

Test cases 1

CitationTest::testIsIdTellsWhetherASelectorIsOneElementId calls

Called from 3

Calls 1

function-call preg_match line 122

Private surface 3§

Implementation details, listed for orientation only.

private Source $source

private string $file

private string $directory

Test cases 22§

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

Dedicated tests 6

Other tests reaching this symbol 16

Relations§

Instantiated in 1

new Requirements\Config\MarkdownDocument::read() packages/requirements/src/Config/MarkdownDocument.php:71

Type declarations 6