Inherited Methods
Class: parserElement
- parserElement::getEndLineNumber()
- parserElement::getFile()
- parserElement::getLineNumber()
- parserElement::getName()
- parserElement::getPackage()
- parserElement::getPath()
- parserElement::setDocBlock()
- parserElement::setEndLineNumber()
- Sets the ending line number of elements
- parserElement::setFile()
- parserElement::setLineNumber()
- Set starting line number
- parserElement::setName()
- parserElement::setPath()
Class: parserBase
- parserBase::getType()
- gets the type
- parserBase::getValue()
- gets the value
- parserBase::setValue()
- sets the given value
Class Details
Tags:
- 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
[ Top ]
Class Variables
$class = ''
[line 1423]
Tags:
- var - class that contains this var
Type: string
Overrides:
[ Top ]
$type = 'var'
[line 1421]
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
Tags:
- var - always 'var'
Type: string
Overrides: Array
[ Top ]
$_modifiers
[line 1425]
Type: array
Overrides:
[ Top ]
Class Methods
parserVar
parserVar parserVar(
string
$class)
[line 1430]
Parameters:
- string $class -
[ Top ]
getClass
string getClass(
)
[line 1439]
Retrieve the class name
Tags:
- return - Class name that this var belongs to
Parameters:
[ Top ]
getLink
mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])
[line 1468]
quick way to link to this element
Tags:
- return - converter-specific link to this var
Parameters:
- Converter $c -
- string $text - text to display for the link or false for default text
- $returnobj -
[ Top ]
getModifiers
array getModifiers(
)
[line 1448]
Return a list of access modifiers (static/private/etc.)
Parameters:
[ Top ]
getOverrides
mixed getOverrides(
Converter
&$c)
[line 1481]
Tags:
- return - parserVar representing var this var overrides from the parent class, or false if none
Parameters:
- Converter &$c -
[ Top ]
getOverridingVars
array getOverridingVars(
Converter
&$c)
[line 1540]
Tags:
- return - an array of parserVars from ALL child classes that override this var
- usedby - Converter::getFormattedDescVars()
Parameters:
- Converter &$c -
[ Top ]
getOverridingVarsForClass
array getOverridingVarsForClass(
Converter
&$c, parserClass
&$class)
[line 1552]
Tags:
- return - an array of parserVars from ALL child classes that override this var in the given class
Parameters:
- Converter &$c -
- parserClass &$class -
[ Top ]
setModifiers
string setModifiers(
$m)
[line 1457]
Return name of the class that contains this method
Parameters:
- $m -
[ Top ]