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

Class: parserFunction

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserFunction



Author(s):

Version:

  • $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Child classes:

Inherited Variables

Inherited Methods


Class Details



[ Top ]


Class Variables

$globals =  false

[line 351]

global declarations parsed from function definition



Tags:

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

Type:   array


[ Top ]

$params =  false

[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


[ Top ]

$returnsreference =  false

[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


[ Top ]

$source =  ''

[line 358]


Type:   mixed


[ Top ]

$statics =  false

[line 356]

static variable declarations parsed from function definition



Tags:

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

Type:   array


[ Top ]

$type =  'function'

[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


[ Top ]



Class Methods


method addGlobals [line 433]

void addGlobals( array $globals)

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



Parameters:

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

[ Top ]

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

[ Top ]

method addSource [line 379]

void addSource( string|array $source)

Set the source code. Always array in PHP 4.3.0+



Parameters:

string|array   $source  

[ Top ]

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

[ Top ]

method getConflicts [line 422]

mixed getConflicts( Converter &$c)

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  

[ Top ]

method getFunctionCall [line 580]

string getFunctionCall( )

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.  {...}
and returns: string &func( $param1, [$param2 = 6], [$param3 = array('20',9 => "heroo")] )




Tags:

return:  stylized function declaration


Overridden in child classes as:

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

[ Top ]

method getIntricateFunctionCall [line 621]

array getIntricateFunctionCall( $converter, $paramtags)

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  

[ Top ]

method getLink [line 408]

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

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  

[ Top ]

method getParam [line 464]

string getParam( string $name)



Tags:

return:  default value of param $name


Parameters:

string   $name  

[ Top ]

method getReturnsReference [line 561]

boolean getReturnsReference( )



Tags:

return:  returns value of $returnsreference


[ Top ]

method getSource [line 397]

string|array getSource( )



Tags:

return:  source code ready for highlighting


[ Top ]

method hasSource [line 388]

boolean hasSource( )

Determine whether the source code has been requested via [email protected]}



[ Top ]

method listGlobals [line 515]

array listGlobals( )



Tags:

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


[ Top ]

method listParams [line 480]

array listParams( )



Tags:

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


[ Top ]

method listStatics [line 534]

array listStatics( )



Tags:

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


[ Top ]

method setReturnsReference [line 553]

void setReturnsReference( )

sets $returnsreference to true



[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:33 -0600 by phpDocumentor 1.4.4