phpDocumentor » \phpDocumentor_Reflection_DocBlock_Tag

Reflection class for a @throws tag in a Docblock.

category	phpDocumentor
package	Reflection
author	Mike van Riel
license	MIT
link	http://phpdoc.org

Methods

Parses a tag and populates the member variables.

__construct(string $type, string $content)

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::__construct()

Parameters

$type

string

Tag identifier for this tag (should be 'return')

$content

string

Contents for this tag.

Exceptions

`\phpDocumentor_Reflection_Exception`	if an invalid tag line was presented

Returns the exported information (we should use the export static method BUT this throws an exception at this point).

__toString() : void

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::__toString()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::__toString()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::__toString()

Factory method responsible for instantiating the correct sub type.

createInstance(string $tag_line) : \phpDocumentor_Reflection_DocBlock_Tag

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::createInstance()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::createInstance()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::createInstance()

Parameters

$tag_line

string

The text for this tag, including description.

Exceptions

`\phpDocumentor_Reflection_Exception`	if an invalid tag line was presented.

Returns

\phpDocumentor_Reflection_DocBlock_Tag

Builds a string representation of this object.

export() : void

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::export()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::export()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::export()

Returns the content of this tag.

getContent() : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::getContent()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::getContent()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getContent()

Returns

string

Returns the description component of this tag.

getDescription() : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::getDescription()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::getDescription()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getDescription()

Returns

string

Get the line number of the tag

getLineNumber() : int

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::getLineNumber()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::getLineNumber()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getLineNumber()

Returns

inttag line number

Returns the name of this tag.

getName() : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::getName()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::getName()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getName()

Returns

string

Returns the type of the variable.

getType() : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getType()

Returns

string

Returns the type of the variable.

getTypes() : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getTypes()

Returns

string

Returns the variable's name.

getVariableName() : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::getVariableName()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::getVariableName()

Returns

string

Inject the docblock class

setDocBlock(phpDocumentor_Reflection_DocBlockedAbstract $docblock) : void

Inherited

This exposes some common functionality contained in the docblock abstract.

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::setDocBlock()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::setDocBlock()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::setDocBlock()

Parameters

$docblock

\phpDocumentor_Reflection_DocBlockedAbstract

DocBlock class

Set the tag line number

setLineNumber(int $number) : void

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::setLineNumber()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::setLineNumber()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::setLineNumber()

Parameters

$number

int

the line number of the tag

Sets the variable's name.

setVariableName(string $name) : void

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::setVariableName()
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::setVariableName()

Parameters

$name

string

The new name for this variable.

Properties

content of the tag

$content : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::$$content
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::$$content
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$content

description of the content of this tag

$description : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::$$description
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::$$description
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$description

docblock class

$docblock : \phpDocumentor_Reflection_DocBlockedAbstract

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::$$docblock
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::$$docblock
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$docblock

line number of the tag

$line_number : int

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::$$line_number
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::$$line_number
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$line_number

Name of the tag

$tag : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag::$$tag
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::$$tag
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$tag

$type

$type : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$type

$variableName

$variableName : string

Inherited

inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Param::$$variableName
inherited_from	\phpDocumentor_Reflection_DocBlock_Tag_Return::$$variableName