TableOfContentsBuilder
in package
implements
CompilerPassInterface
FinalYes
Table of Contents
Interfaces
- CompilerPassInterface
- Represents a single pass / business rule to be executed by the Compiler.
Properties
Methods
- __construct() : mixed
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
- createGuideEntries() : void
- createNamespaceEntries() : void
Properties
$router read-only
private
Router
$router
Methods
__construct()
public
__construct(Router $router) : mixed
Parameters
- $router : Router
__invoke()
Executes a compiler pass.
public
__invoke(CompilableSubject $subject) : CompilableSubject
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
- $subject : CompilableSubject
-
Representation of the Object Graph that can be manipulated.
Return values
CompilableSubjectgetDescription()
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
stringcreateGuideEntries()
private
createGuideEntries(DocumentDescriptor $documentDescriptor, DocumentEntryNode|SectionEntryNode $metaEntry, GuideSetDescriptor $guideSetDescriptor, TocDescriptor $guideToc[, Entry|null $parent = null ]) : void
Parameters
- $documentDescriptor : DocumentDescriptor
- $metaEntry : DocumentEntryNode|SectionEntryNode
- $guideSetDescriptor : GuideSetDescriptor
- $guideToc : TocDescriptor
- $parent : Entry|null = null
createNamespaceEntries()
private
createNamespaceEntries(NamespaceInterface $namespace, TocDescriptor $namespacesToc[, Entry|null $parent = null ]) : void
Parameters
- $namespace : NamespaceInterface
- $namespacesToc : TocDescriptor
- $parent : Entry|null = null