\phpDocumentor\Descriptor\Builder\ReflectorClassAssembler

Assembles an ClassDescriptor using an ClassReflector.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
addConstants()
addProperties()
addMethods()
addUses()
$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\ClassReflector  $data) : \phpDocumentor\Descriptor\ClassDescriptor

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\ClassReflector $data

Returns

\phpDocumentor\Descriptor\ClassDescriptor

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\ClassDescriptor  $classDescriptor) : void

Registers the child constants with the generated Class Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\ConstantReflector> $constants
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor

addProperties()

addProperties(array<mixed,\phpDocumentor\Reflection\ClassReflector\PropertyReflector>  $properties, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the child properties with the generated Class Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\ClassReflector\PropertyReflector> $properties
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor

addMethods()

addMethods(array<mixed,\phpDocumentor\Reflection\ClassReflector\MethodReflector>  $methods, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the child methods with the generated Class Descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\ClassReflector\MethodReflector> $methods
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor

addUses()

addUses(array<mixed,string>  $traits, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the used traits with the generated Class Descriptor.

Parameters

array<mixed,string> $traits
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor