Docs For Class parserClass

Class parserClass

Description

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

Located in /phpDocumentor/ParserElements.inc (line 682)

parserBase
   |
   --parserElement
      |
      --parserClass

Variable Summary

string $curfile

mixed $extends

boolean $ignore

mixed $parent

string $sourceLocation

tutorialLink|false $tutorial

string $type

array $_implements

Method Summary

void addImplements (string $implements)

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

array getChildClassList (Converter &$c)

mixed getConflicts (Converter &$c)

array getConstNames (Converter &$c)

array getConsts (Converter &$c)

boolean getExtends ([ $raw = false])

array getImplements ()

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

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

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

mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])

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

array getMethodNames (Converter &$c)

array getMethods (Converter &$c)

array|false getModifiers ()

mixed &getParent (Converter &$c)

array getParentClassTree (Converter &$c)

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

parserTutorial getTutorial ()

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

array getVarNames (Converter &$c)

array getVars (Converter &$c)

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

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

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

boolean isInterface ()

void setAccessModifiers (array $modifiers)

void setExtends (string $extends)

void setInterface ()

void setModifiers (string $m)

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

void setParentNoClass (string $par)

void setSourceLocation (string $sl)

Variables

string $curfile = false (line 725)

var: same as parserElement::$path

mixed $extends = false (line 695)

var: false or contents of extends clause in class declaration

boolean $ignore = false (line 720)

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

see: Classes::getParentClass()

mixed $parent = false (line 714)

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

string $sourceLocation = '' (line 691)

see: parserPage::$sourceLocation

tutorialLink|false $tutorial = false (line 729)

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

string $type = 'class' (line 688)

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

var: always 'class'

Redefinition of:

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

array $_implements = array() (line 699)

var: a list of interfaces this class implements

Inherited Variables

Inherited from parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$endlinenumber
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Inherited from parserBase

parserBase::$value

Methods

addImplements (line 1379)

void addImplements (string $implements)

string $implements

addTutorial (line 755)

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

parserTutorial $t
Converter &$c

getChildClassList (line 1308)

returns a list of all child classes of this class

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

array getChildClassList (Converter &$c)

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

getConflicts (line 776)

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

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

mixed getConflicts (Converter &$c)

Converter &$c

getConstNames (line 1034)

return: returns a simple array of const name strings

array getConstNames (Converter &$c)

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

getConsts (line 1009)

return: returns a simple array of const objects

array getConsts (Converter &$c)

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

getExtends (line 1396)

see: parserClass::$extends

boolean getExtends ([ $raw = false])

$raw

getImplements (line 1387)

array getImplements ()

getInheritedConsts (line 1225)

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

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

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

getInheritedMethods (line 1051)

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

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

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

getInheritedVars (line 1149)

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

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

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

getLink (line 789)

quick way to link to this element

return: converter-specific link to this class

mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])

Converter $c
string $text: text to display for the link or false for default text
$returnobj

getMethod (line 914)

return: parserMethod or false if not found

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

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

getMethodNames (line 943)

return: returns a simple array of method name strings

array getMethodNames (Converter &$c)

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

getMethods (line 903)

return: returns a simple array of method objects

array getMethods (Converter &$c)

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

getModifiers (line 736)

Get the PHP5+ modifiers for this class

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

array|false getModifiers ()

getParent (line 889)

retrieve object that represents the parent class

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

mixed &getParent (Converter &$c)

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

getParentClassTree (line 1289)

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()

array getParentClassTree (Converter &$c)

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

getSourceLocation (line 1337)

see: parserClass::$sourceLocation

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

Converter $c
boolean $pearize

getTutorial (line 766)

Get the associated tutorial for this class, if any

tutorial: phpDocumentor Tutorials

parserTutorial getTutorial ()

getVar (line 934)

return: parserVar or false if not found

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

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

getVarNames (line 1018)

return: returns a simple array of var name strings

array getVarNames (Converter &$c)

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

getVars (line 1000)

return: returns a simple array of var objects

array getVars (Converter &$c)

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

hasConst (line 991)

return: whether this class has a constant of name $name

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

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

hasMethod (line 961)

return: whether this class has a method of name $name

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

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

hasVar (line 981)

return: whether this class has a var of name $name

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

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

isInterface (line 870)

return: true if this is an interface class

boolean isInterface ()

setAccessModifiers (line 879)

Use this method to set access modifiers for a class

void setAccessModifiers (array $modifiers)

array $modifiers

setExtends (line 1362)

see: parserClass::$extends

void setExtends (string $extends)

string $extends

setInterface (line 862)

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

void setInterface ()

setModifiers (line 746)

Set the PHP5+ modifiers for this class

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

void setModifiers (string $m)

string $m

setParent (line 805)

see: Classes::setClassParent()

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

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

setParentNoClass (line 854)

void setParentNoClass (string $par)

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

setSourceLocation (line 1326)

see: parserClass::$sourceLocation

void setSourceLocation (string $sl)

string $sl

Inherited Methods

Inherited From parserElement

parserElement::getEndLineNumber()
parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setEndLineNumber()
parserElement::setFile()
parserElement::setLineNumber()
parserElement::setName()
parserElement::setPath()

Inherited From parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Documentation generated on Mon, 05 Dec 2011 21:00:40 -0600 by phpDocumentor 1.4.4