DeprecatedDescriptor
extends TagDescriptor
in package
FinalYes
Descriptor representing the deprecated tag with a descriptor.
Table of Contents
Properties
- $description : DescriptionDescriptor|null
- $errors : Collection<string|int, Error>
- $name : string
- $version : string
Methods
- __construct() : mixed
- Initializes the tag by setting the name and errors,
- __toString() : string
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getErrors() : Collection<string|int, Error>
- Returns all errors associated with this tag.
- getName() : string
- Returns the name for this element.
- getVersion() : string
- Returns the version since when the associated element was deprecated.
- setDescription() : void
- Sets a description or none to inherit from a parent.
- setVersion() : void
- Sets the version since when the associated element was deprecated.
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
= ''
$version
private
string
$version
= ''
represents the version since when the element was deprecated.
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
stringgetDescription()
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>getName()
Returns the name for this element.
public
getName() : string
Return values
stringgetVersion()
Returns the version since when the associated element was deprecated.
public
getVersion() : string
Return values
stringsetDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
setVersion()
Sets the version since when the associated element was deprecated.
public
setVersion(string $version) : void
Parameters
- $version : string