Class: parserFunction

[line 351]

global declarations parsed from function definition

Tags:

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

Type: array

Overrides:

[line 335]

parameters parsed from function definition.

param name may be null, in which case, updateParams() must be called from the Converter

Tags:

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

Type: array

Overrides:

[line 345]

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

set to true if function is declared as:

1.  function &func(...

Type: boolean

Overrides:

[line 358]

Type: mixed

Overrides:

[line 356]

static variable declarations parsed from function definition

Tags:

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

Type: array

Overrides:

[line 327]

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

Tags:

• var - always 'function'

Type: string

Overrides: Array

void addGlobals( array $globals)

[line 433]

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

Parameters:

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

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

[line 366]

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

void addSource( string|array $source)

[line 379]

Set the source code. Always array in PHP 4.3.0+

Parameters:

• string|array $source -

void addStatics( array $static, array $vals)

[line 443]

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,...)

mixed getConflicts( Converter &$c)

[line 422]

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

Tags:

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

Parameters:

• Converter &$c -

string getFunctionCall( )

[line 580]

Get a human-friendly description of the function call

takes declaration like:

1.  /** @returns string ... {rest of docblock}
2.  function &func($param1, $param2 = 6,
3.                 $param3 = array('20',9 => "heroo"))
4.  {...}

Tags:

• return - stylized function declaration

Overridden in child classes as:

parserMethod::getFunctionCall()

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

Parameters:

array getIntricateFunctionCall( $converter, $paramtags)

[line 621]

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

Much more flexible.

Tags:

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

Overridden in child classes as:

parserMethod::getIntricateFunctionCall()

Parameters:

• $converter -
• $paramtags -

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

[line 408]

quick way to link to this element

Tags:

• return - converter-specific link to this function

Overridden in child classes as:

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

string getParam( string $name)

[line 464]

Tags:

• return - default value of param $name

Parameters:

• string $name -

boolean getReturnsReference( )

[line 561]

Tags:

• return - returns value of $returnsreference

Parameters:

string|array getSource( )

[line 397]

Tags:

• return - source code ready for highlighting

Parameters:

boolean hasSource( )

[line 388]

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

Parameters:

array listGlobals( )

[line 515]

Tags:

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

Parameters:

array listParams( )

[line 480]

Tags:

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

Parameters:

array listStatics( )

[line 534]

Tags:

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

Parameters:

void setReturnsReference( )

[line 553]

sets $returnsreference to true

Parameters: