DocBlockReflection Class Reference

Public Member Functions
	__construct ($commentOrReflector, DocBlockTagManager $tagManager=null)
	getContents ()
	Retrieve contents of DocBlock.
	getStartLine ()
	Get start line (position) of DocBlock.
	getEndLine ()
	Get last line (position) of DocBlock.
	getShortDescription ()
	Get DocBlock short description.
	getLongDescription ()
	Get DocBlock long description.
	hasTag ($name)
	Does the DocBlock contain the given annotation tag?
	getTag ($name)
	Retrieve the given DocBlock tag.
	getTags ($filter=null)
	Get all DocBlock annotation tags.
	toString ()
	__toString ()
	Serialize to string.

Static Public Member Functions
static	export ()
	Export reflection.

Protected Member Functions
	reflect ()
	Parse the DocBlock.

Protected Attributes
	$reflector = null
	$docComment = null
	$tagManager = null
	$startLine = null
	$endLine = null
	$cleanDocComment = null
	$longDescription = null
	$shortDescription = null
	$tags = []
	$isReflected = false

Constructor & Destructor Documentation

__construct	(		$commentOrReflector,
		DocBlockTagManager	$tagManager = null
	)

Parameters

Reflector | string	$commentOrReflector
null | DocBlockTagManager	$tagManager

Exceptions

Exception\InvalidArgumentException

Returns

DocBlockReflection

Member Function Documentation

__toString

(

)

Serialize to string.

Required by the Reflector interface

Returns

string

static export ( )

static

Export reflection.

Required by the Reflector interface.

Todo:

What should this do?

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

(

$name

)

Retrieve the given DocBlock tag.

Parameters

string

$name

Returns

DocBlockTagInterface|false

getTags

(

$filter = null

)

Get all DocBlock annotation tags.

Parameters

string

$filter

Returns

DocBlockTagInterface[]

hasTag

(

$name

)

Does the DocBlock contain the given annotation tag?

Parameters

string

$name

Returns

bool

reflect ( )

protected

Parse the DocBlock.

Returns

void

toString

(

)

Returns

string

Implements ReflectionInterface.

Member Data Documentation

$cleanDocComment = null

protected

$docComment = null

protected

$endLine = null

protected

$isReflected = false

protected

$longDescription = null

protected

$reflector = null

protected

$shortDescription = null

protected

$startLine = null

protected

$tagManager = null

protected

$tags = []

protected