Docs For Class parserMethod

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

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

Variable Summary

string $class

boolean $isConstructor

boolean $isDestructor

string $type

mixed $_modifiers

Method Summary

parserMethod parserMethod (string $class)

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

string getClass ()

string getFunctionCall ()

mixed getImplements (Converter &$c)

void getIntricateFunctionCall ( $converter, $paramtags)

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

string getModifiers ()

mixed getOverrides (Converter &$c)

array getOverridingMethods (Converter &$c)

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

void setConstructor ()

void setDestructor ()

string setModifiers ( $m)

Variables

string $class = '' (line 1640)

var: class that contains this method

boolean $isConstructor = false (line 1636)

var: whether this method is a constructor

boolean $isDestructor = false (line 1638)

var: whether this method is a destructor by PEAR standards

string $type = 'method' (line 1634)

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

var: always 'method'

Redefinition of:

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

mixed $_modifiers = array() (line 1641)

Inherited Variables

Inherited from parserFunction

parserFunction::$globals
parserFunction::$params
parserFunction::$returnsreference
parserFunction::$source
parserFunction::$statics

Inherited from parserElement

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

Inherited from parserBase

parserBase::$value

Methods

Constructor parserMethod (line 1646)

parserMethod parserMethod (string $class)

string $class

addParam (line 1657)

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

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

Redefinition of:

parserFunction::addParam()

getClass (line 1690)

Return name of the class that contains this method

string getClass ()

getFunctionCall (line 1671)

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

see: parserFunction::getFunctionCall()

string getFunctionCall ()

Redefinition of:

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

getImplements (line 1805)

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

mixed getImplements (Converter &$c)

Converter &$c

getIntricateFunctionCall (line 1678)

void getIntricateFunctionCall ( $converter, $paramtags)

$converter
$paramtags

Redefinition of:

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

getLink (line 1915)

quick way to link to this element

return: converter-specific link to this method

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

Redefinition of:

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

getModifiers (line 1699)

Return name of the class that contains this method

string getModifiers ()

getOverrides (line 1718)

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

mixed getOverrides (Converter &$c)

Converter &$c

getOverridingMethods (line 1944)

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

array getOverridingMethods (Converter &$c)

Converter &$c

getOverridingMethodsForClass (line 1956)

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

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

Converter &$c
parserClass &$class

setConstructor (line 1927)

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

void setConstructor ()

setDestructor (line 1935)

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

void setDestructor ()

setModifiers (line 1708)

Return name of the class that contains this method

string setModifiers ( $m)

$m

Inherited Methods

Inherited From parserFunction

parserFunction::addGlobals()
parserFunction::addParam()
parserFunction::addSource()
parserFunction::addStatics()
parserFunction::getConflicts()
parserFunction::getFunctionCall()
parserFunction::getIntricateFunctionCall()
parserFunction::getLink()
parserFunction::getParam()
parserFunction::getReturnsReference()
parserFunction::getSource()
parserFunction::hasSource()
parserFunction::listGlobals()
parserFunction::listParams()
parserFunction::listStatics()
parserFunction::setReturnsReference()

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