Debug
in package
implements
CompilerPassInterface
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.
Interfaces, Classes and Traits
- CompilerPassInterface
- Represents a single pass / business rule to be executed by the Compiler.
Table of Contents
- COMPILER_PRIORITY = 1000
- $analyzer : ProjectAnalyzer
- $log : LoggerInterface
- __construct() : mixed
- Registers the logger with this Compiler Pass.
- execute() : void
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
Constants
COMPILER_PRIORITY
public
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
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 (