phpDocumentor

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

$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

getDescription()

public getDescription() : string
Return values
string

        
On this page

Search results