FileAssembler

in package
extends AssemblerAbstract

Assembles an FileDescriptor using an FileReflector and ParamDescriptors.

FileAssembler.php

Properties

protected$builder  : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null

Methods

publicstaticdeduplicateTypes(Type|null $type) : Type|null

Parameters

$type : Type|null

Returns

Type|null —
Inherited from
\phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract
deprecated

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

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

publicgetBuilder() : ProjectDescriptorBuilder|null

Registers the Builder with this Assembler.

publicsetBuilder(ProjectDescriptorBuilder $builder) : void

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

Parameters

$builder : ProjectDescriptorBuilder
Inherited from
\phpDocumentor\Descriptor\Builder\AssemblerAbstract

Creates a Descriptor from the provided data.

publiccreate(mixed $data) : FileDescriptor

Parameters

$data : mixed

TODO: should be FileDescriptor type, but cause weird issues

Returns

FileDescriptor —

Assemble DocBlock.

protectedassembleDocBlock(DocBlock|null $docBlock, DescriptorAbstract $target) : void

Parameters

$docBlock : DocBlock|null
$target : DescriptorAbstract
Inherited from
\phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Extracts the package from the DocBlock.

protectedextractPackageFromDocBlock(DocBlock|null $docBlock) : string|null

Parameters

$docBlock : DocBlock|null

Returns

string|null —
Inherited from
\phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract

Registers the child constants with the generated File Descriptor.

protectedaddConstants(\phpDocumentor\Reflection\Php\Constant[] $constants, FileDescriptor $fileDescriptor) : void

Parameters

$constants : \phpDocumentor\Reflection\Php\Constant[]
$fileDescriptor : FileDescriptor

Registers the child functions with the generated File Descriptor.

protectedaddFunctions(\phpDocumentor\Reflection\Php\Function_[] $functions, FileDescriptor $fileDescriptor) : void

Parameters

$functions : \phpDocumentor\Reflection\Php\Function_[]
$fileDescriptor : FileDescriptor

Registers the child classes with the generated File Descriptor.

protectedaddClasses(\phpDocumentor\Reflection\Php\Class_[] $classes, FileDescriptor $fileDescriptor) : void

Parameters

$classes : \phpDocumentor\Reflection\Php\Class_[]
$fileDescriptor : FileDescriptor

Registers the child interfaces with the generated File Descriptor.

protectedaddInterfaces(\phpDocumentor\Reflection\Php\Interface_[] $interfaces, FileDescriptor $fileDescriptor) : void

Parameters

$interfaces : \phpDocumentor\Reflection\Php\Interface_[]
$fileDescriptor : FileDescriptor

Registers the child traits with the generated File Descriptor.

protectedaddTraits(\phpDocumentor\Reflection\Php\Trait_[] $traits, FileDescriptor $fileDescriptor) : void

Parameters

$traits : \phpDocumentor\Reflection\Php\Trait_[]
$fileDescriptor : FileDescriptor

Registers the markers that were found in a File with the File Descriptor.

protectedaddMarkers(string[][] $markers, FileDescriptor $fileDescriptor) : void

Parameters

$markers : string[][]
$fileDescriptor : FileDescriptor 

protectedoverridePackageTag(File $data, FileDescriptor $fileDescriptor) : void

Parameters

$data : File
$fileDescriptor : FileDescriptor