phpDocumentor phpDocumentor
ParserElements
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserClass

Source Location: /phpDocumentor/ParserElements.inc

Class parserClass

Property Summary
string   $curfile  
mixed   $extends  
boolean   $ignore   Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing
mixed   $parent   Format: array(file, parent) where parent class is found or false if no parent
string   $sourceLocation  
tutorialLink|false   $tutorial  
string   $type   Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
array   $_implements  

[ Top ]
Method Summary
void   addImplements()  
void   addTutorial()  
array   getChildClassList()   returns a list of all child classes of this class
mixed   getConflicts()   Returns all classes in other packages that have the same name as this class
array   getConstNames()  
array   getConsts()  
boolean   getExtends()  
array   getImplements()  
array   getInheritedConsts()  
array   getInheritedMethods()  
array   getInheritedVars()  
mixed   getLink()   quick way to link to this element
mixed   getMethod()  
array   getMethodNames()  
array   getMethods()  
array|false   getModifiers()   Get the PHP5+ modifiers for this class
mixed   &getParent()   retrieve object that represents the parent class
array   getParentClassTree()  
string   getSourceLocation()  
parserTutorial   getTutorial()   Get the associated tutorial for this class, if any
mixed   getVar()  
array   getVarNames()  
array   getVars()  
boolean   hasConst()  
boolean   hasMethod()  
boolean   hasVar()  
boolean   isInterface()  
void   setAccessModifiers()   Use this method to set access modifiers for a class
void   setExtends()  
void   setInterface()   Use this method to set the type of class to be an interface
void   setModifiers()   Set the PHP5+ modifiers for this class
void   setParent()  
void   setParentNoClass()  
void   setSourceLocation()  

[ Top ]
Properties
string   $curfile = false [line 725]

[ Top ]
mixed   $extends = false [line 695]

[ Top ]
boolean   $ignore = false [line 720]

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

API Tags:
See:  Classes::getParentClass()


[ Top ]
mixed   $parent = false [line 714]

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


[ Top ]
string   $sourceLocation = '' [line 691]
API Tags:
See:  parserPage::$sourceLocation


[ Top ]
tutorialLink|false   $tutorial = false [line 729]

[ Top ]
string   $type = 'class' [line 688]

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


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

[ Top ]
array   $_implements = array() [line 699]

[ Top ]
Methods
addImplements  [line 1379]

  void addImplements( string $implements  )

Parameters:
string   $implements: 


[ Top ]
addTutorial  [line 755]

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

Parameters:
parserTutorial   $t: 
Converter   &$c: 


[ Top ]
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

API Tags:
Return:  Format: array(parserClass child1,parserClass child2,...)
Usedby:  XMLDocBookpeardoc2Converter::generateChildClassList()
Usedby:  Converter::generateChildClassList()


[ Top ]
getConflicts  [line 776]

  mixed getConflicts( Converter &$c  )

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

Parameters:
Converter   &$c: 

API Tags:
Return:  false or an array Format: (package => parserClass of conflicting classes)
Usedby:  Converter::getFormattedConflicts()


[ Top ]
getConstNames  [line 1034]

  array getConstNames( Converter &$c  )

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

API Tags:
Return:  returns a simple array of const name strings


[ Top ]
getConsts  [line 1009]

  array getConsts( Converter &$c  )

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

API Tags:
Return:  returns a simple array of const objects


[ Top ]
getExtends  [line 1396]

  boolean getExtends( [ $raw = false]  )

Parameters:
   $raw: 

API Tags:
See:  parserClass::$extends


[ Top ]
getImplements  [line 1387]

  array getImplements( )



[ Top ]
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: 

API Tags:
Return:  returns an array of consts by parent classname array(name => array(const1,const2..),name2 => array(const1....))


[ Top ]
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

API Tags:
Return:  returns an array of methods by parent classname array(name => array(method1,method2..),name2 => array(method1....))


[ Top ]
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: 

API Tags:
Return:  returns an array of vars by parent classname array(name => array(var1,var1..),name2 => array(var1....))


[ Top ]
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: 

API Tags:
Return:  converter-specific link to this class


[ Top ]
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

API Tags:
Return:  parserMethod or false if not found


[ Top ]
getMethodNames  [line 943]

  array getMethodNames( Converter &$c  )

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

API Tags:
Return:  returns a simple array of method name strings


[ Top ]
getMethods  [line 903]

  array getMethods( Converter &$c  )

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

API Tags:
Return:  returns a simple array of method objects


[ Top ]
getModifiers  [line 736]

  array|false getModifiers( )

Get the PHP5+ modifiers for this class

(abstract/final/static/private/protected/public)



[ Top ]
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

API Tags:
Return:  returns the parserClass representation of the parent class, or false if no parent class


[ Top ]
getParentClassTree  [line 1289]

  array getParentClassTree( Converter &$c  )

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

API Tags:
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()


[ Top ]
getSourceLocation  [line 1337]

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

Parameters:
Converter   $c: 
boolean   $pearize: 

API Tags:
See:  parserClass::$sourceLocation


[ Top ]
getTutorial  [line 766]

  parserTutorial getTutorial( )

Get the associated tutorial for this class, if any


Information Tags:
Tutorial:  phpDocumentor Tutorials

[ Top ]
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

API Tags:
Return:  parserVar or false if not found


[ Top ]
getVarNames  [line 1018]

  array getVarNames( Converter &$c  )

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

API Tags:
Return:  returns a simple array of var name strings


[ Top ]
getVars  [line 1000]

  array getVars( Converter &$c  )

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

API Tags:
Return:  returns a simple array of var objects


[ Top ]
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

API Tags:
Return:  whether this class has a constant of name $name


[ Top ]
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

API Tags:
Return:  whether this class has a method of name $name


[ Top ]
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

API Tags:
Return:  whether this class has a var of name $name


[ Top ]
isInterface  [line 870]

  boolean isInterface( )


API Tags:
Return:  true if this is an interface class


[ Top ]
setAccessModifiers  [line 879]

  void setAccessModifiers( array $modifiers  )

Use this method to set access modifiers for a class

Parameters:
array   $modifiers: 


[ Top ]
setExtends  [line 1362]

  void setExtends( string $extends  )

Parameters:
string   $extends: 

API Tags:
See:  parserClass::$extends


[ Top ]
setInterface  [line 862]

  void setInterface( )

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



[ Top ]
setModifiers  [line 746]

  void setModifiers( string $m  )

Set the PHP5+ modifiers for this class

(abstract/final/static/private/protected/public)

Parameters:
string   $m: 


[ Top ]
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

API Tags:
See:  Classes::setClassParent()


[ Top ]
setParentNoClass  [line 854]

  void setParentNoClass( string $par  )

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


[ Top ]
setSourceLocation  [line 1326]

  void setSourceLocation( string $sl  )

Parameters:
string   $sl: 

API Tags:
See:  parserClass::$sourceLocation


[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:44 -0600 by phpDocumentor 1.4.4