Class: parserFunction

Source Location: /phpDocumentor/ParserElements.inc

Class parserFunction

Class Overview

Located in /phpDocumentor/ParserElements.inc [line 321]

parserBase
   |
   --parserElement
      |
      --parserFunction

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
Copyright:	2002-2008 Gregory Beaver
Since:	1.0rc1

Properties

Methods

[ Top ]

Descendants

Child Class	Description
parserMethod

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserElement

parserElement::$conflicts

parserElement::$docblock

parserElement::$endlinenumber

parserElement::$file

parserElement::$linenumber

parserElement::$name

parserElement::$path

Inherited From parserBase

parserBase::$value

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

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

array	$globals	global declarations parsed from function definition
array	$params	parameters parsed from function definition.
boolean	$returnsreference	Function returns a reference to an element, instead of a value
mixed	$source
array	$statics	static variable declarations parsed from function definition
string	$type	Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Method Summary

void	addGlobals()	Add all "global $var, $var2" declarations to this function
void	addParam()
void	addSource()	Set the source code. Always array in PHP 4.3.0+
void	addStatics()	Add all "static $var, $var2 = 6" declarations to this function
mixed	getConflicts()	Returns all functions in other packages that have the same name as this function
string	getFunctionCall()	Get a human-friendly description of the function call
array	getIntricateFunctionCall()	Like getFunctionCall(), but has no English or pre-determined formatting.
mixed	getLink()	quick way to link to this element
string	getParam()
boolean	getReturnsReference()
string\|array	getSource()
boolean	hasSource()	Determine whether the source code has been requested via {@source}
array	listGlobals()
array	listParams()
array	listStatics()
void	setReturnsReference()	sets $returnsreference to true

[ Top ]

Properties

array $globals = false [line 351]

global declarations parsed from function definition

[ Top ]

array $params = false [line 335]

parameters parsed from function definition.

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

API Tags:

See:

updateParams()

[ Top ]

boolean $returnsreference = false [line 345]

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

set to true if function is declared as:

function &func(...

[ Top ]

mixed $source = '' [line 358]

[ Top ]

array $statics = false [line 356]

static variable declarations parsed from function definition

[ Top ]

string $type = 'function' [line 327]

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

Redefinition of:

parserBase::$type: Type is used by many functions to skip the hassle of if

Redefined in descendants as:

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

[ Top ]

Methods

addGlobals [line 433]

void addGlobals(
array
$globals 
)

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

Parameters:

array

$globals:

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

[ Top ]

addParam [line 366]

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

Redefined in descendants as:

parserMethod::addParam()

[ Top ]

addSource [line 379]

void addSource(
string|array
$source 
)

Set the source code. Always array in PHP 4.3.0+

Parameters:

string|array

$source:

[ Top ]

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

[ Top ]

getConflicts [line 422]

mixed getConflicts(
Converter
&$c 
)

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

Parameters:

Converter

&$c:

API Tags:

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

[ Top ]

getFunctionCall [line 580]

string getFunctionCall(
)

Get a human-friendly description of the function call

takes declaration like:

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

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

API Tags:

Return:

stylized function declaration

Redefined in descendants as:

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

[ Top ]

getIntricateFunctionCall [line 621]

array getIntricateFunctionCall(

$converter, 
$paramtags 
)

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

Much more flexible.

Parameters:

	$converter:
	$paramtags:

API Tags:

Return:	Format: array('name' => function name, 'returnsref' => boolean if declared as "function &name()" 'params' => array('type' => data type of parameter, 'description' => from @param tag, 'name' => variable name, 'default' => default value if any))
See:	parserFunction::getFunctionCall()

Redefined in descendants as:

parserMethod::getIntricateFunctionCall()

[ Top ]

getLink [line 408]

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 function

Redefined in descendants as:

parserMethod::getLink() : quick way to link to this element

[ Top ]

getParam [line 464]

string getParam(
string
$name 
)

Parameters:

string

$name:

API Tags:

Return:

default value of param $name

[ Top ]

getReturnsReference [line 561]

boolean getReturnsReference(
)

API Tags:

Return:

returns value of $returnsreference

[ Top ]

getSource [line 397]

string|array getSource(
)

API Tags:

Return:

source code ready for highlighting

[ Top ]

hasSource [line 388]

boolean hasSource(
)

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

[ Top ]

listGlobals [line 515]

array listGlobals(
)

API Tags:

Return:

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

[ Top ]

listParams [line 480]

array listParams(
)

API Tags:

Return:

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

[ Top ]

listStatics [line 534]

array listStatics(
)

API Tags:

Return:

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

[ Top ]

setReturnsReference [line 553]

void setReturnsReference(
)

sets $returnsreference to true

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:46 -0600 by phpDocumentor 1.4.4

	phpDocumentor ParserElements

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