FileAssembler

Extends \phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Assembles an FileDescriptor using an FileReflector and ParamDescriptors.

package

Default

Methods

Registers the child classes with the generated File Descriptor.

addClasses(array<mixed,\phpDocumentor\Reflection\ClassReflector> $classes, \phpDocumentor\Descriptor\FileDescriptor $fileDescriptor) : void

Arguments

$classes

array<mixed,\phpDocumentor\Reflection\ClassReflector>

Registers the child constants with the generated File Descriptor.

addConstants(array<mixed,\phpDocumentor\Reflection\ConstantReflector> $constants, \phpDocumentor\Descriptor\FileDescriptor $fileDescriptor) : void

Arguments

$constants

array<mixed,\phpDocumentor\Reflection\ConstantReflector>

Registers the child functions with the generated File Descriptor.

addFunctions(array<mixed,\phpDocumentor\Reflection\FunctionReflector> $functions, \phpDocumentor\Descriptor\FileDescriptor $fileDescriptor) : void

Arguments

$functions

array<mixed,\phpDocumentor\Reflection\FunctionReflector>

Registers the child interfaces with the generated File Descriptor.

addInterfaces(array<mixed,\phpDocumentor\Reflection\InterfaceReflector> $interfaces, \phpDocumentor\Descriptor\FileDescriptor $fileDescriptor) : void

Arguments

$interfaces

array<mixed,\phpDocumentor\Reflection\InterfaceReflector>

Registers the markers that were found in a File with the File Descriptor.

addMarkers(array<mixed,string> $markers, \phpDocumentor\Descriptor\FileDescriptor $fileDescriptor) : void

Arguments

$markers

array<mixed,string>

Registers the child traits with the generated File Descriptor.

addTraits(array<mixed,\phpDocumentor\Reflection\TraitReflector> $traits, \phpDocumentor\Descriptor\FileDescriptor $fileDescriptor) : void

Arguments

$traits

array<mixed,\phpDocumentor\Reflection\TraitReflector>

Assemble DocBlock.

assembleDocBlock(\phpDocumentor\Reflection\DocBlock|null $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract $target) : void
inherited

Arguments

$docBlock

\phpDocumentor\Reflection\DocBlock|null

Creates a Descriptor from the provided data.

create(\phpDocumentor\Reflection\FileReflector $data) : \phpDocumentor\Descriptor\FileDescriptor

Arguments

$data

\phpDocumentor\Reflection\FileReflector

Response

\phpDocumentor\Descriptor\FileDescriptor

Extracts the package from the DocBlock.

extractPackageFromDocBlock(\phpDocumentor\Reflection\DocBlock $docBlock) : string|null
inherited

Arguments

$docBlock

\phpDocumentor\Reflection\DocBlock

Response

string|null

Returns the builder for this Assembler or null if none is set.

getBuilder() : null|\phpDocumentor\Descriptor\ProjectDescriptorBuilder
inherited

overridePackageTag

overridePackageTag( $data,  $fileDescriptor) 

Arguments

$data

$fileDescriptor

Registers the Builder with this Assembler.

setBuilder(\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder) : void
inherited

The Builder may be used to recursively assemble Descriptors using the \ProjectDescriptorBuilder::buildDescriptor() method.

Arguments

Properties

builder

builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
inherited