MethodAssembler
in package
extends AssemblerAbstract
Assembles a MethodDescriptor from a MethodReflector.
Properties
$builder inherited
protected$builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
$argumentAssembler Line 35
protected$argumentAssembler : \phpDocumentor\Descriptor\Builder\Reflector\ArgumentAssembler
Methods
deduplicateTypes() inherited
publicstaticdeduplicateTypes(Type|null $type) : Type|null
Parameters
Returns
Type|null —
getBuilder() inherited
Returns the builder for this Assembler or null if none is set.
publicgetBuilder() : ProjectDescriptorBuilder|null
Returns
ProjectDescriptorBuilder|null —- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
setBuilder() inherited
Registers the Builder with this Assembler.
publicsetBuilder(ProjectDescriptorBuilder $builder) : void
The Builder may be used to recursively assemble Descriptors using the ProjectDescriptorBuilder::buildDescriptor() method.
- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
__construct() Line 40
Initializes this assembler with its dependencies.
public__construct(ArgumentAssembler $argumentAssembler) : mixed
create() Line 50
Creates a Descriptor from the provided data.
publiccreate(Method $data) : MethodDescriptor
assembleDocBlock() inherited
Assemble DocBlock.
protectedassembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void
extractPackageFromDocBlock() inherited
Extracts the package from the DocBlock.
protectedextractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
Returns
string|null —
mapReflectorToDescriptor() Line 72
Maps the fields to the reflector to the descriptor.
protectedmapReflectorToDescriptor(Method $reflector, MethodDescriptor $descriptor) : void
addArguments() Line 87
Adds the reflected Arguments to the Descriptor.
protectedaddArguments(Method $reflector, MethodDescriptor $descriptor) : void
addArgument() Line 97
Adds a single reflected Argument to the Method Descriptor.
protectedaddArgument(Argument $argument, MethodDescriptor $descriptor) : void
addVariadicArgument() Line 115
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