InterfaceAssembler

in package
extends AssemblerAbstract

Assembles an InterfaceDescriptor using an InterfaceReflector.

Properties

protected$builder  : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null                

Methods

publicstaticdeduplicateTypes(Type|null $type) : Type|null

Parameters

$type : Type|null

Returns

Type|null
Inherited from
\phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract
deprecated

the functionality in this method has been moved to the Compound type in the latest unreleased version of the TypeResolver library

Returns the builder for this Assembler or null if none is set.

publicgetBuilder() : ProjectDescriptorBuilder|null

Registers the Builder with this Assembler.

publicsetBuilder(ProjectDescriptorBuilder $builder) : void

The Builder may be used to recursively assemble Descriptors using the ProjectDescriptorBuilder::buildDescriptor() method.

Parameters

$builder : ProjectDescriptorBuilder

Creates a Descriptor from the provided data.

publiccreate(Interface_ $data) : InterfaceDescriptor

Parameters

$data : Interface_

Returns

InterfaceDescriptor

Assemble DocBlock.

protectedassembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void

Parameters

$docBlock : DocBlock|null
$target : DescriptorAbstract

Extracts the package from the DocBlock.

protectedextractPackageFromDocBlock(DocBlock|null $docBlock) : string|null

Parameters

$docBlock : DocBlock|null

Returns

string|null

Registers the child constants with the generated Interface Descriptor.

protectedaddConstants(\phpDocumentor\Reflection\Php\Constant[] $constants, InterfaceDescriptor $interfaceDescriptor) : void

Parameters

$constants : \phpDocumentor\Reflection\Php\Constant[]
$interfaceDescriptor : InterfaceDescriptor

Registers the child methods with the generated Interface Descriptor.

protectedaddMethods(\phpDocumentor\Reflection\Php\Method[] $methods, InterfaceDescriptor $interfaceDescriptor) : void

Parameters

$methods : \phpDocumentor\Reflection\Php\Method[]
$interfaceDescriptor : InterfaceDescriptor