\phpDocumentor\Descriptor\Builder\ReflectorFunctionAssembler

Assembles a FunctionDescriptor from a FunctionReflector.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
__construct()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
mapReflectorPropertiesOntoDescriptor()
addArgumentsToFunctionDescriptor()
addArgumentDescriptorToFunction()
createArgumentDescriptor()
getFullyQualifiedNamespaceName()
$builder
$argumentAssembler
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\FunctionReflector  $data) : \phpDocumentor\Descriptor\FunctionDescriptor

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\FunctionReflector $data

Returns

\phpDocumentor\Descriptor\FunctionDescriptor

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

mapReflectorPropertiesOntoDescriptor()

mapReflectorPropertiesOntoDescriptor(\phpDocumentor\Reflection\FunctionReflector  $reflector, \phpDocumentor\Descriptor\FunctionDescriptor  $descriptor) : void

Maps the properties of the Function reflector onto the Descriptor.

Parameters

\phpDocumentor\Reflection\FunctionReflector $reflector
\phpDocumentor\Descriptor\FunctionDescriptor $descriptor

addArgumentsToFunctionDescriptor()

addArgumentsToFunctionDescriptor(array<mixed,\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector>  $arguments, \phpDocumentor\Descriptor\FunctionDescriptor  $functionDescriptor) : void

Converts each argument reflector to an argument descriptor and adds it to the function descriptor.

Parameters

array<mixed,\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector> $arguments
\phpDocumentor\Descriptor\FunctionDescriptor $functionDescriptor

createArgumentDescriptor()

createArgumentDescriptor(\phpDocumentor\Descriptor\FunctionDescriptor  $functionDescriptor, \phpDocumentor\Reflection\FunctionReflector\ArgumentReflector  $argument) : \phpDocumentor\Descriptor\ArgumentDescriptor

Creates a new ArgumentDescriptor from the given Reflector and Param.

Parameters

\phpDocumentor\Descriptor\FunctionDescriptor $functionDescriptor
\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $argument

Returns

\phpDocumentor\Descriptor\ArgumentDescriptor

getFullyQualifiedNamespaceName()

getFullyQualifiedNamespaceName(\phpDocumentor\Reflection\FunctionReflector  $reflector) : string

Retrieves the Fully Qualified Namespace Name from the FunctionReflector.

Reflection library formulates namespace as global but this is not wanted for phpDocumentor itself.

Parameters

\phpDocumentor\Reflection\FunctionReflector $reflector

Returns

string