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 & Used Traits

CompilerPassInterface: Represents a single pass / business rule to be executed by the Compiler.

Debug.php

Constants

COMPILER_PRIORITY Line 29

mixed COMPILER_PRIORITY = 1000

File: phpDocumentor/Compiler/Pass/Debug.php

Properties

$log Line 32

protected$log  : \Psr\Log\LoggerInterface

$analyzer Line 35

protected$analyzer  : \phpDocumentor\Descriptor\ProjectAnalyzer

Methods

__construct() Line 40

Registers the logger with this Compiler Pass.

public__construct(LoggerInterface $log, ProjectAnalyzer $analyzer) : mixed

Parameters

$log : LoggerInterface

$analyzer : ProjectAnalyzer

Returns

mixed —

getDescription() Line 46

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

publicgetDescription() : string

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

Returns

string —

execute() Line 51

Executes a compiler pass.

publicexecute(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.