Class DocBlockReflection

Summary

Fully Qualified Name: Zend\Code\Reflection\DocBlockReflection
Implements: ReflectionInterface

Description

Methods

Name Description Defined By
__construct() DocBlockReflection
__toString() Serialize to string DocBlockReflection
export() Export reflection DocBlockReflection
getContents() Retrieve contents of DocBlock DocBlockReflection
getEndLine() Get last line (position) of DocBlock DocBlockReflection
getLongDescription() Get DocBlock long description DocBlockReflection
getShortDescription() Get DocBlock short description DocBlockReflection
getStartLine() Get start line (position) of DocBlock DocBlockReflection
getTag() Retrieve the given DocBlock tag DocBlockReflection
getTags() Get all DocBlock annotation tags DocBlockReflection
hasTag() Does the DocBlock contain the given annotation tag? DocBlockReflection
toString() DocBlockReflection

Method Details

__construct()

Parameter Name Type Description
$commentOrReflector \Reflector|string
$tagManager null|\DocBlockTagManager

Returns: \DocBlockReflection

__toString()

Serialize to string

Required by the Reflector interface

Returns: string

export()

Export reflection

Required by the Reflector interface.

Returns: void

getContents()

Retrieve contents of DocBlock

Returns: string

getEndLine()

Get last line (position) of DocBlock

Returns: int

getLongDescription()

Get DocBlock long description

Returns: string

getShortDescription()

Get DocBlock short description

Returns: string

getStartLine()

Get start line (position) of DocBlock

Returns: int

getTag()

Retrieve the given DocBlock tag

Parameter Name Type Description
$name string

Returns: \DocBlockTagInterface|bool

getTags()

Get all DocBlock annotation tags

Parameter Name Type Description
$filter string

Returns: \DocBlockTagInterface[]

hasTag()

Does the DocBlock contain the given annotation tag?

Parameter Name Type Description
$name string

Returns: bool

toString()

Returns: string

Top