\phpDocumentor\Descriptor\Builder\ReflectorFileAssembler

Assembles an FileDescriptor using an FileReflector and ParamDescriptors.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
addConstants()
addFunctions()
addClasses()
addInterfaces()
addTraits()
addMarkers()
overridePackageTag()
$builder
N/A
No private methods found
No private properties found
N/A

Properties

Methods

setBuilder()

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

Registers the Builder with this Assembler.

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

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

create()

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

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\FileReflector $data

Returns

\phpDocumentor\Descriptor\FileDescriptor

assembleDocBlock()

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

Assemble DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock|null $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

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

Extracts the package from the DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock $docBlock

Returns

string|null

addConstants()

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

Registers the child constants with the generated File Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\ConstantReflector> $constants
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

addFunctions()

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

Registers the child functions with the generated File Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\FunctionReflector> $functions
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

addClasses()

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

Registers the child classes with the generated File Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\ClassReflector> $classes
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

addInterfaces()

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

Registers the child interfaces with the generated File Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\InterfaceReflector> $interfaces
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

addTraits()

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

Registers the child traits with the generated File Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\TraitReflector> $traits
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

addMarkers()

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

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

Parameters

array<mixed,string> $markers
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

overridePackageTag()

overridePackageTag(  $data,   $fileDescriptor) 

Parameters

$data
$fileDescriptor