phpDocumentor

MethodDescriptor extends TagDescriptor
in package

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

Table of Contents

Properties

$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$name  : string
$arguments  : Collection<string|int, ArgumentDescriptor>
$hasReturnByReference  : bool
$methodName  : string
$response  : ReturnDescriptor|null
$static  : bool

Methods

__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 element.
getErrors()  : Collection<string|int, Error>
Returns all errors associated with this tag.
getHasReturnByReference()  : bool
getMethodName()  : string
getName()  : string
Returns the name for this element.
getResponse()  : ReturnDescriptor|null
isStatic()  : bool
setArguments()  : void
setDescription()  : void
Sets a description or none to inherit from a parent.
setHasReturnByReference()  : void
setMethodName()  : void
setResponse()  : void
setStatic()  : void

Properties

Methods

__construct()

Initializes the tag by setting the name and errors,

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

__toString()

public __toString() : string
Return values
string

getHasReturnByReference()

public getHasReturnByReference() : bool
Return values
bool

getName()

Returns the name for this element.

public getName() : string
Return values
string

setHasReturnByReference()

public setHasReturnByReference(bool $hasReturnByReference) : void
Parameters
$hasReturnByReference : bool

setMethodName()

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

setStatic()

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

        
On this page

Search results