\phpDocumentor\Descriptor\Builder\ReflectorClassAssembler

Assembles an ClassDescriptor using an ClassReflector.

Summary

Methods
Properties
Constants
__construct()
create()
deduplicateTypes()
getBuilder()
setBuilder()
No public properties found
No constants found
buildDescriptor()
assembleDocBlock()
extractPackageFromDocBlock()
addConstants()
addProperties()
addMethods()
addUses()
$builder
N/A
No private methods found
$reducers
N/A

Properties

$reducers

$reducers : \phpDocumentor\Descriptor\Builder\AssemblerReducer[]

Type

AssemblerReducer[]

Methods

__construct()

__construct(\phpDocumentor\Descriptor\Builder\AssemblerReducer  ...$reducers) : mixed

Parameters

\phpDocumentor\Descriptor\Builder\AssemblerReducer $reducers variadic

Returns

mixed —

create()

create(\phpDocumentor\Reflection\Php\Class_  $data) : \phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\Php\Class_ $data

Returns

\phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null —

deduplicateTypes()

deduplicateTypes(?\phpDocumentor\Reflection\Type  $type) : ?\phpDocumentor\Reflection\Type

Parameters

?\phpDocumentor\Reflection\Type $type

Returns

?\phpDocumentor\Reflection\Type —

getBuilder()

getBuilder() : ?\phpDocumentor\Descriptor\ProjectDescriptorBuilder

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

Returns

?\phpDocumentor\Descriptor\ProjectDescriptorBuilder —

setBuilder()

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

Registers the Builder with this Assembler.

The Builder may be used to recursively assemble Descriptors using the {@link} method.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

buildDescriptor()

buildDescriptor(\phpDocumentor\Descriptor\Builder\Reflector\TInput  $data) : \phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null

Parameters

\phpDocumentor\Descriptor\Builder\Reflector\TInput $data

Returns

\phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null —

assembleDocBlock()

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

Assemble DocBlock.

Parameters

?\phpDocumentor\Reflection\DocBlock $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

extractPackageFromDocBlock(?\phpDocumentor\Reflection\DocBlock  $docBlock) : ?string

Extracts the package from the DocBlock.

Parameters

?\phpDocumentor\Reflection\DocBlock $docBlock

Returns

?string —

addConstants()

addConstants(\phpDocumentor\Reflection\Php\Constant[]  $constants, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the child constants with the generated Class Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Constant[] $constants
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor

addProperties()

addProperties(\phpDocumentor\Reflection\Php\Property[]  $properties, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the child properties with the generated Class Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Property[] $properties
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor

addMethods()

addMethods(\phpDocumentor\Reflection\Php\Method[]  $methods, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the child methods with the generated Class Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Method[] $methods
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor

addUses()

addUses(\phpDocumentor\Reflection\Fqsen[]  $traits, \phpDocumentor\Descriptor\ClassDescriptor  $classDescriptor) : void

Registers the used traits with the generated Class Descriptor.

Parameters

\phpDocumentor\Reflection\Fqsen[] $traits
\phpDocumentor\Descriptor\ClassDescriptor $classDescriptor