ElementsIndexBuilder

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

Interfaces, Classes & Used Traits

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

Constants

Methods

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

publicgetDescription() : string

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

Returns

string —

Executes a compiler pass.

publicexecute(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.

Returns any sub-elements for the given element.

protectedgetSubElements(DescriptorAbstract $element) : \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.

Parameters

$element : DescriptorAbstract

Returns

\phpDocumentor\Descriptor\DescriptorAbstract[] —

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

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

Parameters

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

Retrieves a key for the index for the provided element.

protectedgetIndexKey(DescriptorAbstract $element) : string

Parameters

$element : DescriptorAbstract

Returns

string —