Class: parserGlobal

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserGlobal

Author(s):

Greg Beaver <[email protected]>

Version:

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

Copyright:

2002-2008 Gregory Beaver

Inherited Variables

Class: parserElement

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

Inherited Methods

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

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 217]

Tags:

author:	Greg Beaver <[email protected]>
version:	$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
copyright:	2002-2008 Gregory Beaver
since:	1.1

[ Top ]

Class Variables

$datatype = 'mixed'

[line 229]

Name of the global's data type

Type:

string

[ 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

method getConflicts [line 251]

mixed getConflicts(
Converter
&$c)

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

Tags:

return:	false or an array Format: (package => parserGlobal of conflicting global variable)
usedby:	Converter::getFormattedConflicts()

Parameters:

Converter

&$c

[ Top ]

method getDataType [line 277]

string getDataType(
Converter
&$converter)

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:

Converter

&$converter

[ Top ]

method getLink [line 237]

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

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 ]

method setDataType [line 262]

void setDataType(
string
$type)

Sets the name of the global variable's type

Parameters:

string

$type

[ Top ]

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