phpDocumentor
\
phpDocumentor
Compiler
Linker
Pass
Configuration
Definition
Exception
Console
Command
Project
DependencyInjection
Descriptor
Builder
Reflector
Docblock
Tags
Cache
DocBlock
Example
Exception
Filter
Interfaces
ProjectDescriptor
Query
TableOfContents
Tag
BaseTypes
Traits
Validation
ValueObjects
Event
Guides
DependencyInjection
Handlers
References
Resolver
Php
Parser
Cache
Event
Exception
Middleware
Pipeline
Stage
Cache
Parser
Transformer
Event
Router
Template
Writer
Exception
Graph
Twig
LinkRenderer

\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()
overridePackageTag()
$builder
N/A
addEnums()
$reducers
N/A

Properties

$builder

$builder : \phpDocumentor\Descriptor\ProjectDescriptorBuilder|null

Type

\phpDocumentor\Descriptor\ProjectDescriptorBuilder|null —

$reducers

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

Type

\phpDocumentor\Descriptor\Builder\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 ProjectDescriptorBuilder::buildDescriptor()} 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\Interfaces\FileInterface  $fileDescriptor) : void

Registers the child constants with the generated File Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Constant[] $constants
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor

addFunctions()

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

Registers the child functions with the generated File Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Function_[] $functions
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor

addClasses()

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

Registers the child classes with the generated File Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Class_[] $classes
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor

addInterfaces()

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

Registers the child interfaces with the generated File Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Interface_[] $interfaces
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor

addTraits()

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

Registers the child traits with the generated File Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Trait_[] $traits
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor

overridePackageTag()

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

Parameters

\phpDocumentor\Reflection\Php\File $data
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor

addEnums()

addEnums(\phpDocumentor\Reflection\Php\Enum_[]  $enums, \phpDocumentor\Descriptor\Interfaces\FileInterface  $fileDescriptor) : void

Registers the child classes with the generated File Descriptor.

Parameters

\phpDocumentor\Reflection\Php\Enum_[] $enums
\phpDocumentor\Descriptor\Interfaces\FileInterface $fileDescriptor