MethodDescriptor

in package
extends TagDescriptor

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

MethodDescriptor.php

Properties

protected$name  : string                

protected$description  : string                

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

private$methodName  : string                

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

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

private$static  : bool

Methods

Initializes the tag by setting the name and errors,

public__construct(string $name) : mixed

Parameters

$name : string

Returns

mixed —

Returns the name for this tag.

publicgetName() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Sets a description for this tab instance.

publicsetDescription(string $description) : void

Parameters

$description : string
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Returns the description for this tag,

publicgetDescription() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

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

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

Parameters

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

Returns all errors associated with this tag.

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —
Inherited from
\phpDocumentor\Descriptor\TagDescriptor

publicsetMethodName(string $methodName) : void

Parameters

$methodName : string 

publicgetMethodName() : string

Returns

string — 

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

Parameters

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

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

Returns

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

publicsetResponse(ReturnDescriptor|null $response) : void

Parameters

$response : ReturnDescriptor|null 

publicgetResponse() : ReturnDescriptor|null

Returns

ReturnDescriptor|null — 

publicsetStatic(bool $static) : void

Parameters

$static : bool 

publicisStatic() : bool

Returns

bool —

Sets the name for this tag.

protectedsetName(string $name) : void

Parameters

$name : string
Inherited from
\phpDocumentor\Descriptor\TagDescriptor