Class parserMethod

(line 1628)

Description

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

Located in File: /phpDocumentor/ParserElements.inc



Class Variables

Summary:
string $class
boolean $isConstructor
boolean $isDestructor
string $type
mixed $_modifiers

$class = '' (line 1640)

Data type : string

  • var: - class that contains this method

$isConstructor = false (line 1636)

Data type : boolean

  • var: - whether this method is a constructor

$isDestructor = false (line 1638)

Data type : boolean

  • var: - whether this method is a destructor by PEAR standards

$type = 'method' (line 1634)

Data type : string

Overrides: Array

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
  • var: - always 'method'

$_modifiers = array() (line 1641)

Data type : mixed

Class Constants

Summary:

Method Detail

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)
void setConstructor ()
void setDestructor ()
string setModifiers ( $m)

Constructor parserMethod (line 1646)

parserMethod parserMethod( string $class)

Parameters

  • string $class:

Info

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

Info

Method getClass (line 1690)

string getClass( )

Return name of the class that contains this method

Info

Method getFunctionCall (line 1671)

string getFunctionCall( )

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

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

Info

Method getImplements (line 1805)

mixed getImplements( Converter &$c)

Parameters

Info

Method getIntricateFunctionCall (line 1678)

void getIntricateFunctionCall( $converter, $paramtags)

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

Parameters

  • $converter:
  • $paramtags:

Info

Method getLink (line 1915)

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

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

quick way to link to this element

Parameters

  • Converter $c:
  • string $text: text to display for the link or false for default text
  • $returnobj:

Info

  • return - converter-specific link to this method

Method getModifiers (line 1699)

string getModifiers( )

Return name of the class that contains this method

Info

Method getOverrides (line 1718)

mixed getOverrides( Converter &$c)

Parameters

Info

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

Method getOverridingMethods (line 1944)

array getOverridingMethods( Converter &$c)

Parameters

Info

Method getOverridingMethodsForClass (line 1956)

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

Parameters

Info

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

Method setConstructor (line 1927)

void setConstructor( )

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

Info

Method setDestructor (line 1935)

void setDestructor( )

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

Info

Method setModifiers (line 1708)

string setModifiers( $m)

Return name of the class that contains this method

Parameters

  • $m:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserFunction

parserFunction::$globals - global declarations parsed from function definition

parserFunction::$params - parameters parsed from function definition.

parserFunction::$returnsreference - Function returns a reference to an element, instead of a value

parserFunction::$source -

parserFunction::$statics - static variable declarations parsed from function definition

Inherited From Class parserElement

parserElement::$conflicts -

parserElement::$docblock -

parserElement::$endlinenumber - line number on file where this element stops

parserElement::$file - location of this element (filename)

parserElement::$linenumber - Line number in the source on which this element appears

parserElement::$name - name of this element, or include type if element is a parserInclude

parserElement::$path - full path location of this element (filename)

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

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


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


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



Documentation generated on Mon, 05 Dec 2011 21:28:44 -0600 by phpDocumentor 1.4.4