phpDocumentor

ExampleAssembler extends AssemblerAbstract
in package

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.

Table of Contents

$builder  : ProjectDescriptorBuilder|null
$finder  : ExampleFinder
$reducers  : array<string|int, AssemblerReducer>
__construct()  : mixed
Initializes this assembler with the means to find the example file on disk.
buildDescriptor()  : TDescriptor|null
Creates a new Descriptor from the given Reflector.
create()  : TDescriptor|null
deduplicateTypes()  : Type|null
getBuilder()  : ProjectDescriptorBuilder|null
Returns the builder for this Assembler or null if none is set.
setBuilder()  : void
Registers the Builder with this Assembler.
assembleDocBlock()  : void
Assemble DocBlock.
extractPackageFromDocBlock()  : string|null
Extracts the package from the DocBlock.
pretifyValue()  : string|null

Properties

Methods

__construct()

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

public __construct(ExampleFinder $finder, AssemblerReducer ...$reducers) : mixed
Parameters
$finder : ExampleFinder
$reducers : AssemblerReducer
Return values
mixed

buildDescriptor()

Creates a new Descriptor from the given Reflector.

public buildDescriptor(Example $data) : TDescriptor|null
Parameters
$data : Example
Tags
throws
InvalidArgumentException

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

Return values
TDescriptor|null

create()

public create(TInput $data) : TDescriptor|null
Parameters
$data : TInput
Return values
TDescriptor|null

deduplicateTypes()

public static deduplicateTypes(Type|null $type) : Type|null
Parameters
$type : Type|null
Tags
deprecated

the functionality in this method has been moved to the Compound type in the latest unreleased version of the TypeResolver library

Return values
Type|null

extractPackageFromDocBlock()

Extracts the package from the DocBlock.

protected extractPackageFromDocBlock(DocBlock|null $docBlock) : string|null
Parameters
$docBlock : DocBlock|null
Return values
string|null

pretifyValue()

protected pretifyValue(string|null $value) : string|null
Parameters
$value : string|null
Return values
string|null

Search results