Class: parserGlobal

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 217]

parserBase
   |
   --parserElement
      |
      --parserGlobal

Author(s):

Version:

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

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods




Class Details

Tags:

[ Top ]


Class Variables

$datatype =  'mixed'

[line 229]

Name of the global's data type

Type: string

Overrides:

[ Top ]

$type =  'global'

[line 223]

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

Tags:

  • var - always 'global'

Type: string

Overrides: Array

[ Top ]


Class Methods

getConflicts

mixed getConflicts( Converter &$c)

[line 251]

Returns all global variables in other packages that have the same name as this global variable

Tags:

Parameters:

[ Top ]

getDataType

string getDataType( Converter &$converter)

[line 277]

Retrieve converter-specific representation of the data type

If the data type is a documented class name, then this function will return a Converter-specific link to that class's documentation, so users can click/browse to the documentation directly from the global variable declaration

Parameters:

[ Top ]

getLink

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

[line 237]

quick way to link to this element

Tags:

  • return - converter-specific link to this global variable

Parameters:

  • Converter &$c -
  • string $text - text to display for the link or false for default text
  • $returnobj -

[ Top ]

setDataType

void setDataType( string $type)

[line 262]

Sets the name of the global variable's type

Parameters:

  • string $type -

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:21 -0600 by phpDocumentor 1.4.4