Class parserGlobal

Description
Variable Summary
 string $datatype
 string $type
Method Summary
 mixed getConflicts (Converter &$c)
 string getDataType (Converter &$converter)
 mixed getLink (Converter &$c, [string $text = false], [ $returnobj = false])
 void setDataType (string $type)
Variables
string $datatype = 'mixed' (line 229)

Name of the global's data type

string $type = 'global' (line 223)

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

  • var: always 'global'

Redefinition of:
parserBase::$type
Type is used by many functions to skip the hassle of if

Inherited Variables

Inherited from parserElement

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

Inherited from parserBase

parserBase::$value
Methods
getConflicts (line 251)

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

mixed getConflicts (Converter &$c)
getDataType (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

string getDataType (Converter &$converter)
getLink (line 237)

quick way to link to this element

  • return: converter-specific link to this global variable
mixed getLink (Converter &$c, [string $text = false], [ $returnobj = false])
  • Converter &$c
  • string $text: text to display for the link or false for default text
  • $returnobj
setDataType (line 262)

Sets the name of the global variable's type

void setDataType (string $type)
  • string $type

Inherited Methods

Inherited From parserElement

 parserElement::getEndLineNumber()
 parserElement::getFile()
 parserElement::getLineNumber()
 parserElement::getName()
 parserElement::getPackage()
 parserElement::getPath()
 parserElement::setDocBlock()
 parserElement::setEndLineNumber()
 parserElement::setFile()
 parserElement::setLineNumber()
 parserElement::setName()
 parserElement::setPath()

Inherited From parserBase

 parserBase::getType()
 parserBase::getValue()
 parserBase::setValue()

Documentation generated on Mon, 05 Dec 2011 21:06:23 -0600 by phpDocumentor 1.4.4