phpDocumentor

InterfaceAssembler extends AssemblerAbstract
in package

Assembles an InterfaceDescriptor using an InterfaceReflector.

Table of Contents

$builder  : ProjectDescriptorBuilder|null
$reducers  : array<string|int, AssemblerReducer>
__construct()  : mixed
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.
addConstants()  : void
Registers the child constants with the generated Interface Descriptor.
addMethods()  : void
Registers the child methods with the generated Interface Descriptor.
assembleDocBlock()  : void
Assemble DocBlock.
buildDescriptor()  : TDescriptor|null
extractPackageFromDocBlock()  : string|null
Extracts the package from the DocBlock.
pretifyValue()  : string|null

Properties

Methods

create()

Creates a Descriptor from the provided data.

public create(Interface_ $data) : TDescriptor|null
Parameters
$data : Interface_
Return values
TDescriptor|null

deduplicateTypes()

public static deduplicateTypes(Type|null $type) : Type|null
Parameters
$type : Type|null
Tags
deprecated

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

Return values
Type|null

addConstants()

Registers the child constants with the generated Interface Descriptor.

protected addConstants(array<string|int, Constant$constants, InterfaceDescriptor $interfaceDescriptor) : void
Parameters
$constants : array<string|int, Constant>
$interfaceDescriptor : InterfaceDescriptor
Return values
void

addMethods()

Registers the child methods with the generated Interface Descriptor.

protected addMethods(array<string|int, Method$methods, InterfaceDescriptor $interfaceDescriptor) : void
Parameters
$methods : array<string|int, Method>
$interfaceDescriptor : InterfaceDescriptor
Return values
void

buildDescriptor()

protected buildDescriptor(TInput $data) : TDescriptor|null
Parameters
$data : TInput
Return values
TDescriptor|null

extractPackageFromDocBlock()

Extracts the package from the DocBlock.

protected extractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
$docBlock : DocBlock|null
Return values
string|null

pretifyValue()

protected pretifyValue(string|null $value) : string|null
Parameters
$value : string|null
Return values
string|null

Search results