EnumAssembler
extends AssemblerAbstract
in package
FinalYes
Assembles an EnumDescriptor using an ClassReflector.
Table of Contents
Properties
- $builder : ProjectDescriptorBuilder|null
- $reducers : array<string|int, AssemblerReducer>
Methods
- __construct() : mixed
- create() : TDescriptor|null
- Creates a Descriptor from the provided data.
- deduplicateTypes() : Type|null
- getBuilder() : ProjectDescriptorBuilder|null
- Returns the builder for this Assembler or null if none is set.
- setBuilder() : void
- Registers the Builder with this Assembler.
- assembleDocBlock() : void
- Assemble DocBlock.
- buildDescriptor() : TDescriptor|null
- extractPackageFromDocBlock() : string|null
- Extracts the package from the DocBlock.
- addCases() : void
- addMethods() : void
- Registers the child methods with the generated Class Descriptor.
- addUses() : void
- Registers the used traits with the generated Class Descriptor.
Properties
$builder
protected
ProjectDescriptorBuilder|null
$builder
$reducers read-only
private
array<string|int, AssemblerReducer>
$reducers
Methods
__construct()
public
__construct(AssemblerReducer ...$reducers) : mixed
Parameters
- $reducers : AssemblerReducer
create()
Creates a Descriptor from the provided data.
public
create(TInput $data) : TDescriptor|null
Parameters
- $data : TInput
Return values
TDescriptor|nulldeduplicateTypes()
public
static deduplicateTypes(Type|null $type) : Type|null
the functionality in this method has been moved to the Compound type in the latest unreleased version of the TypeResolver library
Parameters
- $type : Type|null
Return values
Type|nullgetBuilder()
Returns the builder for this Assembler or null if none is set.
public
getBuilder() : ProjectDescriptorBuilder|null
Return values
ProjectDescriptorBuilder|nullsetBuilder()
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
assembleDocBlock()
Assemble DocBlock.
protected
assembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void
Parameters
- $docBlock : DocBlock|null
- $target : DescriptorAbstract
buildDescriptor()
protected
buildDescriptor(Enum_ $data) : TDescriptor|null
Parameters
- $data : Enum_
Return values
TDescriptor|nullextractPackageFromDocBlock()
Extracts the package from the DocBlock.
protected
extractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
- $docBlock : DocBlock|null
Return values
string|nulladdCases()
private
addCases(array<string|int, EnumCase> $cases, EnumInterface $descriptor) : void
Parameters
- $cases : array<string|int, EnumCase>
- $descriptor : EnumInterface
addMethods()
Registers the child methods with the generated Class Descriptor.
private
addMethods(array<string|int, Method> $methods, EnumInterface $descriptor) : void
Parameters
- $methods : array<string|int, Method>
- $descriptor : EnumInterface
addUses()
Registers the used traits with the generated Class Descriptor.
private
addUses(array<string|int, Fqsen> $traits, EnumInterface $descriptor) : void
Parameters
- $traits : array<string|int, Fqsen>
- $descriptor : EnumInterface