Class: parserClass

Source Location: /phpDocumentor/ParserElements.inc

Class parserClass

Class Overview

Located in /phpDocumentor/ParserElements.inc [line 683]

parserBase
   |
   --parserElement
      |
      --parserClass

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserElements.inc,v 1.15 2006/08/17 02:36:50 cellog Exp $
Since:	1.0rc1

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserElement

parserElement::$conflicts

parserElement::$docblock

parserElement::$endlinenumber

parserElement::$file

parserElement::$linenumber

parserElement::$name

parserElement::$path

Inherited From parserBase

parserBase::$value

Inherited From parserElement

parserElement::getEndLineNumber()

parserElement::getFile()

parserElement::getLineNumber()

parserElement::getName()

parserElement::getPackage()

parserElement::getPath()

parserElement::setDocBlock()

parserElement::setEndLineNumber()

Sets the ending line number of elements

parserElement::setFile()

parserElement::setLineNumber()

Set starting line number

parserElement::setName()

parserElement::setPath()

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

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 726]

[ Top ]

mixed $extends = false [line 696]

[ Top ]

boolean $ignore = false [line 721]

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 715]

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

[ Top ]

string $sourceLocation = '' [line 692]

API Tags:

See:

parserPage::$sourceLocation

[ Top ]

tutorialLink|false $tutorial = false [line 730]

[ Top ]

string $type = 'class' [line 689]

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 phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

array $_implements = array() [line 700]

[ Top ]

Methods

addImplements [line 1379]

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

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 777]

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 1035]

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 1010]

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 1226]

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 1052]

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 1150]

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 790]

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 915]

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 944]

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 904]

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

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 1290]

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:	XMLDocBookConverter::generateFormattedClassTree()
Usedby:	XMLDocBookpeardoc2Converter::generateFormattedClassTree()
Usedby:	HTMLframesConverter::generateFormattedClassTree()
Usedby:	HTMLSmartyConverter::generateFormattedClassTree()
Usedby:	CHMdefaultConverter::generateFormattedClassTree()

[ Top ]

getSourceLocation [line 1338]

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

Parameters:

Converter	$c:
boolean	$pearize:

API Tags:

See:

parserClass::$sourceLocation

[ Top ]

getTutorial [line 767]

parserTutorial getTutorial(
)

Get the associated tutorial for this class, if any

Information Tags:

Tutorial:

phpDocumentor Tutorials

[ Top ]

getVar [line 935]

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 1019]

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 1001]

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 992]

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 962]

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 982]

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 871]

boolean isInterface(
)

API Tags:

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 1362]

void setExtends(
string
$extends 
)

Parameters:

string

$extends:

API Tags:

See:

parserClass::$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 
)

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

Parameters:

string

$sl:

API Tags:

See:

parserClass::$sourceLocation

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:25:11 -0500 by phpDocumentor 1.3.1

	phpDocumentor ParserElements

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