phpDocumentor

ElementsIndexBuilder extends ApiDocumentationPass
in package

FinalYes

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

Table of Contents

Methods

__invoke()  : CompilableSubject
Executes a compiler pass.
getDescription()  : string
Returns a textual description of what this pass does for output purposes.
addElementsToIndexes()  : void
Adds a series of descriptors to the given list of collections.
getIndexKey()  : string
Retrieves a key for the index for the provided element.
getSubElements()  : array<string|int, ElementInterface>
Returns any sub-elements for the given element.
process()  : ApiSetDescriptor

Attributes

#[Stage]

#[Stage]

Methods

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

getSubElements()

Returns any sub-elements for the given element.

protected getSubElements(ElementInterface $element) : array<string|int, ElementInterface>

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 : ElementInterface
Return values
array<string|int, ElementInterface>

        
On this page

Search results