phpDocumentor

DocumentNode extends Node
in package

Table of Contents

$classes  : array<string|int, string>
$environment  : Environment
$headerNodes  : array<string|int, Node>
$nodes  : array<string|int, Node>
$value  : Node|string|null
$nodeRendererFactory  : NodeRendererFactory|null
__construct()  : mixed
addCss()  : void
addFavicon()  : void
addHeaderNode()  : void
addJs()  : void
addNode()  : void
getClasses()  : array<string|int, string>
getClassesString()  : string
getEnvironment()  : Environment
getHeaderNodes()  : array<string|int, Node>
getNodes()  : array<string|int, Node>
getTitle()  : string|null
getTitles()  : array<string|int, array<string|int, string>>
getTocs()  : array<string|int, mixed>
getValue()  : Node|string|null
getValueString()  : string
prependNode()  : void
render()  : string
renderDocument()  : string
setClasses()  : void
setEnvironment()  : void
setNodeRendererFactory()  : void
setValue()  : void
doRender()  : string
doRenderDocument()  : string
getRenderer()  : NodeRenderer
normalizeLines()  : string
createDefaultRenderer()  : NodeRenderer
createRenderer()  : NodeRenderer|null
postRenderValidate()  : void

Properties

$classes

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

Methods

addCss()

public addCss(string $css) : void
Parameters
$css : string
Return values
void

addFavicon()

public addFavicon([string $url = '/favicon.ico' ]) : void
Parameters
$url : string = '/favicon.ico'
Return values
void

addHeaderNode()

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

addJs()

public addJs(string $js) : void
Parameters
$js : string
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

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>

getTitle()

public getTitle() : string|null
Return values
string|null

getTitles()

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

getTocs()

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

getValue()

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

getValueString()

public getValueString() : string
Return values
string

prependNode()

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

render()

public render() : string
Return values
string

renderDocument()

public renderDocument() : string
Return values
string

setClasses()

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

setValue()

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

doRender()

protected doRender() : string
Return values
string

doRenderDocument()

protected doRenderDocument() : string
Return values
string

normalizeLines()

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

postRenderValidate()

private postRenderValidate() : void
Return values
void

Search results