Zend_Reflection_Docblock Class Reference

Public Member Functions
	__toString ()
	Serialize to string.
	__construct ($commentOrReflector)
	Constructor.
	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.

Static Public Member Functions
static	export ()
	Export reflection.

Protected Member Functions
	_parse ()
	Parse the docblock.

Protected Attributes
	$_reflector = null
	$_startLine = null
	$_endLine = null
	$_docComment = null
	$_cleanDocComment = null
	$_longDescription = null
	$_shortDescription = null
	$_tags = array()

Constructor & Destructor Documentation

__construct

(

$commentOrReflector

)

Constructor.

Parameters

Reflector | string

$commentOrReflector

Member Function Documentation

__toString

(

)

Serialize to string.

Required by the Reflector interface

Todo:

What should this return?

Returns

string

_parse ( )

protected

Parse the docblock.

Returns

void

static export ( )

static

Export reflection.

Reqired 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

Zend_Reflection_Docblock_Tag|false

getTags

(

$filter = null

)

Get all docblock annotation tags.

Parameters

string

$filter

Returns

array Array of Zend_Reflection_Docblock_Tag

hasTag

(

$name

)

Does the docblock contain the given annotation tag?

Parameters

string

$name

Returns

bool

Member Data Documentation

$_cleanDocComment = null

protected

$_docComment = null

protected

$_endLine = null

protected

$_longDescription = null

protected

$_reflector = null

protected

$_shortDescription = null

protected

$_startLine = null

protected

$_tags = array()

protected