Class: parserDefine

Source Location: /phpDocumentor/ParserElements.inc

Class parserDefine

Class Overview

Located in /phpDocumentor/ParserElements.inc [line 1983]

parserBase
   |
   --parserElement
      |
      --parserDefine

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserElements.inc,v 1.15 2006/08/17 02:36:50 cellog Exp $
Since:	1.0rc1

Properties

$type

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserElement

parserElement::$conflicts

parserElement::$docblock

parserElement::$endlinenumber

parserElement::$file

parserElement::$linenumber

parserElement::$name

parserElement::$path

Inherited From parserBase

parserBase::$value

Inherited From 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()

Inherited From parserBase

parserBase::getType()

parserBase::getValue()

parserBase::setValue()

[ Top ]

Property Summary

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 defines in other packages that have the same name as this define
mixed	getLink()	quick way to link to this element

[ Top ]

Properties

string $type = 'define' [line 1989]

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 phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Methods

getConflicts [line 2011]

mixed getConflicts(
Converter
&$c 
)

Returns all defines in other packages that have the same name as this define

Parameters:

Converter

&$c:

API Tags:

Return:	false or an array Format: (package => parserDefine of conflicting defines)
Usedby:	Converter::getFormattedConflicts()

[ Top ]

getLink [line 1997]

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 define

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:25:14 -0500 by phpDocumentor 1.3.1

	phpDocumentor ParserElements

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