phpDocumentor
Back to top  

Reflection class for a @param 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) 

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()

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()

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()

Returns the content of this tag.

getContent() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getContent()

Returns

string

Returns the description component of this tag.

getDescription() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getDescription()

Returns

string

Get the line number of the tag

getLineNumber() : int
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getLineNumber()

Returns

inttag line number

Returns the name of this tag.

getName() : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::getName()

Returns

string

Returns the type section of the variable.

getType() : string

Returns

string

Returns the unique types of the variable.

getTypes() : \string[]

Returns

\string[]

Returns the variable's name.

getVariableName() : string

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()

Parameters

$docblock

\phpDocumentor_Reflection_DocBlockedAbstract

DocBlock class

Set the tag line number

setLineNumber(int $number) : void
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::setLineNumber()

Parameters

$number

int

the line number of the tag

Sets the variable's name.

setVariableName(string $name) : void

Parameters

$name

string

The new name for this variable.

 Properties

 

content of the tag

$content : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$content
 

description of the content of this tag

$description : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$description
 

docblock class

$docblock : \phpDocumentor_Reflection_DocBlockedAbstract
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$docblock
 

line number of the tag

$line_number : int
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$line_number
 

Name of the tag

$tag : string
Inherited

inherited_from \phpDocumentor_Reflection_DocBlock_Tag::$$tag
 

$type

$type : string

 

$variableName

$variableName : string