\phpDocumentor\Descriptor\Builder\ReflectorArgumentAssembler

Assembles an ArgumentDescriptor using an ArgumentReflector and ParamDescriptors.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
overwriteTypeAndDescriptionFromParamTag()
$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\FunctionReflector\ArgumentReflector  $data, array<mixed,\phpDocumentor\Descriptor\Tag\ParamDescriptor>  $params = array()) : \phpDocumentor\Descriptor\ArgumentDescriptor

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $data
array<mixed,\phpDocumentor\Descriptor\Tag\ParamDescriptor> $params

Returns

\phpDocumentor\Descriptor\ArgumentDescriptor

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

overwriteTypeAndDescriptionFromParamTag()

overwriteTypeAndDescriptionFromParamTag(\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector  $argument, \phpDocumentor\Descriptor\Tag\ParamDescriptor  $paramDescriptor, \phpDocumentor\Descriptor\ArgumentDescriptor  $argumentDescriptor) : void

Overwrites the type and description in the Argument Descriptor with that from the tag if the names match.

Parameters

\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $argument
\phpDocumentor\Descriptor\Tag\ParamDescriptor $paramDescriptor
\phpDocumentor\Descriptor\ArgumentDescriptor $argumentDescriptor