$curfile = false (line 725)

Data type : string

• var: - same as parserElement::$path

$extends = false (line 695)

Data type : mixed

• var: - false or contents of extends clause in class declaration

$ignore = false (line 720)

Data type : boolean

Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing

• see: - Classes::getParentClass()

$parent = false (line 714)

Data type : mixed

Format: array(file, parent) where parent class is found or false if no parent

$sourceLocation = '' (line 691)

Data type : string

• see: - parserPage::$sourceLocation

$tutorial = false (line 729)

Data type : tutorialLink|false

• var: - either a link to the tutorial associated with this class, or false

$type = 'class' (line 688)

Data type : string

Overrides: Array

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

• var: - always 'class'

$_implements = array() (line 699)

Data type : array

• var: - a list of interfaces this class implements

Method addImplements (line 1379)

void addImplements( string $implements)

Parameters

• string $implements:

Info

Method addTutorial (line 755)

void addTutorial( parserTutorial $t, Converter &$c)

Parameters

• parserTutorial $t:
• Converter &$c:

Info

Method getChildClassList (line 1308)

array getChildClassList( Converter &$c)

returns a list of all child classes of this class

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - Format: array(parserClass child1,parserClass child2,...)
• usedby - XMLDocBookpeardoc2Converter::generateChildClassList()
• usedby - Converter::generateChildClassList()

Method getConflicts (line 776)

mixed getConflicts( Converter &$c)

Returns all classes in other packages that have the same name as this class

Parameters

• Converter &$c:

Info

• return - false or an array Format: (package => parserClass of conflicting classes)
• usedby - Converter::getFormattedConflicts()

Method getConstNames (line 1034)

array getConstNames( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns a simple array of const name strings

Method getConsts (line 1009)

array getConsts( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns a simple array of const objects

Method getExtends (line 1396)

boolean getExtends( [ $raw = false])

Parameters

• $raw:

Info

• see - parserClass::$extends

Method getImplements (line 1387)

array getImplements( )

Info

Method getInheritedConsts (line 1225)

array getInheritedConsts( Converter &$c, [boolean $override = false], [ $consts = false])

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• boolean $override: determines whether overriden vars should be included in the list of inherited vars
• $consts:

Info

• return - returns an array of consts by parent classname array(name => array(const1,const2..),name2 => array(const1....))

Method getInheritedMethods (line 1051)

array getInheritedMethods( Converter &$c, [boolean $override = false])

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• boolean $override: determines whether overriden methods should be included in the list of inherited methods

Info

• return - returns an array of methods by parent classname array(name => array(method1,method2..),name2 => array(method1....))

Method getInheritedVars (line 1149)

array getInheritedVars( Converter &$c, [boolean $override = true], [ $vars = false])

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• boolean $override: determines whether overriden vars should be included in the list of inherited vars
• $vars:

Info

• return - returns an array of vars by parent classname array(name => array(var1,var1..),name2 => array(var1....))

Method getLink (line 789)

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 class

Method getMethod (line 914)

mixed getMethod( Converter &$c, string $name, [boolean $inherited = false])

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• string $name: method name in this class
• boolean $inherited: determines whether to search inherited methods as well

Info

• return - parserMethod or false if not found

Method getMethodNames (line 943)

array getMethodNames( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns a simple array of method name strings

Method getMethods (line 903)

array getMethods( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns a simple array of method objects

Method getModifiers (line 736)

array|false getModifiers( )

Get the PHP5+ modifiers for this class

Info

Method getParent (line 889)

mixed &getParent( Converter &$c)

retrieve object that represents the parent class

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns the parserClass representation of the parent class, or false if no parent class

Method getParentClassTree (line 1289)

array getParentClassTree( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - Format: array(parentclassname => parserClass/false if no parent, parentclassname2 => ...)
• usedby - CHMdefaultConverter::generateFormattedClassTree()
• usedby - XMLDocBookConverter::generateFormattedClassTree()
• usedby - XMLDocBookpeardoc2Converter::generateFormattedClassTree()
• usedby - HTMLSmartyConverter::generateFormattedClassTree()
• usedby - HTMLframesConverter::generateFormattedClassTree()

Method getSourceLocation (line 1337)

string getSourceLocation( Converter $c, [boolean $pearize = false])

Parameters

• Converter $c:
• boolean $pearize:

Info

• see - parserClass::$sourceLocation

Method getTutorial (line 766)

parserTutorial getTutorial( )

Get the associated tutorial for this class, if any

Info

• tutorial - phpDocumentor Tutorials

Method getVar (line 934)

mixed getVar( Converter &$c, string $name)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• string $name: var name in this class

Info

• return - parserVar or false if not found

Method getVarNames (line 1018)

array getVarNames( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns a simple array of var name strings

Method getVars (line 1000)

array getVars( Converter &$c)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing

Info

• return - returns a simple array of var objects

Method hasConst (line 991)

boolean hasConst( Converter &$c, string $name)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• string $name: class constant name

Info

• return - whether this class has a constant of name $name

Method hasMethod (line 961)

boolean hasMethod( Converter &$c, string $name, [boolean $inherited = false])

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• string $name: method name
• boolean $inherited: determines whether to search inherited methods as well

Info

• return - whether this class has a method of name $name

Method hasVar (line 981)

boolean hasVar( Converter &$c, string $name)

Parameters

• Converter &$c: this function will not work before the Conversion stage of parsing
• string $name: var name

Info

• return - whether this class has a var of name $name

Method isInterface (line 870)

boolean isInterface( )

Info

• return - true if this is an interface class

Method setAccessModifiers (line 879)

void setAccessModifiers( array $modifiers)

Use this method to set access modifiers for a class

Parameters

• array $modifiers:

Info

Method setExtends (line 1362)

void setExtends( string $extends)

Parameters

• string $extends:

Info

• see - parserClass::$extends

Method setInterface (line 862)

void setInterface( )

Use this method to set the type of class to be an interface

Info

Method setModifiers (line 746)

void setModifiers( string $m)

Set the PHP5+ modifiers for this class

Parameters

• string $m:

Info

Method setParent (line 805)

void setParent( string $p, string $f, Classes &$c)

Parameters

• string $p: parent class name
• string $f: parent class file
• Classes &$c: Classes object currently calling setParent

Info

• see - Classes::setClassParent()

Method setParentNoClass (line 854)

void setParentNoClass( string $par)

Parameters

• string $par: parent class name (used by Classes::setClassParent() if parent class not found

Info

Method setSourceLocation (line 1326)

void setSourceLocation( string $sl)

Parameters

• string $sl:

Info

• see - parserClass::$sourceLocation