SeeAssembler
extends BaseTagAssembler
in package
Constructs a new Descriptor from a Reflector object for the `@see` tag.
This class will gather the properties that were parsed by the Reflection mechanism for, specifically, an @see tag
and use that to create a SeeDescriptor that describes all properties that an @see tag may have.
Table of Contents
Properties
- $builder : ProjectDescriptorBuilder|null
- $reducers : array<string|int, AssemblerReducer>
Methods
- __construct() : mixed
- create() : TDescriptor|null
- 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.
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()
public
create(TInput $data) : TDescriptor|null
Parameters
- $data : TInput
Return values
TDescriptor|nulldeduplicateTypes()
public
static deduplicateTypes(Type|null $type) : Type|null
Parameters
- $type : Type|null
Tags
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(TInput $data) : TDescriptor|null
Parameters
- $data : TInput
Return values
TDescriptor|nullextractPackageFromDocBlock()
Extracts the package from the DocBlock.
protected
extractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
- $docBlock : DocBlock|null