Properties

$classes

$classes : string[]

Type

string[]

$headerNodes

$headerNodes : \phpDocumentor\Guides\Nodes\Node[]

Type

Node[]

$nodes

$nodes : \phpDocumentor\Guides\Nodes\Node[]

Type

Node[]

$options

$options : array

Type

array

$hash

$hash : string

Type

string

Methods

__construct()

__construct(string  $value) : mixed

Parameters

string $value

Returns

mixed —

getValue()

getValue() : \phpDocumentor\Guides\Nodes\Node|callable|string|null

Returns

\phpDocumentor\Guides\Nodes\Node|callable|string|null —

setValue()

setValue(\phpDocumentor\Guides\Nodes\Node|callable|string|null  $value) : void

Parameters

\phpDocumentor\Guides\Nodes\Node|callable|string|null $value

getClasses()

getClasses() : string[]

Returns

string[] —

getClassesString()

getClassesString() : string

Returns

string —

setClasses()

setClasses(string[]  $classes) : void

Parameters

string[] $classes

getValueString()

getValueString() : string

Returns

string —

withOptions()

withOptions(array<string,mixed>  $options) : self

Parameters

array $options

Returns

self —

getOptions()

getOptions() : array<string,mixed>

Returns

array

getOption()

getOption(string  $name, mixed|null  $default = null) : mixed|null

Parameters

string $name
mixed|null $default

Returns

mixed|null —

getHeaderNodes()

getHeaderNodes() : \phpDocumentor\Guides\Nodes\Node[]

Returns

\phpDocumentor\Guides\Nodes\Node[] —

getNodes()

getNodes(?callable  $function = null) : \phpDocumentor\Guides\Nodes\Node[]

Parameters

?callable $function

Returns

\phpDocumentor\Guides\Nodes\Node[] —

getTitle()

getTitle() : ?\phpDocumentor\Guides\Nodes\TitleNode

Returns

?\phpDocumentor\Guides\Nodes\TitleNode —

getTocs()

getTocs() : \phpDocumentor\Guides\Nodes\TocNode[]

Returns

\phpDocumentor\Guides\Nodes\TocNode[] —

getTitles()

getTitles() : string[][]

Returns

string[][] —

addNode()

addNode(string|\phpDocumentor\Guides\Nodes\Node  $node) : void

Parameters

string|\phpDocumentor\Guides\Nodes\Node $node

prependNode()

prependNode(\phpDocumentor\Guides\Nodes\Node  $node) : void

Parameters

\phpDocumentor\Guides\Nodes\Node $node

addHeaderNode()

addHeaderNode(\phpDocumentor\Guides\Nodes\Node  $node) : void

Parameters

\phpDocumentor\Guides\Nodes\Node $node

getHash()

getHash() : string

Returns

string —

normalizeLines()

normalizeLines(string[]  $lines) : string

Parameters

string[] $lines

Returns

string —