Properties

$argumentAssembler

$argumentAssembler : \phpDocumentor\Descriptor\Builder\Reflector\ArgumentAssembler

Type

ArgumentAssembler

$reducers

$reducers : \phpDocumentor\Descriptor\Builder\AssemblerReducer[]

Type

AssemblerReducer[]

Methods

__construct()

__construct(\phpDocumentor\Descriptor\Builder\Reflector\ArgumentAssembler  $argumentAssembler) : mixed

Initializes this assembler and its dependencies.

Parameters

\phpDocumentor\Descriptor\Builder\Reflector\ArgumentAssembler $argumentAssembler

Returns

mixed —

create()

create(\phpDocumentor\Reflection\Php\Function_  $data) : \phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\Php\Function_ $data

Returns

\phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null —

deduplicateTypes()

deduplicateTypes(?\phpDocumentor\Reflection\Type  $type) : ?\phpDocumentor\Reflection\Type

Parameters

?\phpDocumentor\Reflection\Type $type

Returns

?\phpDocumentor\Reflection\Type —

getBuilder()

getBuilder() : ?\phpDocumentor\Descriptor\ProjectDescriptorBuilder

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

Returns

?\phpDocumentor\Descriptor\ProjectDescriptorBuilder —

setBuilder()

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

Registers the Builder with this Assembler.

The Builder may be used to recursively assemble Descriptors using the {@link} method.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

buildDescriptor()

buildDescriptor(\phpDocumentor\Descriptor\Builder\Reflector\TInput  $data) : \phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null

Parameters

\phpDocumentor\Descriptor\Builder\Reflector\TInput $data

Returns

\phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null —

assembleDocBlock()

assembleDocBlock(?\phpDocumentor\Reflection\DocBlock  $docBlock, \phpDocumentor\Descriptor\DescriptorAbstract  $target) : void

Assemble DocBlock.

Parameters

?\phpDocumentor\Reflection\DocBlock $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

extractPackageFromDocBlock(?\phpDocumentor\Reflection\DocBlock  $docBlock) : ?string

Extracts the package from the DocBlock.

Parameters

?\phpDocumentor\Reflection\DocBlock $docBlock

Returns

?string —

pretifyValue()

pretifyValue(?string  $value) : ?string

Parameters

?string $value

Returns

?string —

mapReflectorPropertiesOntoDescriptor()

mapReflectorPropertiesOntoDescriptor(\phpDocumentor\Reflection\Php\Function_  $reflector, \phpDocumentor\Descriptor\FunctionDescriptor  $descriptor) : void

Maps the properties of the Function reflector onto the Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Function_ $reflector
\phpDocumentor\Descriptor\FunctionDescriptor $descriptor

addArgumentsToFunctionDescriptor()

addArgumentsToFunctionDescriptor(\phpDocumentor\Reflection\Php\Argument[]  $arguments, \phpDocumentor\Descriptor\FunctionDescriptor  $functionDescriptor) : void

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

Parameters

\phpDocumentor\Reflection\Php\Argument[] $arguments
\phpDocumentor\Descriptor\FunctionDescriptor $functionDescriptor

addArgumentDescriptorToFunction()

addArgumentDescriptorToFunction(\phpDocumentor\Descriptor\FunctionDescriptor  $functionDescriptor, \phpDocumentor\Descriptor\ArgumentDescriptor  $argumentDescriptor) : void

Adds the given argument to the function.

Parameters

\phpDocumentor\Descriptor\FunctionDescriptor $functionDescriptor
\phpDocumentor\Descriptor\ArgumentDescriptor $argumentDescriptor

createArgumentDescriptor()

createArgumentDescriptor(\phpDocumentor\Descriptor\FunctionDescriptor  $functionDescriptor, \phpDocumentor\Reflection\Php\Argument  $argument) : \phpDocumentor\Descriptor\ArgumentDescriptor

Creates a new ArgumentDescriptor from the given Reflector and Param.

Parameters

\phpDocumentor\Descriptor\FunctionDescriptor $functionDescriptor
\phpDocumentor\Reflection\Php\Argument $argument

Returns

\phpDocumentor\Descriptor\ArgumentDescriptor —