Debug extends ApiDocumentationPass
This class is responsible for sending statistical information to the log.
For debugging purposes it can be convenient to send statistical information about the ProjectDescriptor to the log of phpDocumentor.
Attributes
- #[Stage]
- 'phpdoc.pipeline.api_documentation.compile'
- 1000
- 'Analyze results and write report to log'
Table of Contents
Properties
- $analyzer : ProjectAnalyzer
- $log : LoggerInterface
Methods
- __construct() : mixed
- Registers the logger with this Compiler Pass.
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
- process() : ApiSetDescriptor
- Actual method executed by the compiler.
Properties
$analyzer
protected
ProjectAnalyzer
$analyzer
service that compiles a summary of the project
$log
protected
LoggerInterface
$log
the logger to write the debug results to
Methods
__construct()
Registers the logger with this Compiler Pass.
public
__construct(LoggerInterface $log, ProjectAnalyzer $analyzer) : mixed
Parameters
- $log : LoggerInterface
- $analyzer : ProjectAnalyzer
__invoke()
Executes a compiler pass.
public
final __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
stringprocess()
Actual method executed by the compiler.
protected
process(ApiSetDescriptor $subject) : ApiSetDescriptor
Processes the given ApiSetDescriptor and returns the modified ApiSetDescriptor.
Parameters
- $subject : ApiSetDescriptor