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

Class: parserMethod

Source Location: /phpDocumentor/ParserElements.inc

Class parserMethod

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

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

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

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   $class  
boolean   $isConstructor  
boolean   $isDestructor  
string   $type   Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
mixed   $_modifiers  

[ Top ]
Method Summary
parserMethod   parserMethod()  
void   addParam()  
string   getClass()   Return name of the class that contains this method
string   getFunctionCall()   adds "constructor " to start of function call if $isConstructor is true
mixed   getImplements()  
void   getIntricateFunctionCall()  
mixed   getLink()   quick way to link to this element
string   getModifiers()   Return name of the class that contains this method
mixed   getOverrides()  
array   getOverridingMethods()  
array   getOverridingMethodsForClass()  
void   setConstructor()   Use this method to tell the parser that this method is the class constructor
void   setDestructor()   Use this method to tell the parser that this method is the class constructor
string   setModifiers()   Return name of the class that contains this method

[ Top ]
Properties
string   $class = '' [line 1640]

[ Top ]
boolean   $isConstructor = false [line 1636]

[ Top ]
boolean   $isDestructor = false [line 1638]

[ Top ]
string   $type = 'method' [line 1634]

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


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

[ Top ]
mixed   $_modifiers = array() [line 1641]

[ Top ]
Methods
Constructor parserMethod  [line 1646]

  parserMethod parserMethod( string $class  )

Parameters:
string   $class: 


[ Top ]
addParam  [line 1657]

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

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


Redefinition of:
parserFunction::addParam()

[ Top ]
getClass  [line 1690]

  string getClass( )

Return name of the class that contains this method



[ Top ]
getFunctionCall  [line 1671]

  string getFunctionCall( )

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


API Tags:
See:  parserFunction::getFunctionCall()


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

[ Top ]
getImplements  [line 1805]

  mixed getImplements( Converter &$c  )

Parameters:
Converter   &$c: 

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


[ Top ]
getIntricateFunctionCall  [line 1678]

  void getIntricateFunctionCall( $converter, $paramtags  )

Parameters:
   $converter: 
   $paramtags: 


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

[ Top ]
getLink  [line 1915]

  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 method


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

[ Top ]
getModifiers  [line 1699]

  string getModifiers( )

Return name of the class that contains this method



[ Top ]
getOverrides  [line 1718]

  mixed getOverrides( Converter &$c  )

Parameters:
Converter   &$c: 

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


[ Top ]
getOverridingMethods  [line 1944]

  array getOverridingMethods( Converter &$c  )

Parameters:
Converter   &$c: 

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


[ Top ]
getOverridingMethodsForClass  [line 1956]

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

Parameters:
Converter   &$c: 
parserClass   &$class: 

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


[ Top ]
setConstructor  [line 1927]

  void setConstructor( )

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



[ Top ]
setDestructor  [line 1935]

  void setDestructor( )

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



[ Top ]
setModifiers  [line 1708]

  string setModifiers( $m  )

Return name of the class that contains this method

Parameters:
   $m: 


[ Top ]

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