ElementsIndexBuilder

Implements \phpDocumentor\Compiler\CompilerPassInterface

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

package

Default

Methods

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

addElementsToIndexes(\phpDocumentor\Descriptor\DescriptorAbstract|array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract> $elements, array<mixed,\phpDocumentor\Descriptor\Collection> $indexes) : void

Executes a compiler pass.

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

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.

Arguments

$project

\phpDocumentor\Descriptor\ProjectDescriptor

Representation of the Object Graph that can be manipulated.

Response

mixed

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

getDescription() : string

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

Response

string

Retrieves a key for the index for the provided element.

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

Arguments

Response

string

Returns any sub-elements for the given element.

getSubElements(\phpDocumentor\Descriptor\DescriptorAbstract $element) : array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract>

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.

Arguments

Response

array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract>

Constants

COMPILER_PRIORITY

COMPILER_PRIORITY