phpDocumentor

MethodDescriptor extends TagDescriptor
in package

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

Table of Contents

$description  : DescriptionDescriptor
$errors  : Collection<string|int, Error>
$name  : string
$arguments  : Collection<string|int, ArgumentDescriptor>
$methodName  : string
$response  : ReturnDescriptor|null
$static  : bool
__construct()  : mixed
Initializes the tag by setting the name and errors,
__toString()  : string
getArguments()  : Collection<string|int, ArgumentDescriptor>
getDescription()  : DescriptionDescriptor
Returns the description for this tag,
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getMethodName()  : string
getName()  : string
Returns the name for this tag.
getResponse()  : ReturnDescriptor|null
isStatic()  : bool
setArguments()  : void
setDescription()  : void
Sets a description for this tab instance.
setErrors()  : void
Sets a list of errors found on the usage of this tag.
setMethodName()  : void
setResponse()  : void
setStatic()  : void
setName()  : void
Sets the name for this tag.

Properties

Methods

__construct()

Initializes the tag by setting the name and errors,

public __construct(string $name) : mixed
Parameters
$name : string
Return values
mixed

__toString()

public __toString() : string
Return values
string

getMethodName()

public getMethodName() : string
Return values
string

getName()

Returns the name for this tag.

public getName() : string
Return values
string

setMethodName()

public setMethodName(string $methodName) : void
Parameters
$methodName : string
Return values
void

setStatic()

public setStatic(bool $static) : void
Parameters
$static : bool
Return values
void

setName()

Sets the name for this tag.

protected setName(string $name) : void
Parameters
$name : string
Return values
void

Search results