Class: parserFunction

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserFunction

Author(s):

Greg Beaver <mailto:cellog at users.sourceforge.net>

Version:

$Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $

Variables

Methods

Child classes:

parserMethod

Inherited Variables

Class: parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Class: parserBase

parserBase::$linenum
parserBase::$value

Inherited Methods

Class: parserElement

parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setFile()
parserElement::setLineNumber()
parserElement::setName()
parserElement::setPath()

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setLineNum()
parserBase::setValue()

Class Details

[line 243]

Version: $Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $
Since: 1.0rc1
Author: Greg Beaver <mailto:cellog@users.sourceforge.net>

[ Top ]

Class Variables

$globals = false

[line 271]

global declarations parsed from function definition

Var: Format: array(globalname1, globalname2,....)

Type:

array

[ Top ]

$params = false

[line 257]

parameters parsed from function definition.

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

Var: Format: array(param name => default value parsed from function definition)
See: updateParams()

Type:

array

[ Top ]

$returnsreference = false

[line 265]

set to true if function is declared as:

</code>

Type:

boolean

[ Top ]

$source = ''

[line 278]

Type:

mixed

[ Top ]

$statics = false

[line 276]

static variable declarations parsed from function definition

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

Type:

array

[ Top ]

$type = 'function'

[line 249]

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

Var: always 'function'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

addGlobals [line 339]

void addGlobals(
array
$globals)

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

Parameters:

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

[ Top ]

addParam [line 283]

void addParam(
string
$name, string
$value)

Parameters:

string	`$name`	—
string	`$value`	—	default value parsed from function definition

[ Top ]

addSource [line 288]

void addSource(
mixed
$source)

[ Top ]

addStatics [line 349]

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

[ Top ]

getConflicts [line 328]

mixed getConflicts(
Converter
&$c)

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

Return: false or an array Format: (package => parserFunction of conflicting functions)

Parameters:

Converter &$c —

[ Top ]

getFunctionCall [line 461]

string getFunctionCall(
)

takes declaration like:

and returns: string &func( $param1, [$param2 = 6], [$param3 = array('20',9 => "heroo")] )

Return: stylized function declaration

Overridden in child classes as:

parserMethod::getFunctionCall(): adds "constructor " to start of function call if $isConstructor is true

[ Top ]

getIntricateFunctionCall [line 487]

void getIntricateFunctionCall(
mixed
$converter, mixed
$paramtags)

Overridden in child classes as:

parserMethod::getIntricateFunctionCall()

[ Top ]

getLink [line 310]

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

quick way to link to this element

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

[ Top ]

getParam [line 370]

string getParam(
string
$name)

Return: default value of param $name

Parameters:

string $name —

[ Top ]

getReturnsReference [line 444]

boolean getReturnsReference(
)

Return: returns value of $returnsreference

[ Top ]

getSource [line 299]

void getSource(
)

[ Top ]

hasSource [line 293]

void hasSource(
)

[ Top ]

listGlobals [line 398]

array listGlobals(
)

Return: format: array(array(index, globalname),...)

[ Top ]

listParams [line 379]

array listParams(
)

Return: format: array(array(paramname, default value),...)

[ Top ]

listStatics [line 417]

array listStatics(
)

Return: format: array(array(static var name, static var default value),...)

[ Top ]

setReturnsReference [line 436]

void setReturnsReference(
)

sets $returnsreference to true

[ Top ]