MethodAssembler

in package
extends AssemblerAbstract

Assembles a MethodDescriptor from a MethodReflector.

Properties

protected$builder  : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null                

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

Methods

publicstaticdeduplicateTypes(Type|null $type) : Type|null

Parameters

$type : Type|null

Returns

Type|null
Inherited from
\phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract
deprecated

the functionality in this method has been moved to the Compound type in the latest unreleased version of the TypeResolver library

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

publicgetBuilder() : ProjectDescriptorBuilder|null

Registers the Builder with this Assembler.

publicsetBuilder(ProjectDescriptorBuilder $builder) : void

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

Parameters

$builder : ProjectDescriptorBuilder

Initializes this assembler with its dependencies.

public__construct(ArgumentAssembler $argumentAssembler) : mixed

Parameters

$argumentAssembler : ArgumentAssembler

Returns

mixed

Creates a Descriptor from the provided data.

publiccreate(Method $data) : MethodDescriptor

Parameters

$data : Method

Returns

MethodDescriptor

Assemble DocBlock.

protectedassembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void

Parameters

$docBlock : DocBlock|null
$target : DescriptorAbstract

Extracts the package from the DocBlock.

protectedextractPackageFromDocBlock(DocBlock|null $docBlock) : string|null

Parameters

$docBlock : DocBlock|null

Returns

string|null

Maps the fields to the reflector to the descriptor.

protectedmapReflectorToDescriptor(Method $reflector, MethodDescriptor $descriptor) : void

Parameters

$reflector : Method
$descriptor : MethodDescriptor

Adds the reflected Arguments to the Descriptor.

protectedaddArguments(Method $reflector, MethodDescriptor $descriptor) : void

Parameters

$reflector : Method
$descriptor : MethodDescriptor

Adds a single reflected Argument to the Method Descriptor.

protectedaddArgument(Argument $argument, MethodDescriptor $descriptor) : void

Parameters

$argument : Argument
$descriptor : MethodDescriptor

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.

protectedaddVariadicArgument(Method $data, MethodDescriptor $methodDescriptor) : void

Parameters

$data : Method
$methodDescriptor : MethodDescriptor