phpDocumentor

NamespaceTreeBuilder extends ApiDocumentationPass
in package

Rebuilds the namespace tree from the elements found in files.

On every compiler pass is the namespace tree rebuild to aid in the process of incremental updates. The Files Collection in the Project Descriptor is the only location where aliases to elements may be serialized.

If the namespace tree were to be persisted then both locations needed to be invalidated if a file were to change.

Table of Contents

Constants

COMPILER_PRIORITY  = 9000

Methods

__invoke()  : CompilableSubject
Executes a compiler pass.
getDescription()  : string
addElementsOfTypeToNamespace()  : void
Adds the given elements of a specific type to their respective Namespace Descriptors.
process()  : ApiSetDescriptor
addToParentNamespace()  : void

Constants

Methods

addElementsOfTypeToNamespace()

Adds the given elements of a specific type to their respective Namespace Descriptors.

protected addElementsOfTypeToNamespace(DocumentationSetDescriptor $documentationSet, array<string|int, ElementInterface$elements, string $type) : void

This method will assign the given elements to the namespace as registered in the namespace field of that element. If a namespace does not exist yet it will automatically be created.

Parameters
$documentationSet : DocumentationSetDescriptor
$elements : array<string|int, ElementInterface>

Series of elements to add to their respective namespace.

$type : string

Declares which field of the namespace will be populated with the given series of elements. This name will be transformed to a getter which must exist. Out of performance considerations will no effort be done to verify whether the provided type is valid.


        
On this page

Search results