DocBlockReflection
in package
implements
ReflectionInterface
Table of Contents
Interfaces
- ReflectionInterface
Properties
- $cleanDocComment : string
- $docComment : string
- $endLine : int
- $isReflected : bool
- $longDescription : string
- $reflector : Reflector
- $shortDescription : string
- $startLine : int
- $tagManager : TagManager
- $tags : array<string|int, mixed>
Methods
- __construct() : mixed
- __toString() : string
- Serialize to string
- export() : void
- Export reflection
- getContents() : string
- Retrieve contents of DocBlock
- getEndLine() : int
- Get last line (position) of DocBlock
- getLongDescription() : string
- Get DocBlock long description
- getShortDescription() : string
- Get DocBlock short description
- getStartLine() : int
- Get start line (position) of DocBlock
- getTag() : TagInterface|false
- Retrieve the given DocBlock tag
- getTags() : array<string|int, TagInterface>
- Get all DocBlock annotation tags
- hasTag() : bool
- Does the DocBlock contain the given annotation tag?
- toString() : string
- reflect() : void
- Parse the DocBlock
Properties
$cleanDocComment
protected
string
$cleanDocComment
$docComment
protected
string
$docComment
$endLine
protected
int
$endLine
$isReflected
protected
bool
$isReflected
= false
$longDescription
protected
string
$longDescription
$reflector
protected
Reflector
$reflector
$shortDescription
protected
string
$shortDescription
$startLine
protected
int
$startLine
$tagManager
protected
TagManager
$tagManager
$tags
protected
array<string|int, mixed>
$tags
= []
Methods
__construct()
public
__construct(Reflector|string $commentOrReflector[, TagManager|null $tagManager = null ]) : mixed
Parameters
- $commentOrReflector : Reflector|string
- $tagManager : TagManager|null = null
Tags
__toString()
Serialize to string
public
__toString() : string
Required by the Reflector interface
Return values
stringexport()
Export reflection
public
static export() : void
Required by the Reflector interface.
Tags
getContents()
Retrieve contents of DocBlock
public
getContents() : string
Return values
stringgetEndLine()
Get last line (position) of DocBlock
public
getEndLine() : int
Return values
intgetLongDescription()
Get DocBlock long description
public
getLongDescription() : string
Return values
stringgetShortDescription()
Get DocBlock short description
public
getShortDescription() : string
Return values
stringgetStartLine()
Get start line (position) of DocBlock
public
getStartLine() : int
Return values
intgetTag()
Retrieve the given DocBlock tag
public
getTag(string $name) : TagInterface|false
Parameters
- $name : string
Return values
TagInterface|falsegetTags()
Get all DocBlock annotation tags
public
getTags([string $filter = null ]) : array<string|int, TagInterface>
Parameters
- $filter : string = null
Return values
array<string|int, TagInterface>hasTag()
Does the DocBlock contain the given annotation tag?
public
hasTag(string $name) : bool
Parameters
- $name : string
Return values
booltoString()
public
toString() : string
Return values
stringreflect()
Parse the DocBlock
protected
reflect() : void