classDefinitionReader

packages/requirements/src/Config/DefinitionReader.php:20

final class DefinitionReader

Reads the definition files that the configuration's patterns match.

Files are read in path order; item and source IDs must be unique across them, and Markdown links to other items must point to the files that define them.

Methods§

public function read(
    string $directory,
    list<string> $patterns,
    array<string, mixed> $markdown,
): Definitions

source §

Reads every matched definition file.

Parameters

`$directory`	`string`	The configuration directory the patterns resolve against
`$patterns`	`list<string>`	Glob patterns of definition files
`$markdown`	`array<string, mixed>`	The markdown options

Returns

Definitions The items, sources and files

Throws

InvalidInputException When a pattern matches nothing, a definition is invalid or an ID repeats

JsonException When a document cannot be converted

ParseException When a YAML definition is malformed

Test cases 18

Called from 1

method-call Requirements\Config\Loader::load() packages/requirements/src/Config/Loader.php:49

Calls 15

function-call glob line 39
new InvalidInputException line 41
function-call array_push line 43
function-call array_values line 45
function-call array_unique line 45
function-call sort line 46
new DocumentReader line 54
static-call DocumentReader::mapping() line 55
method-call DocumentReader::read() line 55
static-call Fields::keys() line 57
function-call array_key_exists line 58
static-call Source::from() line 61
static-call Fields::sequence() line 65
static-call Item::from() line 66
new Definitions line 73

Test cases 31§

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

Dedicated tests 18

Other tests reaching this symbol 13

Relations§

Instantiated in 1

new Requirements\Config\Loader::load() packages/requirements/src/Config/Loader.php:49

Method calls 1

method-call Requirements\Config\Loader::load() packages/requirements/src/Config/Loader.php:49