\phpDocumentor\CompilerCompilerPassInterface

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

Summary

Methods
Constants
getDescription()
execute()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

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.