\phpDocumentor\Compiler\PassDebug

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.

Summary

Methods

Properties

Constants

__construct()
getDescription()
execute()

No public properties found

COMPILER_PRIORITY

No protected methods found

$log
$analyzer

N/A

No private methods found

No private properties found

N/A

File: src/phpDocumentor/Compiler/Pass/Debug.php
Package: phpDocumentor
Class hierarchy: \phpDocumentor\Compiler\Pass\Debug
Implements: \phpDocumentor\Compiler\CompilerPassInterface
Uses

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY = 1000

Properties

$log

$log : \Psr\Log\LoggerInterface

Type

\Psr\Log\LoggerInterface — the logger to write the debug results to

$analyzer

$analyzer : \phpDocumentor\Descriptor\ProjectAnalyzer

Type

\phpDocumentor\Descriptor\ProjectAnalyzer — service that compiles a summary of the project

Methods

__construct()

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

Registers the logger with this Compiler Pass.

Parameters

\Psr\Log\LoggerInterface	$log
\phpDocumentor\Descriptor\ProjectAnalyzer	$analyzer

Returns

mixed —

getDescription()

getDescription() : string

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

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()

execute(\phpDocumentor\Descriptor\ProjectDescriptor  $project) : void

Executes a compiler pass.

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

\phpDocumentor\Descriptor\ProjectDescriptor

$project

Representation of the Object Graph that can be manipulated.