phpDocumentor

DocumentNode extends Node
in package

Table of Contents

$classes  : array<string|int, string>
$headerNodes  : array<string|int, Node>
$nodes  : array<string|int, Node>
$value  : Node|callable|string|null
$hash  : string
$options  : array<string|int, mixed>
__construct()  : mixed
addHeaderNode()  : void
addNode()  : void
getClasses()  : array<string|int, string>
getClassesString()  : string
getHash()  : string
getHeaderNodes()  : array<string|int, Node>
getNodes()  : array<string|int, Node>
getOption()  : mixed|null
getOptions()  : array<string, mixed>
getTitle()  : TitleNode|null
getTitles()  : array<string|int, array<string|int, string>>
getTocs()  : array<string|int, TocNode>
getValue()  : Node|callable|string|null
getValueString()  : string
prependNode()  : void
setClasses()  : void
setValue()  : void
withOptions()  : self
normalizeLines()  : string

Properties

$classes

protected array<string|int, string> $classes = []

$value

protected Node|callable|string|null $value

$options

private array<string|int, mixed> $options

Methods

__construct()

public __construct(string $value) : mixed
Parameters
$value : string
Return values
mixed

addHeaderNode()

public addHeaderNode(Node $node) : void
Parameters
$node : Node
Return values
void

addNode()

public addNode(string|Node $node) : void
Parameters
$node : string|Node
Return values
void

getClasses()

public getClasses() : array<string|int, string>
Return values
array<string|int, string>

getClassesString()

public getClassesString() : string
Return values
string

getHash()

public getHash() : string
Return values
string

getHeaderNodes()

public getHeaderNodes() : array<string|int, Node>
Return values
array<string|int, Node>

getNodes()

public getNodes([callable|null $function = null ]) : array<string|int, Node>
Parameters
$function : callable|null = null
Return values
array<string|int, Node>

getOption()

public getOption(string $name[, mixed|null $default = null ]) : mixed|null
Parameters
$name : string
$default : mixed|null = null
Return values
mixed|null

getOptions()

public getOptions() : array<string, mixed>
Return values
array<string, mixed>

getTitles()

public getTitles() : array<string|int, array<string|int, string>>
Return values
array<string|int, array<string|int, string>>

getValue()

public getValue() : Node|callable|string|null
Return values
Node|callable|string|null

getValueString()

public getValueString() : string
Return values
string

prependNode()

public prependNode(Node $node) : void
Parameters
$node : Node
Return values
void

setClasses()

public setClasses(array<string|int, string> $classes) : void
Parameters
$classes : array<string|int, string>
Return values
void

setValue()

public setValue(Node|callable|string|null $value) : void
Parameters
$value : Node|callable|string|null
Return values
void

withOptions()

public withOptions(array<string, mixed> $options) : self
Parameters
$options : array<string, mixed>
Return values
self

normalizeLines()

protected normalizeLines(array<string|int, string> $lines) : string
Parameters
$lines : array<string|int, string>
Return values
string

Search results