phpDocumentor phpDocumentor
DocBlockTags
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserVarTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserVarTag

Class Overview

represents the "@var" tag

Located in /phpDocumentor/DocBlockTags.inc [line 576]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag
            |
            --parserVarTag
Author(s): Information Tags:
Tutorial:  @var
Version:  Release: @VER@
Copyright:  2002-2008 Gregory Beaver
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
Todo:  CS cleanup - change classname to PhpDocumentor_*
Since:  1.0rc1
License:  LGPL

Properties

[ Top ]
Descendants
Child Class Description
parserParamTag represents the "@param" tag

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserReturnTag

parserReturnTag::$converted_returnType

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserReturnTag

parserReturnTag::parserReturnTag()
set up the tag
parserReturnTag::Convert()
process this tag through the given output converter (sets up the $converted_returnType)

Inherited From parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString()
Returns the text minus any inline tags
parserTag::HandleEvent()
Called by the parserDescParser when processing a description.

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Inherited From parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

[ Top ]
Property Summary
string   $keyword   always 'var'
string   $returnType   the type a var has

[ Top ]
Properties
string   $keyword = 'var' [line 582]

always 'var'


Redefinition of:
parserReturnTag::$keyword
always 'return'

Redefined in descendants as:

[ Top ]
string   $returnType = 'mixed' [line 587]

the type a var has


Redefinition of:
parserReturnTag::$returnType
the type a function returns

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:17 -0600 by phpDocumentor 1.4.4