\phpDocumentor\Compiler\PassTableOfContentsBuilder

Summary

Methods
Properties
Constants
__construct()
getDescription()
execute()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
createNamespaceEntries()
createGuideEntries()
$router
$logger
N/A

Properties

$router

$router : \phpDocumentor\Transformer\Router\Router

Type

Router

$logger

$logger : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface —

Methods

__construct()

__construct(\phpDocumentor\Transformer\Router\Router  $router, \Psr\Log\LoggerInterface  $logger) : mixed

Parameters

\phpDocumentor\Transformer\Router\Router $router
\Psr\Log\LoggerInterface $logger

Returns

mixed —

getDescription()

getDescription() : string

Returns a textual description of what this pass does for output purposes.

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Returns

string —

execute()

execute(\phpDocumentor\Descriptor\ProjectDescriptor  $project) : void

Executes a compiler pass.

This method will execute the business logic associated with a given compiler pass and allow it to manipulate or consumer the Object Graph using the ProjectDescriptor object.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptor $project

Representation of the Object Graph that can be manipulated.

createNamespaceEntries()

createNamespaceEntries(\phpDocumentor\Descriptor\NamespaceDescriptor  $namespace, \phpDocumentor\Descriptor\TocDescriptor  $namespacesToc, ?\phpDocumentor\Descriptor\TableOfContents\Entry  $parent = null) : void

Parameters

\phpDocumentor\Descriptor\NamespaceDescriptor $namespace
\phpDocumentor\Descriptor\TocDescriptor $namespacesToc
?\phpDocumentor\Descriptor\TableOfContents\Entry $parent

createGuideEntries()

createGuideEntries(\phpDocumentor\Descriptor\DocumentDescriptor  $documentDescriptor, \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor>  $documents, \phpDocumentor\Descriptor\TocDescriptor  $guideToc, ?\phpDocumentor\Descriptor\TableOfContents\Entry  $parent = null) : void

Parameters

\phpDocumentor\Descriptor\DocumentDescriptor $documentDescriptor
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DocumentDescriptor> $documents
\phpDocumentor\Descriptor\TocDescriptor $guideToc
?\phpDocumentor\Descriptor\TableOfContents\Entry $parent