\phpDocumentor\Compiler\PassElementsIndexBuilder

This class constructs the index 'elements' and populates it with all Structural Elements.

Please note that due to a conflict between namespace FQSEN's and that of classes, interfaces, traits and functions will the namespace FQSEN be prefixed with a tilde (~).

Summary

Methods
Properties
Constants
getDescription()
execute()
No public properties found
COMPILER_PRIORITY
getSubElements()
addElementsToIndexes()
getIndexKey()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY = 15000

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.

getSubElements()

getSubElements(\phpDocumentor\Descriptor\DescriptorAbstract  $element) : \phpDocumentor\Descriptor\DescriptorAbstract[]

Returns any sub-elements for the given element.

This method checks whether the given element is a class, interface or trait and returns their methods, properties and constants accordingly, or an empty array if no sub-elements are applicable.

Parameters

\phpDocumentor\Descriptor\DescriptorAbstract $element

Returns

\phpDocumentor\Descriptor\DescriptorAbstract[] —

addElementsToIndexes()

addElementsToIndexes(\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\DescriptorAbstract[]  $elements, \phpDocumentor\Compiler\Pass\list<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>>  $indexes) : void

Adds a series of descriptors to the given list of collections.

Parameters

\phpDocumentor\Descriptor\DescriptorAbstract|\phpDocumentor\Descriptor\DescriptorAbstract[] $elements
\phpDocumentor\Compiler\Pass\list<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\DescriptorAbstract>> $indexes

getIndexKey()

getIndexKey(\phpDocumentor\Descriptor\DescriptorAbstract  $element) : string

Retrieves a key for the index for the provided element.

Parameters

\phpDocumentor\Descriptor\DescriptorAbstract $element

Returns

string —