Deprecated
extends BaseTag
in package
implements
StaticMethod
Reflection class for a {@}deprecated tag in a Docblock.
Interfaces, Classes, Traits and Enums
Table of Contents
- REGEX_VECTOR = '(?: # Normal release vectors. \\d\\S* | # VCS version vectors. Per PHPCS, they are expected to # follow the form of the VCS name, followed by ":", followed # by the version vector itself. # By convention, popular VCSes like CVS, SVN and GIT use "$" # around the actual version vector. [^\\s\\:]+\\:\\s*\\$[^\\$]+\\$ )'
- PCRE regular expression matching a version vector.
- $description : Description|null
- $name : string
- $version : string|null
- __construct() : mixed
- __toString() : string
- Returns a string representation for this tag.
- create() : static
- getDescription() : Description|null
- getName() : string
- Gets the name of this tag.
- getVersion() : string|null
- Gets the version section of the tag.
- render() : string
Constants
REGEX_VECTOR
PCRE regular expression matching a version vector.
public
mixed
REGEX_VECTOR
= '(?:
# Normal release vectors.
\\d\\S*
|
# VCS version vectors. Per PHPCS, they are expected to
# follow the form of the VCS name, followed by ":", followed
# by the version vector itself.
# By convention, popular VCSes like CVS, SVN and GIT use "$"
# around the actual version vector.
[^\\s\\:]+\\:\\s*\\$[^\\$]+\\$
)'
Assumes the "x" modifier.
Properties
$description
protected
Description|null
$description
Description of the tag.
$name
protected
string
$name
= 'deprecated'
$version
private
string|null
$version
The version vector.
Methods
__construct()
public
__construct([string|null $version = null ][, Description|null $description = null ]) : mixed
Parameters
- $version : string|null = null
- $description : Description|null = null
Return values
mixed —__toString()
Returns a string representation for this tag.
public
__toString() : string
Return values
string —create()
public
static create(string|null $body[, DescriptionFactory|null $descriptionFactory = null ][, Context|null $context = null ]) : static
Parameters
- $body : string|null
- $descriptionFactory : DescriptionFactory|null = null
- $context : Context|null = null
Return values
static —getDescription()
public
getDescription() : Description|null
Return values
Description|null —getName()
Gets the name of this tag.
public
getName() : string
Return values
string —The name of this tag.
getVersion()
Gets the version section of the tag.
public
getVersion() : string|null
Return values
string|null —render()
public
render([Formatter|null $formatter = null ]) : string
Parameters
- $formatter : Formatter|null = null