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

Class: parserGlobal

Source Location: /phpDocumentor/ParserElements.inc

Class parserGlobal

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

Name of the global's data type


[ Top ]
string   $type = 'global' [line 223]

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

[ Top ]
Methods
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: 

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


[ Top ]
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 ]
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: 

API Tags:
Return:  converter-specific link to this global variable


[ Top ]
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:20:47 -0600 by phpDocumentor 1.4.4