Documentation

TocNode extends Node
in package

Table of Contents

DEFAULT_DEPTH  = 2
$classes  : array<string|int, string>
$files  : array<string|int, string>
$value  : Node|callable|string|null
$options  : array<string|int, mixed>
__construct()  : mixed
getClasses()  : array<string|int, string>
getClassesString()  : string
getDepth()  : int
getFiles()  : array<string|int, string>
getOption()  : mixed|null
getOptions()  : array<string, mixed>
getValue()  : Node|callable|string|null
getValueString()  : string
setClasses()  : void
setValue()  : void
withOptions()  : self
normalizeLines()  : string

Constants

DEFAULT_DEPTH

private mixed DEFAULT_DEPTH = 2

Properties

$classes

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

$files

protected array<string|int, string> $files

$value

protected Node|callable|string|null $value

$options

private array<string|int, mixed> $options

Methods

__construct()

public __construct(array<string|int, string> $files) : mixed
Parameters
$files : 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> —

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> —

getValue()

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

getValueString()

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