Class: parserGlobal

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserGlobal

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id$

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 221]

Author: Greg Beaver <cellog@php.net>
Version: $Id$
Copyright: 2002-2008 Gregory Beaver
Since: 1.1

[ Top ]

Class Variables

$datatype = 'mixed'

[line 233]

Name of the global's data type

Type:

string

[ Top ]

$type = 'global'

[line 227]

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

Var: always 'global'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

getConflicts [line 255]

mixed getConflicts(
Converter
&$c)

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

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

Parameters:

Converter &$c —

[ Top ]

getDataType [line 281]

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 241]

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

quick way to link to this element

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 [line 266]

void setDataType(
string
$type)

Sets the name of the global variable's type

Parameters:

string $type —

[ Top ]