FunctionAssembler
in package
extends AssemblerAbstract
Assembles a FunctionDescriptor from a FunctionReflector.
Properties
$builder inherited
protected$builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
- Inherited from
- \phpDocumentor\Descriptor\Builder\AssemblerAbstract
$argumentAssembler Line 33
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 38
Initializes this assembler and its dependencies.
public__construct(ArgumentAssembler $argumentAssembler) : mixed
create() Line 48
Creates a Descriptor from the provided data.
publiccreate(Function_ $data) : FunctionDescriptor
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 —
mapReflectorPropertiesOntoDescriptor() Line 62
Maps the properties of the Function reflector onto the Descriptor.
protectedmapReflectorPropertiesOntoDescriptor(Function_ $reflector, FunctionDescriptor $descriptor) : void
addArgumentsToFunctionDescriptor() Line 91
Converts each argument reflector to an argument descriptor and adds it to the function descriptor.
protectedaddArgumentsToFunctionDescriptor(\phpDocumentor\Reflection\Php\Argument[] $arguments, FunctionDescriptor $functionDescriptor) : void
Parameters
addArgumentDescriptorToFunction() Line 104
Adds the given argument to the function.
protectedaddArgumentDescriptorToFunction(FunctionDescriptor $functionDescriptor, ArgumentDescriptor $argumentDescriptor) : void
createArgumentDescriptor() Line 114
Creates a new ArgumentDescriptor from the given Reflector and Param.
protectedcreateArgumentDescriptor(FunctionDescriptor $functionDescriptor, Argument $argument) : ArgumentDescriptor