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
$description
protected
DescriptionDescriptor|null
$description
= null
$errors
protected
Collection<string|int, Error>
$errors
A collection of errors found during filtering.
$name
protected
string
$name
= ''
$arguments
private
Collection<string|int, ArgumentDescriptor>
$arguments
$hasReturnByReference
private
bool
$hasReturnByReference
= false
$methodName
private
string
$methodName
= ''
$response
private
ReturnDescriptor|null
$response
= null
$static
private
bool
$static
= false
Methods
__construct()
Initializes the tag by setting the name and errors,
public
__construct(string $name[, DescriptionDescriptor|null $description = null ]) : mixed
Parameters
- $name : string
- $description : DescriptionDescriptor|null = null
__toString()
public
__toString() : string
Return values
stringgetArguments()
public
getArguments() : Collection<string|int, ArgumentDescriptor>
Return values
Collection<string|int, ArgumentDescriptor>getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetErrors()
Returns all errors associated with this tag.
public
getErrors() : Collection<string|int, Error>
Return values
Collection<string|int, Error>getHasReturnByReference()
public
getHasReturnByReference() : bool
Return values
boolgetMethodName()
public
getMethodName() : string
Return values
stringgetName()
Returns the name for this element.
public
getName() : string
Return values
stringgetResponse()
public
getResponse() : ReturnDescriptor|null
Return values
ReturnDescriptor|nullisStatic()
public
isStatic() : bool
Return values
boolsetArguments()
public
setArguments(Collection<string|int, ArgumentDescriptor> $arguments) : void
Parameters
- $arguments : Collection<string|int, ArgumentDescriptor>
setDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
setHasReturnByReference()
public
setHasReturnByReference(bool $hasReturnByReference) : void
Parameters
- $hasReturnByReference : bool
setMethodName()
public
setMethodName(string $methodName) : void
Parameters
- $methodName : string
setResponse()
public
setResponse(ReturnDescriptor|null $response) : void
Parameters
- $response : ReturnDescriptor|null
setStatic()
public
setStatic(bool $static) : void
Parameters
- $static : bool