classItem

packages/requirements/src/Model/Item.php:17

final class Item

A requirement or specification with its source evidence, links and disposition.

Requirements are optional upstream records quoted from a source; specifications are EARS statements that claim evidence directly or through requirements, link tests, or declare an independent origin with a reason.

Properties§

public string $id

source §

public string $kind

source §

public string $statement

source §

public string $status

source §

public Source|null $source

source §

public list<Excerpt> $evidence

source §

public list<TestReference> $tests

source §

public list<string> $requirements

source §

public list<string> $labels

source §

public string $category

source §

public string $origin

source §

public string $reason

source §

public string $file

source §

public array<string, mixed> $data

source §

Methods§

public function __construct(
    public string $id,
    public string $kind,
    public string $statement,
    public string $status,
    public Source|null $source,
    public list<Excerpt> $evidence,
    public list<TestReference> $tests,
    public list<string> $requirements,
    public list<string> $related,
    public list<string> $labels,
    public string $category,
    public string $origin,
    public string $reason,
    public string $file,
    public array<string, mixed> $data,
)

source §

Parameters

`$id`	`string`	The item ID
`$kind`	`string`	"requirement" or "specification"
`$statement`	`string`	The requirement text or EARS statement
`$status`	`string`	"supported" or "unsupported"
`$source`	`Source\|null`	The source of the item's definition file
`$evidence`	`list<Excerpt>`	The quoted source units
`$tests`	`list<TestReference>`	The linked tests
`$requirements`	`list<string>`	The IDs of the requirements it refines
`$related`	`list<string>`	The IDs of related items
`$labels`	`list<string>`	Free-form labels
`$category`	`string`	The category, or an empty string
`$origin`	`string`	"sourced", "original" or "undocumented"
`$reason`	`string`	Why the item is unsupported or independent
`$file`	`string`	The definition file declaring the item
`$data`	`array<string, mixed>`	The item as written, including design and metadata

public static function from(mixed $value, Source|null $source, string $file): self

source §

Reads and validates an item of a definition.

Parameters

`$value`	`mixed`	The decoded item
`$source`	`Source\|null`	The source of the definition file
`$file`	`string`	The definition file

Returns

self The item

Throws

InvalidInputException When a field is invalid or the item breaks a disposition rule

Test cases 5

Called from 1

static-call Requirements\Config\DefinitionReader::read() packages/requirements/src/Config/DefinitionReader.php:66

Calls 11

static-call Fields::mapping() line 68
static-call Fields::keys() line 69
new self line 70
static-call Fields::text() line 71
function-call array_map line 76
static-call Excerpt::from() line 76
static-call Fields::sequence() line 76
static-call TestReference::from() line 77
static-call Fields::strings() line 78
method-call ItemValidator::validate() line 87
new ItemValidator line 87

Test cases 76§

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 71

Relations§

Static calls 1

static-call Requirements\Config\DefinitionReader::read() packages/requirements/src/Config/DefinitionReader.php:66

Type declarations 7