phpDocumentor

FunctionAssembler extends AssemblerAbstract
in package

Assembles a FunctionDescriptor from a FunctionReflector.

Table of Contents

Properties

$builder  : ProjectDescriptorBuilder|null
$argumentAssembler  : ArgumentAssembler
$reducers  : array<string|int, AssemblerReducer>

Methods

__construct()  : mixed
Initializes this assembler and its dependencies.
buildDescriptor()  : TDescriptor|null
Creates a Descriptor from the provided data.
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.
addArgumentDescriptorToFunction()  : void
Adds the given argument to the function.
addArgumentsToFunctionDescriptor()  : void
Converts each argument reflector to an argument descriptor and adds it to the function descriptor.
assembleDocBlock()  : void
Assemble DocBlock.
createArgumentDescriptor()  : ArgumentInterface
Creates a new ArgumentDescriptor from the given Reflector and Param.
extractPackageFromDocBlock()  : string|null
Extracts the package from the DocBlock.
mapReflectorPropertiesOntoDescriptor()  : void
Maps the properties of the Function reflector onto the Descriptor.

Properties

Methods

buildDescriptor()

Creates a Descriptor from the provided data.

public buildDescriptor(Function_ $data) : TDescriptor|null
Parameters
$data : Function_
Return values
TDescriptor|null

create()

Creates a Descriptor from the provided data.

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

deduplicateTypes()

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|null

addArgumentsToFunctionDescriptor()

Converts each argument reflector to an argument descriptor and adds it to the function descriptor.

protected addArgumentsToFunctionDescriptor(array<string|int, Argument$arguments, FunctionDescriptor $functionDescriptor) : void
Parameters
$arguments : array<string|int, Argument>
$functionDescriptor : FunctionDescriptor

extractPackageFromDocBlock()

Extracts the package from the DocBlock.

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

mapReflectorPropertiesOntoDescriptor()

Maps the properties of the Function reflector onto the Descriptor.

protected mapReflectorPropertiesOntoDescriptor(Function_ $reflector, FunctionDescriptor $descriptor) : void
Parameters
$reflector : Function_
$descriptor : FunctionDescriptor

        
On this page

Search results