ThrowsDescriptor
extends ReturnDescriptor
in package
Descriptor representing the throws tag on a class or trait.
Table of Contents
- $description : DescriptionDescriptor
- $errors : Collection<string|int, Error>
- $name : string
- $types : Type|null
- __construct() : mixed
- Initializes the tag by setting the name and errors,
- __toString() : string
- getDescription() : DescriptionDescriptor
- Returns the description for this tag,
- getErrors() : Collection<string|int, Error>
- Returns all errors associated with this tag.
- getName() : string
- Returns the name for this tag.
- getType() : Type|null
- getTypes() : array<int, Type>
- Returns the list of types associated with this tag.
- setDescription() : void
- Sets a description for this tab instance.
- setErrors() : void
- Sets a list of errors found on the usage of this tag.
- setType() : void
- Sets a list of types associated with this tag.
- setTypes() : void
- Sets a list of types associated with this tag.
- setName() : void
- Sets the name for this tag.
Properties
$description
protected
DescriptionDescriptor
$description
A description line for this tag
$errors
protected
Collection<string|int, Error>
$errors
A collection of errors found during filtering.
$name
protected
string
$name
Name of the tag.
$types
protected
Type|null
$types
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
Return values
mixed —__toString()
public
__toString() : string
Return values
string —getDescription()
Returns the description for this tag,
public
getDescription() : DescriptionDescriptor
Return values
DescriptionDescriptor —getErrors()
Returns all errors associated with this tag.
public
getErrors() : Collection<string|int, Error>
Return values
Collection<string|int, Error> —getName()
Returns the name for this tag.
public
getName() : string
Return values
string —getType()
public
getType() : Type|null
Return values
Type|null —getTypes()
Returns the list of types associated with this tag.
public
getTypes() : array<int, Type>
Tags
Return values
array<int, Type> —setDescription()
Sets a description for this tab instance.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
Return values
void —setErrors()
Sets a list of errors found on the usage of this tag.
public
setErrors(Collection<string|int, Error> $errors) : void
Parameters
- $errors : Collection<string|int, Error>
Return values
void —setType()
Sets a list of types associated with this tag.
public
setType([Type|null $types = null ]) : void
Parameters
- $types : Type|null = null
Return values
void —setTypes()
Sets a list of types associated with this tag.
public
setTypes([Type|null $types = null ]) : void
Parameters
- $types : Type|null = null
Tags
Return values
void —setName()
Sets the name for this tag.
protected
setName(string $name) : void
Parameters
- $name : string