classSource

packages/requirements/src/Model/Source.php:28

final class Source

Public API: explicitly declared with @visibility public.

A source document a definition quotes, and the scope of units that coverage counts.

The URI is an HTTP(S) URL or a path relative to the configuration; a pinned snapshot is a local copy verified by its SHA-256 digest. The format names the source extension and the selector declares the coverage scope in that extension's syntax.

Declaring an HTML scopedoctest

$source = new \Requirements\Model\Source('manual', 'https://example.org/manual.html', 'html', 'main p');
    [$source->id, $source->format, $source->selector, $source->snapshot] // => ['manual', 'html', 'main p', null]

Reading the source of a definitiondoctest

$source = \Requirements\Model\Source::from(['id' => 'notes', 'uri' => 'notes.txt', 'format' => 'text', 'selector' => 'lines:1-3', 'options' => ['encoding' => 'utf-8']]);
    [$source->uri, $source->options] // => ['notes.txt', ['encoding' => 'utf-8']]

Rejecting a snapshot without its digestdoctest

\Requirements\Model\Source::from(['id' => 'manual', 'uri' => 'https://example.org/', 'format' => 'html', 'selector' => 'p', 'snapshot' => 'cache/manual.html']) // throws \Requirements\Input\InvalidInputException: SHA-256

Properties§

public string $id

source §

public string $uri

source §

public string $format

source §

public string $selector

source §

public string|null $snapshot = null

source §

public string|null $sha256 = null

source §

public array<string, mixed> $options = []

source §

Methods§

public function __construct(
    public string $id,
    public string $uri,
    public string $format,
    public string $selector,
    public string|null $snapshot = null,
    public string|null $sha256 = null,
    public array<string, mixed> $options = [],
)

source §

Parameters

`$id`	`string`	The source identifier used by coverage thresholds and reports
`$uri`	`string`	The HTTP(S) URL or local path of the document
`$format`	`string`	The source extension that reads the document
`$selector`	`string`	The coverage scope in the extension's selector syntax
`$snapshot`	`string\|null`	The local copy read instead of the URI unless live
`$sha256`	`string\|null`	The lowercase SHA-256 digest of the document
`$options`	`array<string, mixed>`	Extension-specific options

public static function from(mixed $value): self

source §

Reads the source mapping of a definition.

Parameters

$value mixed The decoded source mapping

Returns

self The source

Throws

InvalidInputException When fields are unknown or missing, or a snapshot lacks a valid digest

Test cases 6

Called from 2

Calls 6

static-call Fields::mapping() line 61
static-call Fields::keys() line 62
static-call Fields::text() line 63
function-call preg_match line 65
new InvalidInputException line 66
new self line 68

Test cases 153§

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 147

Relations§

Instantiated in 1

new Requirements\Source\ResourceLoader::read() packages/requirements/src/Source/ResourceLoader.php:67

Static calls 2

Type declarations 13