Description
parserBase | --parserElement | --parserVar
Located in File: /phpDocumentor/ParserElements.inc
- 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
Class Variables
Summary:
string
$class
string
$type
array
$_modifiers
$class = '' (line 1423)
Data type : string
- var: - class that contains this var
$type = 'var' (line 1421)
Data type : string
Overrides: Array
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
- var: - always 'var'
$_modifiers (line 1425)
Data type : array
Class Constants
Summary:Method Detail
Summary:
string
getClass
()
array
getModifiers
()
Constructor parserVar (line 1430)
parserVar parserVar( string $class)
Parameters
- string $class:
Info
Method getClass (line 1439)
string getClass( )
Retrieve the class name
Info
- return - Class name that this var belongs to
Method getLink (line 1468)
mixed getLink( Converter $c, [string $text = false], [ $returnobj = false])
quick way to link to this element
Parameters
- Converter $c:
- string $text: text to display for the link or false for default text
- $returnobj:
Info
- return - converter-specific link to this var
Method getModifiers (line 1448)
array getModifiers( )
Return a list of access modifiers (static/private/etc.)
Info
Method getOverrides (line 1481)
mixed getOverrides( Converter &$c)
Parameters
- Converter &$c:
Info
- return - parserVar representing var this var overrides from the parent class, or false if none
Method getOverridingVars (line 1540)
array getOverridingVars( Converter &$c)
Parameters
- Converter &$c:
Info
- return - an array of parserVars from ALL child classes that override this var
- usedby - Converter::getFormattedDescVars()
Method getOverridingVarsForClass (line 1552)
array getOverridingVarsForClass( Converter &$c, parserClass &$class)
Parameters
- Converter &$c:
- parserClass &$class:
Info
- return - an array of parserVars from ALL child classes that override this var in the given class
Method setModifiers (line 1457)
string setModifiers( $m)
Return name of the class that contains this method
Parameters
- $m: