\phpDocumentor\Descriptor\Builder\ReflectorMethodAssembler

Assembles a MethodDescriptor from a MethodReflector.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
__construct()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
mapReflectorToDescriptor()
addArguments()
addArgument()
addVariadicArgument()
$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\ClassReflector\MethodReflector  $data) : \phpDocumentor\Descriptor\MethodDescriptor

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\ClassReflector\MethodReflector $data

Returns

\phpDocumentor\Descriptor\MethodDescriptor

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

mapReflectorToDescriptor()

mapReflectorToDescriptor(\phpDocumentor\Reflection\ClassReflector\MethodReflector  $reflector, \phpDocumentor\Descriptor\MethodDescriptor  $descriptor) : void

Maps the fields to the reflector to the descriptor.

Parameters

\phpDocumentor\Reflection\ClassReflector\MethodReflector $reflector
\phpDocumentor\Descriptor\MethodDescriptor $descriptor

addArguments()

addArguments(\phpDocumentor\Reflection\ClassReflector\MethodReflector  $reflector, \phpDocumentor\Descriptor\MethodDescriptor  $descriptor) : void

Adds the reflected Arguments to the Descriptor.

Parameters

\phpDocumentor\Reflection\ClassReflector\MethodReflector $reflector
\phpDocumentor\Descriptor\MethodDescriptor $descriptor

addArgument()

addArgument(\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector  $argument, \phpDocumentor\Descriptor\MethodDescriptor  $descriptor) : void

Adds a single reflected Argument to the Method Descriptor.

Parameters

\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector $argument
\phpDocumentor\Descriptor\MethodDescriptor $descriptor

addVariadicArgument()

addVariadicArgument(\phpDocumentor\Reflection\ClassReflector\MethodReflector  $data, \phpDocumentor\Descriptor\MethodDescriptor  $methodDescriptor) : void

Checks if there is a variadic argument in the [email protected]` tags and adds it to the list of Arguments in the Descriptor unless there is already one present.

Parameters

\phpDocumentor\Reflection\ClassReflector\MethodReflector $data
\phpDocumentor\Descriptor\MethodDescriptor $methodDescriptor