ArgumentAssembler
extends AssemblerAbstract
in package
Assembles an ArgumentDescriptor using an ArgumentReflector and ParamDescriptors.
Tags
Table of Contents
- $builder : ProjectDescriptorBuilder|null
- create() : ArgumentDescriptor
- Creates a Descriptor from the provided data.
- getBuilder() : ProjectDescriptorBuilder|null
- Returns the builder for this Assembler or null if none is set.
- setBuilder() : void
- Registers the Builder with this Assembler.
- overwriteTypeAndDescriptionFromParamTag() : void
- Overwrites the type and description in the Argument Descriptor with that from the tag if the names match.
- pretifyValue() : string|null
Properties
$builder
protected
ProjectDescriptorBuilder|null
$builder
Methods
create()
Creates a Descriptor from the provided data.
public
create(Argument $data[, iteratable<string|int, ParamDescriptor> $params = [] ]) : ArgumentDescriptor
Parameters
- $data : Argument
- $params : iteratable<string|int, ParamDescriptor> = []
Return values
ArgumentDescriptor —getBuilder()
Returns the builder for this Assembler or null if none is set.
public
getBuilder() : ProjectDescriptorBuilder|null
Return values
ProjectDescriptorBuilder|null —setBuilder()
Registers the Builder with this Assembler.
public
setBuilder(ProjectDescriptorBuilder $builder) : void
The Builder may be used to recursively assemble Descriptors using the method.
Parameters
- $builder : ProjectDescriptorBuilder
Return values
void —overwriteTypeAndDescriptionFromParamTag()
Overwrites the type and description in the Argument Descriptor with that from the tag if the names match.
protected
overwriteTypeAndDescriptionFromParamTag(Argument $argument, ParamDescriptor $paramDescriptor, ArgumentDescriptor $argumentDescriptor) : void
Parameters
- $argument : Argument
- $paramDescriptor : ParamDescriptor
- $argumentDescriptor : ArgumentDescriptor
Return values
void —pretifyValue()
protected
pretifyValue(string|null $value) : string|null
Parameters
- $value : string|null