\phpDocumentor\Descriptor\Builder\Reflector\TagsExampleAssembler

__construct()

__construct(\phpDocumentor\Reflection\DocBlock\ExampleFinder  $finder, \phpDocumentor\Descriptor\Builder\AssemblerReducer  ...$reducers) : mixed

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

Parameters

Returns

create()

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

Parameters

Returns

buildDescriptor()

buildDescriptor(\phpDocumentor\Reflection\DocBlock\Tags\Example  $data) : \phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null

Creates a new Descriptor from the given Reflector.

Parameters

Throws

\InvalidArgumentException

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

Returns

deduplicateTypes()

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

Parameters

Returns

getBuilder()

getBuilder() : ?\phpDocumentor\Descriptor\ProjectDescriptorBuilder

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

Returns

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 ProjectDescriptorBuilder::buildDescriptor()} method.

Parameters

assembleDocBlock()

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

Assemble DocBlock.

Parameters

extractPackageFromDocBlock()

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

Extracts the package from the DocBlock.

Parameters

Returns