phpDocumentor

MethodAssembler extends BaseTagAssembler
in package

Constructs a new descriptor from the Reflector for an `@method` tag.

This object will read the reflected information for the @method tag and create a MethodDescriptor object that can be used in the rest of the application and templates.

Table of Contents

Properties

$builder  : ProjectDescriptorBuilder|null
$reducers  : array<string|int, AssemblerReducer>

Methods

__construct()  : mixed
buildDescriptor()  : TDescriptor|null
Creates a new Descriptor from the given Reflector.
create()  : TDescriptor|null
Creates a Descriptor from the provided data.
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.

Properties

Methods

buildDescriptor()

Creates a new Descriptor from the given Reflector.

public buildDescriptor(Method $data) : TDescriptor|null
Parameters
$data : Method
Return values
TDescriptor|null

create()

Creates a Descriptor from the provided data.

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

deduplicateTypes()

public static deduplicateTypes(Type|null $type) : Type|null

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

Parameters
$type : Type|null
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

        
On this page

Search results