classCardReader

final class CardReader

Reads the item cards of a Markdown definition body.

A card is an ATX "# ID" heading followed by badge rows, one statement paragraph, evidence quotations and bold field sections, in that order.

Methods§

public function __construct(private Presentation $presentation, private Citation|null $source)

`$presentation`	`Presentation`	Receives the badges, citations and links of each card
`$source`	`Citation\|null`	Resolves citations against the definition's source

public function cards(Document $document, string $body, string $file): list<stdClass>

Reads every card of a document.

`$document`	`Document`	The parsed body
`$body`	`string`	The body text, used to check the heading syntax
`$file`	`string`	The definition file

list<stdClass> The items

InvalidInputException When a heading is not written as "# ID" or a card is malformed

Test cases 5

Called from 1

Calls 5

public function card(Heading $heading, list<Node> $blocks, string $file): stdClass

Reads one card.

`$heading`	`Heading`	The heading holding the item ID
`$blocks`	`list<Node>`	The blocks up to the next heading
`$file`	`string`	The definition file

stdClass The item

InvalidInputException When the card lacks a statement or a badge, quotation or field is malformed

Test cases 4

Called from 2

Calls 13

Implementation details, listed for orientation only.

private Presentation $presentation

private Citation|null $source

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

Dedicated tests 9

Other tests reaching this symbol 6

Instantiated in 1

Method calls 1