ExampleAssembler
extends AssemblerAbstract
in package
This class collects data from the example tag definition of the Reflection library, tries to find the correlating example file on disk and creates a complete Descriptor from that.
Table of Contents
Properties
- $builder : ProjectDescriptorBuilder|null
- $finder : ExampleFinder
- $reducers : array<string|int, AssemblerReducer>
Methods
- __construct() : mixed
- Initializes this assembler with the means to find the example file on disk.
- buildDescriptor() : TDescriptor|null
- Creates a new Descriptor from the given Reflector.
- 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.
- extractPackageFromDocBlock() : string|null
- Extracts the package from the DocBlock.
Properties
$builder
protected
ProjectDescriptorBuilder|null
$builder
$finder read-only
private
ExampleFinder
$finder
$reducers read-only
private
array<string|int, AssemblerReducer>
$reducers
Methods
__construct()
Initializes this assembler with the means to find the example file on disk.
public
__construct(ExampleFinder $finder, AssemblerReducer ...$reducers) : mixed
Parameters
- $finder : ExampleFinder
- $reducers : AssemblerReducer
buildDescriptor()
Creates a new Descriptor from the given Reflector.
public
buildDescriptor(Example $data) : TDescriptor|null
Parameters
- $data : Example
Tags
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
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