$curfile = false
[line 725]
Tags:
$extends = false
[line 695]
Tags:
var: false or contents of extends clause in class declaration
$ignore = false
[line 720]
Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing
Tags:
$parent = false
[line 714]
Format: array(file, parent) where parent class is found or false if no parent
$sourceLocation = ''
[line 691]
Tags:
$tutorial = false
[line 729]
Tags:
var: either a link to the tutorial associated with this class, or false
$type = 'class'
[line 688]
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
Tags:
Type:
string
Overrides:
Array
$_implements = array()
[line 699]
Tags:
var: a list of interfaces this class implements
method addImplements [line 1379]
void addImplements(
string
$implements)
Parameters:
method addTutorial [line 755]
method getChildClassList [line 1308]
returns a list of all child classes of this class
Tags:
return: Format: array(parserClass child1,parserClass child2,...)
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getConflicts [line 776]
Returns all classes in other packages that have the same name as this class
Tags:
return: false or an array Format: (package =>
parserClass of conflicting classes)
Parameters:
method getConstNames [line 1034]
Tags:
return: returns a simple array of const name strings
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getConsts [line 1009]
Tags:
return: returns a simple array of const objects
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getExtends [line 1396]
boolean getExtends(
[
$raw = false])
Tags:
Parameters:
method getImplements [line 1387]
method getInheritedConsts [line 1225]
array getInheritedConsts(
Converter
&$c, [boolean
$override = false], [
$consts = false])
Tags:
return: returns an array of consts by parent classname array(name => array(const1,const2..),name2 => array(const1....))
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
method getInheritedMethods [line 1051]
array getInheritedMethods(
Converter
&$c, [boolean
$override = false])
Tags:
return: returns an array of methods by parent classname array(name => array(method1,method2..),name2 => array(method1....))
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
method getInheritedVars [line 1149]
array getInheritedVars(
Converter
&$c, [boolean
$override = true], [
$vars = false])
Tags:
return: returns an array of vars by parent classname array(name => array(var1,var1..),name2 => array(var1....))
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
method getLink [line 789]
mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])
quick way to link to this element
Tags:
return: converter-specific link to this class
Parameters:
string
$text
text to display for the link or false for default text
$returnobj
method getMethod [line 914]
mixed getMethod(
Converter
&$c, string
$name, [boolean
$inherited = false])
Tags:
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
method getMethodNames [line 943]
Tags:
return: returns a simple array of method name strings
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getMethods [line 903]
Tags:
return: returns a simple array of method objects
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getModifiers [line 736]
array|false getModifiers(
)
Get the PHP5+ modifiers for this class
(abstract/final/static/private/protected/public)
method getParent [line 889]
retrieve object that represents the parent class
Tags:
return: returns the
parserClass representation of the parent class, or false if no parent class
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getParentClassTree [line 1289]
Tags:
return: Format: array(parentclassname => parserClass/false if no parent, parentclassname2 => ...)
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getSourceLocation [line 1337]
string getSourceLocation(
Converter
$c, [boolean
$pearize = false])
Tags:
Parameters:
method getTutorial [line 766]
Get the associated tutorial for this class, if any
Tags:
method getVar [line 934]
Tags:
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
string
$name
var name in this class
method getVarNames [line 1018]
Tags:
return: returns a simple array of var name strings
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method getVars [line 1000]
Tags:
return: returns a simple array of var objects
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
method hasConst [line 991]
boolean hasConst(
Converter
&$c, string
$name)
Tags:
return: whether this class has a constant of name $name
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
string
$name
class constant name
method hasMethod [line 961]
boolean hasMethod(
Converter
&$c, string
$name, [boolean
$inherited = false])
Tags:
return: whether this class has a method of name $name
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
method hasVar [line 981]
Tags:
return: whether this class has a var of name $name
Parameters:
Converter
&$c
this function will not work before the Conversion stage of parsing
string
$name
var name
method isInterface [line 870]
Tags:
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:
method setExtends [line 1362]
void setExtends(
string
$extends)
Tags:
Parameters:
method setInterface [line 862]
Use this method to set the type of class to be an interface
method setModifiers [line 746]
void setModifiers(
string
$m)
Set the PHP5+ modifiers for this class
(abstract/final/static/private/protected/public)
Parameters:
method setParent [line 805]
void setParent(
string
$p, string
$f, Classes
&$c)
Tags:
Parameters:
string
$p
parent class name
string
$f
parent class file
method setParentNoClass [line 854]
void setParentNoClass(
string
$par)
Parameters:
method setSourceLocation [line 1326]
void setSourceLocation(
string
$sl)
Tags:
Parameters: