MethodAssembler

Extends \phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Assembles a MethodDescriptor from a MethodReflector.

package

Default

Methods

Initializes this assembler with its dependencies.

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

Adds a single reflected Argument to the Method Descriptor.

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

Arguments

$argument

\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector

Adds the reflected Arguments to the Descriptor.

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

Arguments

$reflector

\phpDocumentor\Reflection\ClassReflector\MethodReflector

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

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

Arguments

$data

\phpDocumentor\Reflection\ClassReflector\MethodReflector

Assemble DocBlock.

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

Arguments

$docBlock

\phpDocumentor\Reflection\DocBlock|null

Creates a Descriptor from the provided data.

create(\phpDocumentor\Reflection\ClassReflector\MethodReflector $data) : \phpDocumentor\Descriptor\MethodDescriptor

Arguments

$data

\phpDocumentor\Reflection\ClassReflector\MethodReflector

Response

\phpDocumentor\Descriptor\MethodDescriptor

Extracts the package from the DocBlock.

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

Arguments

$docBlock

\phpDocumentor\Reflection\DocBlock

Response

string|null

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

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

Maps the fields to the reflector to the descriptor.

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

Arguments

$reflector

\phpDocumentor\Reflection\ClassReflector\MethodReflector

Registers the Builder with this Assembler.

setBuilder(\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder) : void
inherited

The Builder may be used to recursively assemble Descriptors using the \ProjectDescriptorBuilder::buildDescriptor() method.

Arguments

Properties

argumentAssembler

argumentAssembler : \phpDocumentor\Descriptor\Builder\Reflector\ArgumentAssembler

builder

builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
inherited