\phpDocumentor\Descriptor\TagMethodDescriptor

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

Summary

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

Properties

$name

$name : string

Type

string — Name of the tag.

$description

$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

DescriptionDescriptor — A description line for this tag

$errors

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

Type

Error> — A collection of errors found during filtering.

$methodName

$methodName : string

Type

string

$arguments

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

Type

ArgumentDescriptor>

$response

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

Type

ReturnDescriptor

$static

$static : bool

Type

bool

Methods

__construct()

__construct(string  $name) : mixed

Initializes the tag by setting the name and errors,

Parameters

string $name

Returns

mixed —

getName()

getName() : string

Returns the name for this tag.

Returns

string —

setDescription()

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

Sets a description for this tab instance.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getDescription()

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

Returns the description for this tag,

Returns

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

__toString()

__toString() : string

Returns

string —

setErrors()

setErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>  $errors) : void

Sets a list of errors found on the usage of this tag.

Parameters

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

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 —

setName()

setName(string  $name) : void

Sets the name for this tag.

Parameters

string $name