Class: parserGlobal

Source Location: /phpDocumentor/ParserElements.inc

Class parserGlobal

Class Overview

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

parserBase
   |
   --parserElement
      |
      --parserGlobal

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserElements.inc,v 1.15 2006/08/17 02:36:50 cellog Exp $
Since:	1.1

Properties

Methods

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

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

string	$datatype	Name of the global's data type
string	$type	Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Method Summary

mixed	getConflicts()	Returns all global variables in other packages that have the same name as this global variable
string	getDataType()	Retrieve converter-specific representation of the data type
mixed	getLink()	quick way to link to this element
void	setDataType()	Sets the name of the global variable's type

[ Top ]

Properties

string $datatype = 'mixed' [line 230]

Name of the global's data type

[ Top ]

string $type = 'global' [line 224]

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 phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Methods

getConflicts [line 252]

mixed getConflicts(
Converter
&$c 
)

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

Parameters:

Converter

&$c:

API Tags:

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

[ Top ]

getDataType [line 278]

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 ]

getLink [line 238]

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 global variable

[ Top ]

setDataType [line 263]

void setDataType(
string
$type 
)

Sets the name of the global variable's type

Parameters:

string

$type:

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:25:15 -0500 by phpDocumentor 1.3.1

	phpDocumentor ParserElements

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