classDocumentReader

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

final class DocumentReader

Reads configuration and definition documents written in YAML or Markdown.

A file ending in .md or .markdown is read as Markdown cards; any other file as YAML. Every document is validated against its bundled schema and any local schema it declares.

Properties§

public MarkdownDocument $markdown = new \Requirements\Config\MarkdownDocument()

source §

Methods§

public function __construct(public MarkdownDocument $markdown = new \Requirements\Config\MarkdownDocument())

source §

Parameters

$markdown MarkdownDocument Reads Markdown definitions and remembers how they were written

Calls 1

new MarkdownDocument line 25

public function read(
    string $path,
    string $kind,
    array<string, mixed> $markdown = [],
    string|null $directory = null,
): stdClass

source §

Reads and validates a document.

Parameters

`$path`	`string`	The document file
`$kind`	`string`	"config" or "definition", naming the schema
`$markdown`	`array<string, mixed>`	The markdown options
`$directory`	`string\|null`	The configuration directory; the file's directory when null

Returns

stdClass The document

Throws

InvalidInputException When the document breaks its schema or is not a mapping

JsonException When a schema cannot be decoded

ParseException When a YAML document is malformed

Test cases 12

Called from 3

Calls 8

static-call DocumentReader::isMarkdown() line 45
method-call MarkdownDocument::read() line 46
static-call Yaml::parseFile() line 47
class-const Yaml::PARSE_EXCEPTION_ON_INVALID_TYPE() line 47
class-const Yaml::PARSE_OBJECT_FOR_MAP() line 47
method-call SchemaValidator::validate() line 48
new SchemaValidator line 48
new InvalidInputException line 50

public static function isMarkdown(string $path): bool

source §

Tells whether a file is read as Markdown.

Parameters

$path string The file

Returns

bool True for the .md and .markdown extensions, in any case

Test cases 1

DocumentReaderTest::testIsMarkdownRecognizesExtensions calls

Called from 3

Calls 3

function-call in_array line 64
function-call strtolower line 64
function-call pathinfo line 64

public static function mapping(stdClass $document, string $file): array<string, mixed>

source §

Converts a read document to a mapping.

Parameters

`$document`	`stdClass`	The document
`$file`	`string`	The document file, used in the error message

Returns

array<string, mixed> The document as nested arrays

Throws

InvalidInputException When the document is not a mapping

JsonException When the document cannot be converted

Test cases 5

Called from 2

Calls 3

static-call Fields::mapping() line 80
function-call json_decode line 80
function-call json_encode line 80

public static function yaml(mixed $data): string

source §

Writes data as a formatted YAML document.

Parameters

$data mixed The document

Returns

string The YAML text

Test cases 1

DocumentReaderTest::testYamlWritesFormattedDocument calls

Called from 2

Calls 4

static-call Yaml::dump() line 92
class-const Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK() line 92
class-const Yaml::DUMP_OBJECT_AS_MAP() line 92
class-const Yaml::DUMP_EMPTY_ARRAY_AS_SEQUENCE() line 92

Test cases 34§

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

Dedicated tests 17

Other tests reaching this symbol 17

DefinitionReaderTest calls
LoaderTest calls
ReferenceTest calls
CardWriterTest calls
MarkdownDocumentTest::testReadRejectsAmbiguousOrMisleadingCardData calls
MarkdownDocumentTest::testReadRejectsInvalidStructureAndFields calls
MarkdownDocumentTest::testReadRequiresTheExperimentalOptIn calls
SchemaValidatorTest calls
ApplicationTest calls
CommandHandlerTest calls
CommandLineTest calls
ExecutorTest calls
FormatterTest calls
AnalyzerTest calls
CoverageTest calls
SnapshotTest calls
VerifierTest calls

Relations§

Instantiated in 3

Static calls 6

Method calls 3