Debug
extends ApiDocumentationPass
in package
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.
Table of Contents
Constants
- COMPILER_PRIORITY = 1000
Properties
- $analyzer : ProjectAnalyzer
- $log : LoggerInterface
Methods
- __construct() : mixed
- Registers the logger with this Compiler Pass.
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- process() : ApiSetDescriptor
Constants
COMPILER_PRIORITY
public
final mixed
COMPILER_PRIORITY
= 1000
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()
public
getDescription() : string
Return values
stringprocess()
protected
process(ApiSetDescriptor $subject) : ApiSetDescriptor
Parameters
- $subject : ApiSetDescriptor