ArgumentAssembler

in package
extends AssemblerAbstract

Assembles an ArgumentDescriptor using an ArgumentReflector and ParamDescriptors.

Properties

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

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

Creates a Descriptor from the provided data.

publiccreate(Argument $data[, iterable $params = [] ]) : ArgumentDescriptor

Parameters

$data : Argument
$params : iterable = []

Returns

ArgumentDescriptor

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

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

protectedoverwriteTypeAndDescriptionFromParamTag(Argument $argument, ParamDescriptor $paramDescriptor, ArgumentDescriptor $argumentDescriptor) : void

Parameters

$argument : Argument
$paramDescriptor : ParamDescriptor
$argumentDescriptor : ArgumentDescriptor