phpDocumentor

TocNode extends Node
in package

Table of Contents

DEFAULT_DEPTH  = 2
$classes  : array<string|int, string>
$environment  : Environment
$files  : array<string|int, string>
$options  : array<string|int, string>
$value  : Node|string|null
$nodeRendererFactory  : NodeRendererFactory|null
__construct()  : mixed
getClasses()  : array<string|int, string>
getClassesString()  : string
getDepth()  : int
getEnvironment()  : Environment
getFiles()  : array<string|int, string>
getOptions()  : array<string|int, string>
getValue()  : Node|string|null
getValueString()  : string
render()  : string
setClasses()  : void
setEnvironment()  : void
setNodeRendererFactory()  : void
setValue()  : void
doRender()  : string
getRenderer()  : NodeRenderer
normalizeLines()  : string
createDefaultRenderer()  : NodeRenderer
createRenderer()  : NodeRenderer|null

Constants

DEFAULT_DEPTH

private mixed DEFAULT_DEPTH = 2

Properties

$classes

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

$files

protected array<string|int, string> $files

$options

protected array<string|int, string> $options

Methods

__construct()

public __construct(Environment $environment, array<string|int, string> $files, array<string|int, string> $options) : mixed
Parameters
$environment : Environment
$files : array<string|int, string>
$options : array<string|int, string>
Return values
mixed

getClasses()

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

getClassesString()

public getClassesString() : string
Return values
string

getDepth()

public getDepth() : int
Return values
int

getFiles()

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

getOptions()

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

getValue()

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

getValueString()

public getValueString() : string
Return values
string

render()

public render() : 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

normalizeLines()

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

Search results