Debug

Implements \phpDocumentor\Compiler\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.

package

Default

Methods

Registers the logger with this Compiler Pass.

__construct(\Psr\Log\LoggerInterface $log, \phpDocumentor\Descriptor\ProjectAnalyzer $analyzer) 

Arguments

$log

\Psr\Log\LoggerInterface

Analyzes the given project and returns the results to the logger.

execute(\phpDocumentor\Descriptor\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.

Arguments

$project

\phpDocumentor\Descriptor\ProjectDescriptor

Representation of the Object Graph that can be manipulated.

Returns a textual description of what this pass does for output purposes.

getDescription() : string

Please note that the command line will be truncated to 68 characters ( .. 000.000s) so longer descriptions won't have much use.

Response

string

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY

Properties

the logger to write the debug results to

log : \Psr\Log\LoggerInterface
var

the logger to write the debug results to

Type(s)

\Psr\Log\LoggerInterface

service that compiles a summary of the project

analyzer : \phpDocumentor\Descriptor\ProjectAnalyzer
var

service that compiles a summary of the project

Type(s)

\phpDocumentor\Descriptor\ProjectAnalyzer