Docs For Class parserVar

Description

author: Greg Beaver <[email protected]>
version: $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
copyright: 2002-2008 Gregory Beaver
since: 1.0rc1

Located in /phpDocumentor/ParserElements.inc (line 1415)

parserBase
   |
   --parserElement
      |
      --parserVar

Variable Summary

string $class

string $type

array $_modifiers

Method Summary

parserVar parserVar (string $class)

string getClass ()

mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])

array getModifiers ()

mixed getOverrides (Converter &$c)

array getOverridingVars (Converter &$c)

array getOverridingVarsForClass (Converter &$c, parserClass &$class)

string setModifiers ( $m)

Variables

string $class = '' (line 1423)

var: class that contains this var

string $type = 'var' (line 1421)

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

var: always 'var'

Redefinition of:

parserBase::$type: Type is used by many functions to skip the hassle of if

array $_modifiers (line 1425)

Inherited Variables

Inherited from parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$endlinenumber
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Inherited from parserBase

parserBase::$value

Methods

Constructor parserVar (line 1430)

parserVar parserVar (string $class)

string $class

getClass (line 1439)

Retrieve the class name

return: Class name that this var belongs to

string getClass ()

getLink (line 1468)

quick way to link to this element

return: converter-specific link to this var

mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])

Converter $c
string $text: text to display for the link or false for default text
$returnobj

getModifiers (line 1448)

Return a list of access modifiers (static/private/etc.)

array getModifiers ()

getOverrides (line 1481)

return: parserVar representing var this var overrides from the parent class, or false if none

mixed getOverrides (Converter &$c)

Converter &$c

getOverridingVars (line 1540)

return: an array of parserVars from ALL child classes that override this var
usedby: Converter::getFormattedDescVars()

array getOverridingVars (Converter &$c)

Converter &$c

getOverridingVarsForClass (line 1552)

return: an array of parserVars from ALL child classes that override this var in the given class

array getOverridingVarsForClass (Converter &$c, parserClass &$class)

Converter &$c
parserClass &$class

setModifiers (line 1457)

Return name of the class that contains this method

string setModifiers ( $m)

$m

Inherited Methods

Inherited From parserElement

parserElement::getEndLineNumber()
parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setEndLineNumber()
parserElement::setFile()
parserElement::setLineNumber()
parserElement::setName()
parserElement::setPath()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()