\phpDocumentor\Descriptor\Builder\Reflector\TagsExampleAssembler

This class collects data from the example tag definition of the Reflection library, tries to find the correlating example file on disk and creates a complete Descriptor from that.

Summary

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

Properties

Methods

setBuilder()

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

Registers the Builder with this Assembler.

The Builder may be used to recursively assemble Descriptors using the \ProjectDescriptorBuilder::buildDescriptor() method.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

__construct()

__construct(\phpDocumentor\Descriptor\Example\Finder  $finder) 

Initializes this assembler with the means to find the example file on disk.

Parameters

\phpDocumentor\Descriptor\Example\Finder $finder

create()

create(\phpDocumentor\Reflection\DocBlock\Tag\ExampleTag  $data) : \phpDocumentor\Descriptor\Tag\ExampleDescriptor

Creates a new Descriptor from the given Reflector.

Parameters

\phpDocumentor\Reflection\DocBlock\Tag\ExampleTag $data

Throws

\InvalidArgumentException

if the provided parameter is not of type ExampleTag; the interface won't let up typehint the signature.

Returns

\phpDocumentor\Descriptor\Tag\ExampleDescriptor

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