FileAssembler
Assembles an FileDescriptor using an FileReflector and ParamDescriptors.
Properties
$builder inherited
protected$builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
Methods
deduplicateTypes() inherited
publicstaticdeduplicateTypes(Type|null $type) : Type|null
Parameters
Returns
Type|null —
getBuilder() inherited
Returns the builder for this Assembler or null if none is set.
publicgetBuilder() : ProjectDescriptorBuilder|null
Returns
ProjectDescriptorBuilder|null —- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
setBuilder() inherited
Registers the Builder with this Assembler.
publicsetBuilder(ProjectDescriptorBuilder $builder) : void
The Builder may be used to recursively assemble Descriptors using the ProjectDescriptorBuilder::buildDescriptor() method.
- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
create() Line 42
Creates a Descriptor from the provided data.
publiccreate(mixed $data) : FileDescriptor
Parameters
TODO: should be FileDescriptor type, but cause weird issues
Returns
FileDescriptor —
assembleDocBlock() inherited
Assemble DocBlock.
protectedassembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void
extractPackageFromDocBlock() inherited
Extracts the package from the DocBlock.
protectedextractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
Returns
string|null —
addConstants() Line 76
Registers the child constants with the generated File Descriptor.
protectedaddConstants(\phpDocumentor\Reflection\Php\Constant[] $constants, FileDescriptor $fileDescriptor) : void
addFunctions() Line 102
Registers the child functions with the generated File Descriptor.
protectedaddFunctions(\phpDocumentor\Reflection\Php\Function_[] $functions, FileDescriptor $fileDescriptor) : void
addClasses() Line 128
Registers the child classes with the generated File Descriptor.
protectedaddClasses(\phpDocumentor\Reflection\Php\Class_[] $classes, FileDescriptor $fileDescriptor) : void
addInterfaces() Line 156
Registers the child interfaces with the generated File Descriptor.
protectedaddInterfaces(\phpDocumentor\Reflection\Php\Interface_[] $interfaces, FileDescriptor $fileDescriptor) : void
Parameters
addTraits() Line 182
Registers the child traits with the generated File Descriptor.
protectedaddTraits(\phpDocumentor\Reflection\Php\Trait_[] $traits, FileDescriptor $fileDescriptor) : void
addMarkers() Line 208
Registers the markers that were found in a File with the File Descriptor.
protectedaddMarkers(string[][] $markers, FileDescriptor $fileDescriptor) : void