TableOfContentsBuilder
in package
implements
CompilerPassInterface
Interfaces, Classes and Traits
- CompilerPassInterface
- Represents a single pass / business rule to be executed by the Compiler.
Table of Contents
- $logger : LoggerInterface
- $router : Router
- __construct() : mixed
- execute() : void
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
- createGuideEntries() : void
- createNamespaceEntries() : void
Properties
$logger
private
LoggerInterface
$logger
$router
private
Router
$router
Methods
__construct()
public
__construct(Router $router, LoggerInterface $logger) : mixed
Parameters
- $router : Router
- $logger : LoggerInterface
Return values
mixed —execute()
Executes a compiler pass.
public
execute(ProjectDescriptor $project) : void
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
- $project : ProjectDescriptor
-
Representation of the Object Graph that can be manipulated.
Return values
void —getDescription()
Returns a textual description of what this pass does for output purposes.
public
getDescription() : string
Please note that the command line will be truncated to 68 characters (
Return values
string —createGuideEntries()
private
createGuideEntries(DocumentDescriptor $documentDescriptor, Collection<string|int, DocumentDescriptor> $documents, TocDescriptor $guideToc[, Entry|null $parent = null ]) : void
Parameters
- $documentDescriptor : DocumentDescriptor
- $documents : Collection<string|int, DocumentDescriptor>
- $guideToc : TocDescriptor
- $parent : Entry|null = null
Return values
void —createNamespaceEntries()
private
createNamespaceEntries(NamespaceDescriptor $namespace, TocDescriptor $namespacesToc[, Entry|null $parent = null ]) : void
Parameters
- $namespace : NamespaceDescriptor
- $namespacesToc : TocDescriptor
- $parent : Entry|null = null