MethodAssembler

Extends \phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Constructs a new descriptor from the Reflector for an `@method` tag.

This object will read the reflected information for the @method tag and create a \phpDocumentor\Descriptor\Tag\MethodDescriptor object that can be used in the rest of the application and templates.

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 new Descriptor from the given Reflector.

create(\phpDocumentor\Reflection\DocBlock\Tag\MethodTag $data) : \phpDocumentor\Descriptor\Tag\MethodDescriptor

Arguments

$data

\phpDocumentor\Reflection\DocBlock\Tag\MethodTag

Response

\phpDocumentor\Descriptor\Tag\MethodDescriptor

Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection component.

createArgumentDescriptorForMagicMethod(array<mixed,string> $argument) : \phpDocumentor\Descriptor\ArgumentDescriptor

Arguments

$argument

array<mixed,string>

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

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