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\TagMethodDescriptor

Base class for any tag descriptor and used when a tag has no specific descriptor.

Summary

Methods
Properties
Constants
__construct()
__toString()
getName()
setDescription()
getDescription()
getErrors()
setMethodName()
getMethodName()
setArguments()
getArguments()
setResponse()
getResponse()
setStatic()
isStatic()
setHasReturnByReference()
getHasReturnByReference()
No public properties found
No constants found
No protected methods found
$name
$description
$errors
N/A
No private methods found
$methodName
$arguments
$response
$static
$hasReturnByReference
N/A

Properties

$name

$name : string

Type

string

$description

$description : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> — A collection of errors found during filtering.

$methodName

$methodName : string

Type

string —

$arguments

$arguments : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor> —

$response

$response : ?\phpDocumentor\Descriptor\Tag\ReturnDescriptor

Type

?\phpDocumentor\Descriptor\Tag\ReturnDescriptor —

$static

$static : bool

Type

bool —

$hasReturnByReference

$hasReturnByReference : bool

Type

bool —

Methods

__construct()

__construct(string  $name) : mixed

Initializes the tag by setting the name and errors,

Parameters

string $name

Returns

mixed —

__toString()

__toString() : string

Returns

string —

getName()

getName() : string

Returns the name for this element.

Returns

string —

setDescription()

setDescription(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors associated with this tag.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

setMethodName()

setMethodName(string  $methodName) : void

Parameters

string $methodName

getMethodName()

getMethodName() : string

Returns

string —

setArguments()

setArguments(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor>  $arguments) : void

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor> $arguments

getArguments()

getArguments() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ArgumentDescriptor> —

setResponse()

setResponse(?\phpDocumentor\Descriptor\Tag\ReturnDescriptor  $response) : void

Parameters

?\phpDocumentor\Descriptor\Tag\ReturnDescriptor $response

getResponse()

getResponse() : ?\phpDocumentor\Descriptor\Tag\ReturnDescriptor

Returns

?\phpDocumentor\Descriptor\Tag\ReturnDescriptor —

setStatic()

setStatic(bool  $static) : void

Parameters

bool $static

isStatic()

isStatic() : bool

Returns

bool —

setHasReturnByReference()

setHasReturnByReference(bool  $hasReturnByReference) : void

Parameters

bool $hasReturnByReference

getHasReturnByReference()

getHasReturnByReference() : bool

Returns

bool —