NamespaceIndexBuilder¶

class JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder¶

This class will build an index for each namespace.

It contains a toc for child namespaces, classes, traits, interfaces and functions

Source:	src/Builder/NamespaceIndexBuilder.php#40
Parent:	`JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder`

Summary¶

Methods¶

public __construct($extensions, $namespaces, $current, $functions, $constants)
private findChildNamespaces()
public render()
protected addIndex($type)
private addFunctions()
private addElementTocEntry($entry)
private shouldRenderIndex($type, $element)
private getHeaderForType($type)
private getElementList($type)

Constants¶

RENDER_INDEX_NAMESPACE = 0

Source:	src/Builder/NamespaceIndexBuilder.php#42

RENDER_INDEX_CLASSES = 1

Source:	src/Builder/NamespaceIndexBuilder.php#43

RENDER_INDEX_TRAITS = 2

Source:	src/Builder/NamespaceIndexBuilder.php#44

RENDER_INDEX_INTERFACES = 3

Source:	src/Builder/NamespaceIndexBuilder.php#45

RENDER_INDEX_FUNCTIONS = 4

Source:	src/Builder/NamespaceIndexBuilder.php#46

RENDER_INDEX_CONSTANTS = 5

Source:	src/Builder/NamespaceIndexBuilder.php#47

Properties¶

Methods¶

public JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::__construct($extensions, $namespaces, phpDocumentor\Reflection\Php\Namespace_ $current, $functions, $constants)¶

Source:	src/Builder/NamespaceIndexBuilder.php#64

public JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::render()¶

Source:	src/Builder/NamespaceIndexBuilder.php#94

protected JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::addIndex($type)¶

Source:	src/Builder/NamespaceIndexBuilder.php#119