ArgumentAssembler

Extends \phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Assembles an ArgumentDescriptor using an ArgumentReflector and ParamDescriptors.

package

Default

Methods

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\FunctionReflector\ArgumentReflector $data, array<mixed,\phpDocumentor\Descriptor\Tag\ParamDescriptor> $params = array()) : \phpDocumentor\Descriptor\ArgumentDescriptor

Arguments

$data

\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector

Response

\phpDocumentor\Descriptor\ArgumentDescriptor

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

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

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

Arguments

$argument

\phpDocumentor\Reflection\FunctionReflector\ArgumentReflector

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

builder

builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
inherited