\phpDocumentor\Descriptor\Builder\Reflector\TagsTypeCollectionAssembler

Creates a Collection of type-related value objects for the given Type Collection from the Reflector.

Summary

Methods
Properties
Constants
getBuilder()
setBuilder()
create()
No public properties found
No constants found
assembleDocBlock()
extractPackageFromDocBlock()
createDescriptorForType()
isArrayNotation()
extractTypeFromArrayNotation()
convertToArrayDescriptor()
findClassNameForType()
$builder
$typeToValueObjectClassName
N/A
No private methods found
No private properties found
N/A

Properties

$typeToValueObjectClassName

$typeToValueObjectClassName : array<mixed,string>

Type

array<mixed,string> — a mapping of types to class names of the Value Object class that describes each type

Methods

setBuilder()

setBuilder(\phpDocumentor\Descriptor\ProjectDescriptorBuilder  $builder) : void

Registers the Builder with this Assembler.

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

Parameters

\phpDocumentor\Descriptor\ProjectDescriptorBuilder $builder

create()

create(\phpDocumentor\Reflection\DocBlock\Type\Collection  $data) : \phpDocumentor\Descriptor\Collection

Creates a Descriptor from the provided data.

Parameters

\phpDocumentor\Reflection\DocBlock\Type\Collection $data

Returns

\phpDocumentor\Descriptor\Collection

assembleDocBlock()

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

Assemble DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock|null $docBlock
\phpDocumentor\Descriptor\DescriptorAbstract $target

extractPackageFromDocBlock()

extractPackageFromDocBlock(\phpDocumentor\Reflection\DocBlock  $docBlock) : string|null

Extracts the package from the DocBlock.

Parameters

\phpDocumentor\Reflection\DocBlock $docBlock

Returns

string|null

createDescriptorForType()

createDescriptorForType(string  $type) : \phpDocumentor\Descriptor\DescriptorAbstract

Creates a Type ValueObject (Descriptor) for the provided type string.

Parameters

string $type

Returns

\phpDocumentor\Descriptor\DescriptorAbstract

isArrayNotation()

isArrayNotation(string  $type) : boolean

Detects if the given string representing a type equals an array.

Parameters

string $type

Returns

boolean

extractTypeFromArrayNotation()

extractTypeFromArrayNotation(string  $type) : string

Returns the value-type from an array notation.

Parameters

string $type

Returns

string

findClassNameForType()

findClassNameForType(string  $type) : string|boolean

Returns the class name of the Value Object class associated with a given type or false if the type is unknown.

Parameters

string $type

Returns

string|boolean