TableOfContentsBuilder implements CompilerPassInterface
FinalYes
Table of Contents
Interfaces
- CompilerPassInterface
- Represents a single pass / business rule to be executed by the Compiler.
Properties
- $builders : iterable<string|int, mixed>
Methods
- __construct() : mixed
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
Properties
$builders read-only
private
iterable<string|int, mixed>
$builders
Methods
__construct()
public
__construct(iterable<string|int, DocumentationSetBuilder<string|int, DocumentationSetDescriptor>> $builders) : mixed
Parameters
- $builders : iterable<string|int, DocumentationSetBuilder<string|int, DocumentationSetDescriptor>>
__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 (