Class: parserMethod

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserFunction
         |
         --parserMethod

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $

Variables

Methods

Inherited Variables

Inherited Methods

Class: parserFunction

parserFunction::addGlobals(): Add all "global $var, $var2" declarations to this function
parserFunction::addParam()
parserFunction::addSource()
parserFunction::addStatics(): Add all "static $var, $var2 = 6" declarations to this function
parserFunction::getConflicts(): Returns all functions in other packages that have the same name as this function
parserFunction::getFunctionCall(): takes declaration like:
parserFunction::getIntricateFunctionCall()
parserFunction::getLink(): quick way to link to this element
parserFunction::getParam()
parserFunction::getReturnsReference()
parserFunction::getSource()
parserFunction::hasSource()
parserFunction::listGlobals()
parserFunction::listParams()
parserFunction::listStatics()
parserFunction::setReturnsReference(): sets $returnsreference to true

Class: parserElement

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

Class: parserBase

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

Class Details

[line 1043]

Version: $Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$class = ''

[line 1055]

Var: class that contains this method

Type:

string

[ Top ]

$isConstructor = false

[line 1051]

Var: whether this method is a constructor

Type:

boolean

[ Top ]

$isDestructor = false

[line 1053]

Var: whether this method is a destructor by PEAR standards

Type:

boolean

[ Top ]

$type = 'method'

[line 1049]

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

Var: always 'method'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserMethod (Constructor) [line 1060]

parserMethod parserMethod(
string
$class)

Parameters:

string $class —

[ Top ]

getFunctionCall [line 1070]

string getFunctionCall(
)

adds "constructor " to start of function call if $isConstructor is true

See: parserFunction::getFunctionCall()

Overrides parserFunction::getFunctionCall() (takes declaration like:)

[ Top ]

getIntricateFunctionCall [line 1077]

void getIntricateFunctionCall(
mixed
$converter, mixed
$paramtags)

Overrides parserFunction::getIntricateFunctionCall() (parent method not documented)

[ Top ]

getLink [line 1113]

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

quick way to link to this element

Return: converter-specific link to this method

Overrides parserFunction::getLink() (quick way to link to this element)

Parameters:

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

[ Top ]

getOverrides [line 1089]

mixed getOverrides(
Converter
&$c)

Return: parserMethod representing method this method overrides from the parent class, or false if none

Parameters:

Converter &$c —

[ Top ]

getOverridingMethods [line 1146]

array getOverridingMethods(
Converter
&$c)

Return: an array of parserMethods from child classes that override this method
Usedby: XMLDocBookConverter::getFormattedDescMethods()
Usedby: HTMLSmartyConverter::getFormattedDescMethods()
Usedby: HTMLframesConverter::getFormattedDescMethods()
Usedby: CHMdefaultConverter::getFormattedDescMethods()

Parameters:

Converter &$c —

[ Top ]

setConstructor [line 1129]

void setConstructor(
)

Use this method to tell the parser that this method is the class constructor

[ Top ]

setDestructor [line 1137]

void setDestructor(
)

Use this method to tell the parser that this method is the class constructor

[ Top ]