Description
parserBase | --parserElement | --parserGlobal
Located in File: /phpDocumentor/ParserElements.inc
- 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
Class Variables
Summary:
string
$datatype
string
$type
$datatype = 'mixed' (line 229)
Data type : string
Name of the global's data type
$type = 'global' (line 223)
Data type : string
Overrides: Array
Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
- var: - always 'global'
Class Constants
Summary:Method Detail
Summary:
Method getConflicts (line 251)
mixed getConflicts( Converter &$c)
Returns all global variables in other packages that have the same name as this global variable
Parameters
- Converter &$c:
Info
- return - false or an array Format: (package => parserGlobal of conflicting global variable)
- usedby - Converter::getFormattedConflicts()
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:
Info
Method getLink (line 237)
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:
Info
- return - converter-specific link to this global variable
Method setDataType (line 262)
void setDataType( string $type)
Sets the name of the global variable's type
Parameters
- string $type: