COMPILER_PRIORITY
COMPILER_PRIORITY = 15000
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 (~).
execute(\phpDocumentor\Descriptor\ProjectDescriptor $project) : mixed
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.
| \phpDocumentor\Descriptor\ProjectDescriptor | $project | Representation of the Object Graph that can be manipulated. |
getSubElements(\phpDocumentor\Descriptor\DescriptorAbstract $element) : array<mixed,\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.
| \phpDocumentor\Descriptor\DescriptorAbstract | $element |
addElementsToIndexes(\phpDocumentor\Descriptor\DescriptorAbstract|array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract> $elements, array<mixed,\phpDocumentor\Descriptor\Collection> $indexes) : void
Adds a series of descriptors to the given list of collections.
| \phpDocumentor\Descriptor\DescriptorAbstract|array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract> | $elements | |
| array<mixed,\phpDocumentor\Descriptor\Collection> | $indexes |
getIndexKey(\phpDocumentor\Descriptor\DescriptorAbstract $element) : string
Retrieves a key for the index for the provided element.
| \phpDocumentor\Descriptor\DescriptorAbstract | $element |