InterfaceAssembler

Extends \phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Assembles an InterfaceDescriptor using an InterfaceReflector.

package

Default

Methods

Registers the child constants with the generated Interface Descriptor.

addConstants(array<mixed,\phpDocumentor\Reflection\ConstantReflector> $constants, \phpDocumentor\Descriptor\InterfaceDescriptor $interfaceDescriptor) : void

Arguments

$constants

array<mixed,\phpDocumentor\Reflection\ConstantReflector>

Registers the child methods with the generated Interface Descriptor.

addMethods(array<mixed,\phpDocumentor\Reflection\ClassReflector\MethodReflector> $methods, \phpDocumentor\Descriptor\InterfaceDescriptor $interfaceDescriptor) : void

Arguments

$methods

array<mixed,\phpDocumentor\Reflection\ClassReflector\MethodReflector>

Assemble DocBlock.

assembleDocBlock(\phpDocumentor\Reflection\DocBlock|null $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract $target) : void
inherited

Arguments

$docBlock

\phpDocumentor\Reflection\DocBlock|null

Creates a Descriptor from the provided data.

create(\phpDocumentor\Reflection\InterfaceReflector $data) : \phpDocumentor\Descriptor\InterfaceDescriptor

Arguments

$data

\phpDocumentor\Reflection\InterfaceReflector

Response

\phpDocumentor\Descriptor\InterfaceDescriptor

Extracts the package from the DocBlock.

extractPackageFromDocBlock(\phpDocumentor\Reflection\DocBlock $docBlock) : string|null
inherited

Arguments

$docBlock

\phpDocumentor\Reflection\DocBlock

Response

string|null

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

getBuilder() : null|\phpDocumentor\Descriptor\ProjectDescriptorBuilder
inherited

Registers the Builder with this Assembler.

setBuilder(\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder) : void
inherited

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

Arguments

Properties

builder

builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null
inherited