phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]
Packages:
PhpDocumentor
apidoc
Converters
HTML_TreeMenu
Pdf-php
PEAR
phpDocumentor
Smarty
tests


Tutorials/Manuals:
Package-level: Files:
Classes.inc
common.inc.php
create_examples.php
EventStack.inc
IntermediateParser.inc
Io.inc
new_phpdoc.php
phpdoc.inc
phpdoc.php
ProceduralPages.inc
Publisher.inc
Template.inc
WordParser.inc

subpackage DescHTML
DescHTML.inc

subpackage DocBlockTags
DocBlockTags.inc

subpackage Errors
Errors.inc

subpackage InlineTags
InlineTags.inc

subpackage Links
LinkClasses.inc

subpackage ParserData
ParserData.inc

subpackage ParserDocBlock
ParserDocBlock.inc

subpackage ParserElements
ParserElements.inc

subpackage Parsers
Parser.inc
ParserDescCleanup.inc
phpDocumentorTParser.inc
XMLpackagePageParser.inc

subpackage Tutorial
PackagePageElements.inc

Classes:
Classes
EventStack
Io
phpDocumentor_IntermediateParser
phpDocumentor_setup
ProceduralPages
Publisher
Template
DescHTML
   parserB
   parserBr
   parserCode
   parserI
   parserList
   parserPre
PhpDocumentor-1.2.0beta2
   classLink
   defineLink
   DirNode
   functionLink
   globalLink
   methodLink
   pageLink
   parserAccessTag
   parserClass
   parserDefine
   parserElement
   parserExampleTag
   parserFileSourceTag
   parserFunction
   parserGlobal
   parserIdInlineTag
   parserInclude
   parserInheritdocInlineTag
   parserLinkInlineTag
   parserLinkTag
   parserMethod
   parserNameTag
   parserPackagePage
   parserParamTag
   parserReturnTag
   parserSeeTag
   parserSourceInlineTag
   parserSourceTag
   parserStaticvarTag
   parserStringWithInlineTags
   parserTocInlineTag
   parserTutorial
   parserTutorialInlineTag
   parserTutorialTag
   parserUsedByTag
   parserUsesTag
   parserVar
   parserVarTag
   phpDocumentorTWordParser
   RecordException
   tutorialLink
   varLink
DocBlockTags
   parserTag
Errors
   ErrorTracker
   RecordError
   RecordWarning
InlineTags
   parserInlineTag
Links
   abstractLink
Tutorial
   parserCData
   parserXMLDocBookTag
Parsers
   Parser
   parserDescParser
   phpDocumentorTParser
   ppageParser
   XMLPackagePageParser
ParserData
   parserBase
   parserData
   parserPage
WordParsers
   ObjectWordParser
   WordParser
ParserDocBlock
   parserDesc
   parserDocBlock

Class: parserGlobal

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserGlobal



Author(s):

Version:

  • $Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $

Variables

Methods

Inherited Variables

Class: parserElement

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

Class: parserBase

parserBase::$linenum
parserBase::$value

Inherited Methods

Class: parserElement

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

Class: parserBase

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

Class Details

[line 152]


[ Top ]

Class Variables

$datatype =  'mixed'

[line 164]

Name of the global's data type

Type:   string


[ Top ]

$type =  'global'

[line 158]

Type is used by many functions to skip the hassle of if get_class($blah) == 'parserBlah'
  • Var: always 'global'

Type:   string
Overrides:   Array


[ Top ]


Method Detail

getConflicts   [line 190]

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)

Parameters:

Converter   &$c   —   

[ Top ]

getDataType   [line 202]

void getDataType( mixed &$converter)


[ Top ]

getLink   [line 172]

mixed getLink( Converter &$c, [string $text = false], [mixed $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

[ Top ]

setDataType   [line 197]

void setDataType( mixed $type)


[ Top ]
Documentation generated on Fri, 30 Apr 2004 22:10:29 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.