Implements \phpDocumentor\Compiler\CompilerPassInterface

Rebuilds the package tree from the elements found in files.

On every compiler pass is the package tree rebuild to aid in the process of incremental updates.

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




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

addElementsOfTypeToPackage(\phpDocumentor\Descriptor\ProjectDescriptor $project, array<mixed,\phpDocumentor\Descriptor\DescriptorAbstract> $elements, string $type) : void

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




Series of elements to add to their respective package.



Declares which field of the package 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.

Creates a tree of PackageDescriptors based on the provided FQNN (package name).

createPackageDescriptorTree(\phpDocumentor\Descriptor\ProjectDescriptor $project, string $packageName) : void

This method will examine the package name and create a package descriptor for each part of the FQNN if it doesn't exist in the packages field of the current package (starting with the root Package in the Project Descriptor),

As an intended side effect this method also populates the elements index of the ProjectDescriptor with all created PackageDescriptors. Each index key is prefixed with a tilde (~) so that it will not conflict with other FQSEN's, such as classes or interfaces.

see \phpDocumentor\Descriptor\ProjectDescriptor::getPackage()

for the root package.


for the child packages of a given package.




A FQNN of the package (and parents) to create.

Compiles a 'packages' index on the project and create all Package Descriptors necessary.

execute(\phpDocumentor\Descriptor\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.




Representation of the Object Graph that can be manipulated.

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.