phpDocumentor

MarkerFromTagsExtractor
in package
implements CompilerPassInterface

This index builder collects all markers from tags and inserts them into the marker index.

Interfaces, Classes, Traits and Enums

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

Table of Contents

COMPILER_PRIORITY  = 9000
execute()  : void
Executes a compiler pass.
getDescription()  : string
Returns a textual description of what this pass does for output purposes.
addTodoMarkerToFile()  : void
Adds a marker with the TO DO information to the file on a given line number.
getFileDescriptor()  : FileDescriptor
Retrieves the File Descriptor from the given element.

Constants

Methods

execute()

Executes a compiler pass.

public execute(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.

Return values
void

getDescription()

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

public getDescription() : string

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

Return values
string

Search results