Class: parserMethod

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserElements.inc

Class Overview

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

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id$

Copyright:

2002-2008 Gregory Beaver

Variables

Methods

Inherited Variables

Inherited Methods

Class: parserFunction

parserFunction::addGlobals(): Add all "global $var, $var2" declarations to this function
parserFunction::addParam()
parserFunction::addSource(): Set the source code. Always array in PHP 4.3.0+
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(): Get a human-friendly description of the function call
parserFunction::getIntricateFunctionCall(): Like getFunctionCall(), but has no English or pre-determined formatting.
parserFunction::getLink(): quick way to link to this element
parserFunction::getParam()
parserFunction::getReturnsReference()
parserFunction::getSource()
parserFunction::hasSource(): Determine whether the source code has been requested via {@source}
parserFunction::listGlobals()
parserFunction::listParams()
parserFunction::listStatics()
parserFunction::setReturnsReference(): sets $returnsreference to true

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

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 1637]

Author: Greg Beaver <cellog@php.net>
Version: $Id$
Copyright: 2002-2008 Gregory Beaver
Since: 1.0rc1

[ Top ]

Class Variables

$class = ''

[line 1649]

Var: class that contains this method

Type:

string

[ Top ]

$isConstructor = false

[line 1645]

Var: whether this method is a constructor

Type:

boolean

[ Top ]

$isDestructor = false

[line 1647]

Var: whether this method is a destructor by PEAR standards

Type:

boolean

[ Top ]

$type = 'method'

[line 1643]

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

Var: always 'method'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserMethod (Constructor) [line 1655]

parserMethod parserMethod(
string
$class)

Parameters:

string $class —

[ Top ]

addParam [line 1666]

void addParam(
string
$name, string
$value, [boolean
$has_default = true], [null|string
$typehint = null])

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

Parameters:

string	`$name`	—
string	`$value`	—	default value parsed from function definition
boolean	`$has_default`	—	indicates whether this parameter has a default value
null\|string	`$typehint`	—	class type hint

[ Top ]

getClass [line 1699]

string getClass(
)

Return name of the class that contains this method

[ Top ]

getFunctionCall [line 1680]

string getFunctionCall(
)

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

See: parserFunction::getFunctionCall()

Overrides parserFunction::getFunctionCall() (Get a human-friendly description of the function call)

[ Top ]

getImplements [line 1814]

mixed getImplements(
Converter
&$c)

Return: parserMethod representing method this method implements from an interface, or false if none
Usedby: Converter::getFormattedMethodImplements()

Parameters:

Converter &$c —

[ Top ]

getIntricateFunctionCall [line 1687]

void getIntricateFunctionCall(

$converter, 
$paramtags)

Overrides parserFunction::getIntricateFunctionCall() (Like getFunctionCall(), but has no English or pre-determined formatting.)

Parameters:

	`$converter`	—
	`$paramtags`	—

[ Top ]

getLink [line 1924]

mixed getLink(
Converter
$c, [string
$text = false], [
$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
	`$returnobj`	—

[ Top ]

getModifiers [line 1708]

string getModifiers(
)

Return name of the class that contains this method

[ Top ]

getOverrides [line 1727]

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

array getOverridingMethods(
Converter
&$c)

Return: an array of parserMethods from child classes that override this method
Usedby: Converter::getFormattedDescMethods()

Parameters:

Converter &$c —

[ Top ]

getOverridingMethodsForClass [line 1965]

array getOverridingMethodsForClass(
Converter
&$c, parserClass
&$class)

Return: an array of parserMethods from ALL child classes that override this method in the given class

Parameters:

Converter	`&$c`	—
parserClass	`&$class`	—

[ Top ]

setConstructor [line 1936]

void setConstructor(
)

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

[ Top ]

setDestructor [line 1944]

void setDestructor(
)

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

[ Top ]

setModifiers [line 1717]

string setModifiers(

$m)

Return name of the class that contains this method

Parameters:

$m —

[ Top ]