$globals = false (line 351)

Data type : array

global declarations parsed from function definition

• var: - Format: array(globalname1, globalname2,....)

$params = false (line 335)

Data type : array

parameters parsed from function definition.

• var: - Format: array(param name => default value parsed from function definition)
• see: - updateParams()

$returnsreference = false (line 345)

Data type : boolean

Function returns a reference to an element, instead of a value

$source = '' (line 358)

Data type : mixed

$statics = false (line 356)

Data type : array

static variable declarations parsed from function definition

• var: - Format: array(array('name' => staticvar1,'val' => '' or default val of staticvar1),...)

$type = 'function' (line 327)

Data type : string

Overrides: Array

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

• var: - always 'function'

Method addGlobals (line 433)

void addGlobals( array $globals)

Add all "global $var, $var2" declarations to this function

Parameters

• array $globals: Format: array(globalname1, globalname2,....)

Info

Method addParam (line 366)

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

Overridden in child classes as:

parserMethod::addParam()

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 addSource (line 379)

void addSource( string|array $source)

Set the source code. Always array in PHP 4.3.0+

Parameters

• string|array $source:

Info

Method addStatics (line 443)

void addStatics( array $static, array $vals)

Add all "static $var, $var2 = 6" declarations to this function

Parameters

• array $static: Format: array(varname1, varname2,...)
• array $vals: Format: array(default val of var 1, default val of var 2,...) if var 1 has no default, array(default val of var 2,...)

Info

Method getConflicts (line 422)

mixed getConflicts( Converter &$c)

Returns all functions in other packages that have the same name as this function

Parameters

• Converter &$c:

Info

• return - false or an array Format: (package => parserFunction of conflicting functions)
• usedby - Converter::getFormattedConflicts()

Method getFunctionCall (line 580)

string getFunctionCall( )

Overridden in child classes as:

parserMethod::getFunctionCall()

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

Get a human-friendly description of the function call

Info

• return - stylized function declaration

Method getIntricateFunctionCall (line 621)

array getIntricateFunctionCall( $converter, $paramtags)

Overridden in child classes as:

parserMethod::getIntricateFunctionCall()

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

Parameters

• $converter:
• $paramtags:

Info

• return - Format:
  1.  array('name' => function name,
  2.        'returnsref' => boolean if declared as "function &name()"
  3.        'params' => array('type' => data type of parameter,
  4.                          'description' => from @param tag,
  5.                          'name' => variable name,
  6.                          'default' => default value if any))
• see - parserFunction::getFunctionCall()

Method getLink (line 408)

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

Overridden in child classes as:

parserMethod::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 function

Method getParam (line 464)

string getParam( string $name)

Parameters

• string $name:

Info

• return - default value of param $name

Method getReturnsReference (line 561)

boolean getReturnsReference( )

Info

• return - returns value of $returnsreference

Method getSource (line 397)

string|array getSource( )

Info

• return - source code ready for highlighting

Method hasSource (line 388)

boolean hasSource( )

Determine whether the source code has been requested via {@source}

Info

Method listGlobals (line 515)

array listGlobals( )

Info

• return - format: array(array(index, globalname),...)

Method listParams (line 480)

array listParams( )

Info

• return - format: array(array(paramname, default value),...)

Method listStatics (line 534)

array listStatics( )

Info

• return - format: array(array(static var name, static var default value),...)

Method setReturnsReference (line 553)

void setReturnsReference( )

sets $returnsreference to true

Info