\phpDocumentor\Descriptor\Builder\ReflectorFunctionAssembler

getBuilder()

getBuilder() : null|\phpDocumentor\Descriptor\ProjectDescriptorBuilder

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

Returns

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

__construct()

__construct(\phpDocumentor\Descriptor\Builder\Reflector\ArgumentAssembler  $argumentAssembler) 

Initializes this assembler and its dependencies.

Parameters

create()

create(\phpDocumentor\Reflection\FunctionReflector  $data) : \phpDocumentor\Descriptor\FunctionDescriptor

Creates a Descriptor from the provided data.

Parameters

Returns

assembleDocBlock()

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

Assemble DocBlock.

Parameters

extractPackageFromDocBlock()

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

Extracts the package from the DocBlock.

Parameters

Returns

mapReflectorPropertiesOntoDescriptor()

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

Maps the properties of the Function reflector onto the Descriptor.

Parameters

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

addArgumentDescriptorToFunction()

addArgumentDescriptorToFunction(\phpDocumentor\Descriptor\FunctionDescriptor  $functionDescriptor, \phpDocumentor\Descriptor\ArgumentDescriptor  $argumentDescriptor) : void

Adds the given argument to the function.

Parameters

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

Returns

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

Returns