\phpDocumentor\Descriptor\Builder\Reflector\TagsParamAssembler

Constructs a new descriptor from the Reflector for an `@param` tag.

This object will read the reflected information for the @param tag and create a {@see} object that can be used in the rest of the application and templates.

Summary

Methods
Properties
Constants
__construct()
create()
buildDescriptor()
deduplicateTypes()
getBuilder()
setBuilder()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
$builder
N/A
No private methods found
$reducers
N/A

Properties

$reducers

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

Type

AssemblerReducer[]

Methods

__construct()

__construct(\phpDocumentor\Descriptor\Builder\AssemblerReducer  ...$reducers) : mixed

Parameters

\phpDocumentor\Descriptor\Builder\AssemblerReducer $reducers variadic

Returns

mixed —

create()

create(\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 —

buildDescriptor()

buildDescriptor(\phpDocumentor\Reflection\DocBlock\Tags\Param  $data) : \phpDocumentor\Descriptor\Tag\ParamDescriptor

Creates a new Descriptor from the given Reflector.

Parameters

\phpDocumentor\Reflection\DocBlock\Tags\Param $data

Returns

\phpDocumentor\Descriptor\Tag\ParamDescriptor —

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

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 —