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:/Builder/NamespaceIndexBuilder.php#34
Parent:JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder

Constants

RENDER_INDEX_NAMESPACE = 0
Source:/Builder/NamespaceIndexBuilder.php#36
RENDER_INDEX_CLASSES = 1
Source:/Builder/NamespaceIndexBuilder.php#37
RENDER_INDEX_TRAITS = 2
Source:/Builder/NamespaceIndexBuilder.php#38
RENDER_INDEX_INTERFACES = 3
Source:/Builder/NamespaceIndexBuilder.php#39
RENDER_INDEX_FUNCTIONS = 4
Source:/Builder/NamespaceIndexBuilder.php#40
RENDER_INDEX_CONSTANTS = 5
Source:/Builder/NamespaceIndexBuilder.php#41

Properties

private static property JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::$currentNamespace
Source:/Builder/NamespaceIndexBuilder.php#44
Type:\phpDocumentor\Reflection\Php\Namespace_
private static property JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::$namespaces
Source:/Builder/NamespaceIndexBuilder.php#47
Type:\phpDocumentor\Reflection\Php\Namespace_[]
private static property JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::$childNamespaces
Source:/Builder/NamespaceIndexBuilder.php#50
Type:\phpDocumentor\Reflection\Php\Namespace_[]
private static property JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::$functions
Source:/Builder/NamespaceIndexBuilder.php#53
Type:\phpDocumentor\Reflection\Php\Function_[]
private static property JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::$constants
Source:/Builder/NamespaceIndexBuilder.php#56
Type:\phpDocumentor\Reflection\Php\Constant[]

Methods

public JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::__construct($extensions, $namespaces, $current, $functions, $constants)
Source:/Builder/NamespaceIndexBuilder.php#58
private JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::findChildNamespaces()
Find child namespaces for current namespace.
Source:/Builder/NamespaceIndexBuilder.php#71
public JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::render()
Source:/Builder/NamespaceIndexBuilder.php#93
protected JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::addIndex($type)
Source:/Builder/NamespaceIndexBuilder.php#119
private JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::shouldRenderIndex($type, $element=null)
Source:/Builder/NamespaceIndexBuilder.php#142
private JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::getElementList($type)
Source:

/Builder/NamespaceIndexBuilder.php#161

Parameters:
  • $type (int)
Returns:

array

private JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::getHeaderForType($type)
Source:/Builder/NamespaceIndexBuilder.php#188
private JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::addElementTocEntry($entry)
Source:/Builder/NamespaceIndexBuilder.php#201
private JuliusHaertl\PHPDocToRst\Builder\NamespaceIndexBuilder::addFunctions()
Source:/Builder/NamespaceIndexBuilder.php#213