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

Class: parserVarTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserVarTag

Class Overview

represents "@var"

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

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserReturnTag
            |
            --parserVarTag
Author(s): Information Tags:
Version:  $Id: DocBlockTags.inc,v 1.8 2006/10/24 04:18:14 cellog Exp $
Since:  1.0rc1
Tutorial:  @var

Properties

[ Top ]
Direct descendents
Child Class Description
parserParamTag Represents "@param"

[ 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()
parserReturnTag::Convert()
sets up $converted_returnType

Inherited From parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
parserTag::getString()
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
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()
parserBase::getValue()
parserBase::setValue()

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

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

always 'var'


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

Redefined in descendants as:

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

the type a var has


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

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:22:22 -0500 by phpDocumentor 1.3.1