\phpDocumentor\Descriptor\Builder\ReflectorFileAssembler

Assembles an FileDescriptor using an FileReflector and ParamDescriptors.

Summary

Methods
Properties
Constants
__construct()
create()
deduplicateTypes()
getBuilder()
setBuilder()
No public properties found
No constants found
buildDescriptor()
assembleDocBlock()
extractPackageFromDocBlock()
addConstants()
addFunctions()
addClasses()
addInterfaces()
addTraits()
addMarkers()
overridePackageTag()
$builder
N/A
No private methods found
$reducers
N/A

Properties

$reducers

$reducers : \phpDocumentor\Descriptor\Builder\AssemblerReducer[]

Type

AssemblerReducer[]

Methods

__construct()

__construct(\phpDocumentor\Descriptor\Builder\AssemblerReducer  ...$reducers) : mixed

Parameters

\phpDocumentor\Descriptor\Builder\AssemblerReducer $reducers variadic

Returns

mixed —

create()

create(\phpDocumentor\Reflection\Php\File  $data) : \phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\Php\File $data

Returns

\phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null —

deduplicateTypes()

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

Parameters

?\phpDocumentor\Reflection\Type $type

Returns

?\phpDocumentor\Reflection\Type —

getBuilder()

getBuilder() : ?\phpDocumentor\Descriptor\ProjectDescriptorBuilder

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

Returns

?\phpDocumentor\Descriptor\ProjectDescriptorBuilder —

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} method.

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

buildDescriptor()

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

Parameters

\phpDocumentor\Descriptor\Builder\Reflector\TInput $data

Returns

\phpDocumentor\Descriptor\Builder\Reflector\TDescriptor|null —

assembleDocBlock()

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

Assemble DocBlock.

Parameters

?\phpDocumentor\Reflection\DocBlock $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

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

Extracts the package from the DocBlock.

Parameters

?\phpDocumentor\Reflection\DocBlock $docBlock

Returns

?string —

addConstants()

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

Registers the child constants with the generated File Descriptor.

Parameters

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

addFunctions()

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

Registers the child functions with the generated File Descriptor.

Parameters

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

addClasses()

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

Registers the child classes with the generated File Descriptor.

Parameters

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

addInterfaces()

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

Registers the child interfaces with the generated File Descriptor.

Parameters

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

addTraits()

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

Registers the child traits with the generated File Descriptor.

Parameters

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

addMarkers()

addMarkers(string[][]  $markers, \phpDocumentor\Descriptor\FileDescriptor  $fileDescriptor) : void

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

Parameters

string[][] $markers
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor

overridePackageTag()

overridePackageTag(\phpDocumentor\Reflection\Php\File  $data, \phpDocumentor\Descriptor\FileDescriptor  $fileDescriptor) : void

Parameters

\phpDocumentor\Reflection\Php\File $data
\phpDocumentor\Descriptor\FileDescriptor $fileDescriptor