\phpDocumentor\Descriptor\Builder\Reflector\TagsUsesAssembler

Base class for all assemblers.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
$builder
N/A
setFirstReferencePartAsType()
referenceIsNamespaceAlias()
No private properties found
N/A

Properties

Methods

create()

create(\phpDocumentor\Reflection\DocBlock\Tag\UsesTag  $data) : \phpDocumentor\Descriptor\Tag\UsesDescriptor

Creates a new Descriptor from the given Reflector.

Parameters

\phpDocumentor\Reflection\DocBlock\Tag\UsesTag $data

Returns

\phpDocumentor\Descriptor\Tag\UsesDescriptor

assembleDocBlock()

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

Assemble DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock|null $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

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

Extracts the package from the DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock $docBlock

Returns

string|null

setFirstReferencePartAsType()

setFirstReferencePartAsType(\phpDocumentor\Reflection\DocBlock\Context  $context, array<mixed,string>  $referenceParts) : array

Parameters

\phpDocumentor\Reflection\DocBlock\Context $context
array<mixed,string> $referenceParts

Returns

array —

The returned array will consist of a Collection object with the type, and strings for methods, etc.

referenceIsNamespaceAlias()

referenceIsNamespaceAlias(string  $reference, \phpDocumentor\Reflection\DocBlock\Context  $context) : boolean

When you have a relative reference to a class, we need to check if this class exists in the namespace aliases

Parameters

string $reference
\phpDocumentor\Reflection\DocBlock\Context $context

Returns

boolean