phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\phpDocumentor\Compiler\PassGuidesCompiler

Summary

Methods
Properties
Constants
__construct()
getDescription()
execute()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$compiler
$metas
N/A

Properties

$compiler

$compiler : \phpDocumentor\Guides\Compiler\Compiler

Type

\phpDocumentor\Guides\Compiler\Compiler

$metas

$metas : \phpDocumentor\Guides\Metas

Type

\phpDocumentor\Guides\Metas

Methods

__construct()

__construct(\phpDocumentor\Guides\Compiler\Compiler  $compiler, \phpDocumentor\Guides\Metas  $metas) : mixed

Parameters

\phpDocumentor\Guides\Compiler\Compiler $compiler
\phpDocumentor\Guides\Metas $metas

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.