Class: parserMethod

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

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

Author(s):

Greg Beaver <[email protected]>

Version:

$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

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

Tags:

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

[ Top ]

Class Variables

$class = ''

[line 1640]

Tags:

var:

class that contains this method

Type:

string

[ Top ]

$isConstructor = false

[line 1636]

Tags:

var:

whether this method is a constructor

Type:

boolean

[ Top ]

$isDestructor = false

[line 1638]

Tags:

var:

whether this method is a destructor by PEAR standards

Type:

boolean

[ Top ]

$type = 'method'

[line 1634]

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

Tags:

var:

always 'method'

Type:	string
Overrides:	Array

[ Top ]

$_modifiers = array()

[line 1641]

Type:

mixed

[ Top ]

Class Methods

constructor parserMethod [line 1646]

parserMethod parserMethod(
string
$class)

Parameters:

string

$class

[ Top ]

method addParam [line 1657]

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 ]

method getClass [line 1690]

string getClass(
)

Return name of the class that contains this method

[ Top ]

method getFunctionCall [line 1671]

string getFunctionCall(
)

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

Tags:

see:

parserFunction::getFunctionCall()

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

[ Top ]

method getImplements [line 1805]

mixed getImplements(
Converter
&$c)

Tags:

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

Parameters:

Converter

&$c

[ Top ]

method getIntricateFunctionCall [line 1678]

void getIntricateFunctionCall(

$converter, 
$paramtags)

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

Parameters:

	$converter
	$paramtags

[ Top ]

method getLink [line 1915]

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

quick way to link to this element

Tags:

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 ]

method getModifiers [line 1699]

string getModifiers(
)

Return name of the class that contains this method

[ Top ]

method getOverrides [line 1718]

mixed getOverrides(
Converter
&$c)

Tags:

return:

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

Parameters:

Converter

&$c

[ Top ]

method getOverridingMethods [line 1944]

array getOverridingMethods(
Converter
&$c)

Tags:

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

Parameters:

Converter

&$c

[ Top ]

method getOverridingMethodsForClass [line 1956]

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

Tags:

return:

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

Parameters:

Converter	&$c
parserClass	&$class

[ Top ]

method setConstructor [line 1927]

void setConstructor(
)

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

[ Top ]

method setDestructor [line 1935]

void setDestructor(
)

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

[ Top ]

method setModifiers [line 1708]

string setModifiers(

$m)

Return name of the class that contains this method

Parameters:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:14:34 -0600 by phpDocumentor 1.4.4