FileAssembler
extends AssemblerAbstract
in package
Assembles an FileDescriptor using an FileReflector and ParamDescriptors.
Table of Contents
Properties
- $builder : ProjectDescriptorBuilder|null
- $reducers : array<string|int, AssemblerReducer>
Methods
- __construct() : mixed
- buildDescriptor() : TDescriptor|null
- Creates a Descriptor from the provided data.
- 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.
- addClasses() : void
- Registers the child classes with the generated File Descriptor.
- addConstants() : void
- Registers the child constants with the generated File Descriptor.
- addFunctions() : void
- Registers the child functions with the generated File Descriptor.
- addInterfaces() : void
- Registers the child interfaces with the generated File Descriptor.
- addTraits() : void
- Registers the child traits with the generated File Descriptor.
- assembleDocBlock() : void
- Assemble DocBlock.
- extractPackageFromDocBlock() : string|null
- Extracts the package from the DocBlock.
- overridePackageTag() : void
- addEnums() : void
- Registers the child classes with the generated File 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
buildDescriptor()
Creates a Descriptor from the provided data.
public
buildDescriptor(File $data) : TDescriptor|null
Parameters
- $data : File
Return values
TDescriptor|nullcreate()
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
addClasses()
Registers the child classes with the generated File Descriptor.
protected
addClasses(array<string|int, Class_> $classes, FileInterface $fileDescriptor) : void
Parameters
- $classes : array<string|int, Class_>
- $fileDescriptor : FileInterface
addConstants()
Registers the child constants with the generated File Descriptor.
protected
addConstants(array<string|int, Constant> $constants, FileInterface $fileDescriptor) : void
Parameters
- $constants : array<string|int, Constant>
- $fileDescriptor : FileInterface
addFunctions()
Registers the child functions with the generated File Descriptor.
protected
addFunctions(array<string|int, Function_> $functions, FileInterface $fileDescriptor) : void
Parameters
- $functions : array<string|int, Function_>
- $fileDescriptor : FileInterface
addInterfaces()
Registers the child interfaces with the generated File Descriptor.
protected
addInterfaces(array<string|int, Interface_> $interfaces, FileInterface $fileDescriptor) : void
Parameters
- $interfaces : array<string|int, Interface_>
- $fileDescriptor : FileInterface
addTraits()
Registers the child traits with the generated File Descriptor.
protected
addTraits(array<string|int, Trait_> $traits, FileInterface $fileDescriptor) : void
Parameters
- $traits : array<string|int, Trait_>
- $fileDescriptor : FileInterface
assembleDocBlock()
Assemble DocBlock.
protected
assembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void
Parameters
- $docBlock : DocBlock|null
- $target : DescriptorAbstract
extractPackageFromDocBlock()
Extracts the package from the DocBlock.
protected
extractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
- $docBlock : DocBlock|null
Return values
string|nulloverridePackageTag()
protected
overridePackageTag(File $data, FileInterface $fileDescriptor) : void
Parameters
- $data : File
- $fileDescriptor : FileInterface
addEnums()
Registers the child classes with the generated File Descriptor.
private
addEnums(array<string|int, Enum_> $enums, FileInterface $fileDescriptor) : void
Parameters
- $enums : array<string|int, Enum_>
- $fileDescriptor : FileInterface