\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
overwriteTypeAndDescriptionFromParamTag()
pretifyValue()
$builder
N/A
No private methods found
No private properties found
N/A

Properties

Methods

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

create()

create(\phpDocumentor\Reflection\Php\Argument  $data, iterable<\phpDocumentor\Descriptor\Tag\ParamDescriptor>  $params = []) : \phpDocumentor\Descriptor\ArgumentDescriptor

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\Php\Argument $data
iterable<\phpDocumentor\Descriptor\Tag\ParamDescriptor> $params

Returns

\phpDocumentor\Descriptor\ArgumentDescriptor —

overwriteTypeAndDescriptionFromParamTag()

overwriteTypeAndDescriptionFromParamTag(\phpDocumentor\Reflection\Php\Argument  $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\Php\Argument $argument
\phpDocumentor\Descriptor\Tag\ParamDescriptor $paramDescriptor
\phpDocumentor\Descriptor\ArgumentDescriptor $argumentDescriptor

pretifyValue()

pretifyValue(?string  $value) : ?string

Parameters

?string $value

Returns

?string —