classNodes

packages/requirements/src/Config/Markdown/Nodes.php:22

final class Nodes

Reads the CommonMark nodes that cards are built from, and escapes text written back.

Methods§

public static function text(Node $node, bool $literals = false): string

source §

Returns the text of a node.

Parameters

`$node`	`Node`	The node
`$literals`	`bool`	Whether code spans keep their backticks

Returns

string The text of the node and its inline children

Throws

InvalidInputException When the node holds inline Markdown other than text, emphasis and code

Test cases 9

Called from 20

Calls 4

method-call Node::getLiteral() line 37
method-call Node::children() line 46
new InvalidInputException line 48
static-call Nodes::text() line 50

public static function items(Node $node): list<ListItem>

source §

Returns the items of a bullet list.

Parameters

$node Node The list

Returns

list<ListItem> The items

Throws

InvalidInputException When the node is not a bullet list

Test cases 4

Called from 7

Calls 4

method-call Node::getListData() line 66
class-const ListBlock::TYPE_BULLET() line 66
new InvalidInputException line 67
method-call Node::children() line 70

public static function paragraph(Node $node): Paragraph

source §

Returns the single paragraph of a list item.

Parameters

$node Node The list item

Returns

Paragraph The paragraph

Throws

InvalidInputException When the item holds anything else

Test cases 3

Called from 4

Calls 2

method-call Node::firstChild() line 90
new InvalidInputException line 92

public static function link(Node $node): Link

source §

Returns the single link of a paragraph.

Parameters

$node Node The paragraph

Returns

Link The link

Throws

InvalidInputException When the paragraph holds anything else or the destination is empty

Test cases 2

Called from 4

Calls 2

method-call Node::firstChild() line 108
new InvalidInputException line 110

public static function field(Node $node): string|null

source §

Returns the name of a bold field heading.

Parameters

$node Node The block

Returns

string|null The lowercase field name, or null when the block is not a field heading

Throws

InvalidInputException When the bold text holds unsupported inline Markdown

Test cases 2

Called from 2

Calls 3

method-call Node::firstChild() line 126
function-call strtolower line 127
static-call Nodes::text() line 127

public static function pair(Paragraph $node): array{string, string}

source §

Splits a "**name:** value" paragraph.

Parameters

$node Paragraph The paragraph

Returns

array{string, string} The name and the trimmed value

Throws

InvalidInputException When the paragraph does not start with a bold name and a colon

Test cases 2

Called from 4

Calls 9

method-call Paragraph::firstChild() line 141
new InvalidInputException line 143
static-call Nodes::text() line 145
function-call substr line 146
function-call strlen line 146
function-call str_ends_with line 147
function-call trim line 148
function-call str_starts_with line 150
function-call ltrim line 150

public static function escape(string $text): string

source §

Escapes text so Markdown reads it back unchanged.

Parameters

$text string The text

Returns

string The escaped text

Test cases 1

NodesTest::testEscapeProtectsMarkdownSyntax calls

Called from 11

Calls 1

function-call preg_replace line 165

public static function destination(string $url): string

source §

Writes a link destination, in angle brackets when it contains spaces or brackets.

Parameters

$url string The destination

Returns

string The Markdown destination

Test cases 1

NodesTest::testDestinationBracketsDestinationsThatNeedIt calls

Called from 4

Calls 2

function-call preg_match line 179
function-call str_replace line 182

public static function anchor(string $id): string

source §

Returns the heading anchor of an item ID.

Parameters

$id string The item ID

Returns

string The lowercase ID without dots

Test cases 1

NodesTest::testAnchorLowercasesAndDropsDots calls

Called from 2

Calls 2

function-call strtolower line 194
function-call str_replace line 194

Test cases 37§

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

Dedicated tests 19

Other tests reaching this symbol 18

Relations§

Static calls 54