Docs For Class parserClass

addImplements [line 1380]

void addImplements(
string
$implements)

Parameters:

string $implements —

[ Top ]

addTutorial [line 756]

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

Parameters:

parserTutorial	`$t`	—
Converter	`&$c`	—

[ Top ]

getChildClassList [line 1309]

array getChildClassList(
Converter
&$c)

returns a list of all child classes of this class

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

Parameters:

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

[ Top ]

getConflicts [line 777]

mixed getConflicts(
Converter
&$c)

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

Parameters:

Converter &$c —

[ Top ]

getConstNames [line 1035]

array getConstNames(
Converter
&$c)

Return: returns a simple array of const name strings

Parameters:

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

[ Top ]

getConsts [line 1010]

array getConsts(
Converter
&$c)

Return: returns a simple array of const objects

Parameters:

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

[ Top ]

getExtends [line 1397]

boolean getExtends(
[
$raw = false])

See: parserClass::$extends

Parameters:

$raw —

[ Top ]

getImplements [line 1388]

array getImplements(
)

[ Top ]

getInheritedConsts [line 1226]

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

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`	—

[ Top ]

getInheritedMethods [line 1052]

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

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

[ Top ]

getInheritedVars [line 1150]

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

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`	—

[ Top ]

getLink [line 790]

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

quick way to link to this element

Return: converter-specific link to this class

Parameters:

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

[ Top ]

getMethod [line 915]

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

Return: parserMethod or false if not found

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

[ Top ]

getMethodNames [line 944]

array getMethodNames(
Converter
&$c)

Return: returns a simple array of method name strings

Parameters:

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

[ Top ]

getMethods [line 904]

array getMethods(
Converter
&$c)

Return: returns a simple array of method objects

Parameters:

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

[ Top ]

getModifiers [line 737]

array|false getModifiers(
)

Get the PHP5+ modifiers for this class

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

[ Top ]

getParent [line 890]

mixed &getParent(
Converter
&$c)

retrieve object that represents the parent class

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

[ Top ]

getParentClassTree [line 1290]

array getParentClassTree(
Converter
&$c)

Return: Format: array(parentclassname => parserClass/false if no parent, parentclassname2 => ...)
Usedby: HTMLframesConverter::generateFormattedClassTree()
Usedby: HTMLSmartyConverter::generateFormattedClassTree()
Usedby: CHMdefaultConverter::generateFormattedClassTree()
Usedby: XMLDocBookpeardoc2Converter::generateFormattedClassTree()
Usedby: XMLDocBookConverter::generateFormattedClassTree()

Parameters:

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

[ Top ]

getSourceLocation [line 1338]

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

See: parserClass::$sourceLocation

Parameters:

Converter	`$c`	—
boolean	`$pearize`	—

[ Top ]

getTutorial [line 767]

parserTutorial getTutorial(
)

Get the associated tutorial for this class, if any

Tutorial: phpDocumentor Tutorials

[ Top ]

getVar [line 935]

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

Return: parserVar or false if not found

Parameters:

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

[ Top ]

getVarNames [line 1019]

array getVarNames(
Converter
&$c)

Return: returns a simple array of var name strings

Parameters:

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

[ Top ]

getVars [line 1001]

array getVars(
Converter
&$c)

Return: returns a simple array of var objects

Parameters:

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

[ Top ]

hasConst [line 992]

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

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

[ Top ]

hasMethod [line 962]

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

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

[ Top ]

hasVar [line 982]

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

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

[ Top ]

isInterface [line 871]

boolean isInterface(
)

Return: true if this is an interface class

[ Top ]

setAccessModifiers [line 880]

void setAccessModifiers(
array
$modifiers)

Use this method to set access modifiers for a class

Parameters:

array $modifiers —

[ Top ]

setExtends [line 1363]

void setExtends(
string
$extends)

See: parserClass::$extends

Parameters:

string $extends —

[ Top ]

setInterface [line 863]

void setInterface(
)

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

[ Top ]

setModifiers [line 747]

void setModifiers(
string
$m)

Set the PHP5+ modifiers for this class

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

Parameters:

string $m —

[ Top ]

setParent [line 806]

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

See: Classes::setClassParent()

Parameters:

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

[ Top ]

setParentNoClass [line 855]

void setParentNoClass(
string
$par)

Parameters:

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

[ Top ]

setSourceLocation [line 1327]

void setSourceLocation(
string
$sl)

See: parserClass::$sourceLocation

Parameters:

string $sl —

[ Top ]

Class: parserClass

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: parserElement

Class: parserBase

Inherited Methods

Class: parserElement

Class: parserBase

Class Details

Class Variables

$curfile = false

$extends = false

$ignore = false

$parent = false

$sourceLocation = ''

$tutorial = false

$type = 'class'

Method Detail

addImplements [line 1380]

Parameters:

addTutorial [line 756]

Parameters:

getChildClassList [line 1309]

Parameters:

getConflicts [line 777]

Parameters:

getConstNames [line 1035]

Parameters:

getConsts [line 1010]

Parameters:

getExtends [line 1397]

Parameters:

getImplements [line 1388]

getInheritedConsts [line 1226]

Parameters:

getInheritedMethods [line 1052]

Parameters:

getInheritedVars [line 1150]

Parameters:

getLink [line 790]

Parameters:

getMethod [line 915]

Parameters:

getMethodNames [line 944]

Parameters:

getMethods [line 904]

Parameters:

getModifiers [line 737]

getParent [line 890]

Parameters:

getParentClassTree [line 1290]

Parameters:

getSourceLocation [line 1338]

Parameters:

getTutorial [line 767]

getVar [line 935]

Parameters:

getVarNames [line 1019]

Parameters:

getVars [line 1001]

Parameters:

hasConst [line 992]

Parameters:

hasMethod [line 962]

Parameters:

hasVar [line 982]

Parameters:

isInterface [line 871]

setAccessModifiers [line 880]

Parameters:

setExtends [line 1363]

Parameters:

setInterface [line 863]

setModifiers [line 747]

Parameters:

setParent [line 806]