Class parserElement

Description

all elements except parserPackagePage descend from this abstract class

  • author: Greg Beaver <[email protected]>
  • version: $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
  • copyright: 2002-2008 Gregory Beaver
  • abstract:
  • since: 1.0rc1

Located in /phpDocumentor/ParserElements.inc (line 49)

parserBase
   |
   --parserElement
Direct descendents
Variable Summary
mixed $conflicts
mixed $docblock
false|integer $endlinenumber
string $file
false|integer $linenumber
mixed $name
string $path
Method Summary
integer getEndLineNumber ()
string getFile ()
integer getLineNumber ()
string getName ()
string getPackage ()
string getPath ()
void setDocBlock (parserDocBlock $docblock)
void setEndLineNumber (integer $l)
void setFile (string $file)
void setLineNumber (integer $number)
void setName (string $name)
void setPath (string $file)
Variables
mixed $conflicts = false (line 63)
  • var: either false or an array of paths to files with conflicts
mixed $docblock = false (line 54)
false|integer $endlinenumber = 0 (line 82)

line number on file where this element stops

  • since: 1.2
string $file = '' (line 69)

location of this element (filename)

false|integer $linenumber = false (line 89)

Line number in the source on which this element appears

  • since: 1.2
mixed $name (line 58)

name of this element, or include type if element is a parserInclude

string $path = '' (line 75)

full path location of this element (filename)

Inherited Variables

Inherited from parserBase

parserBase::$type
parserBase::$value
Methods
getEndLineNumber (line 136)
integer getEndLineNumber ()
getFile (line 178)
string getFile ()
getLineNumber (line 128)
integer getLineNumber ()
getName (line 169)
string getName ()
getPackage (line 142)
  • return: package containing this element
string getPackage ()
getPath (line 187)
string getPath ()
setDocBlock (line 94)
void setDocBlock (parserDocBlock $docblock)
setEndLineNumber (line 120)

Sets the ending line number of elements

void setEndLineNumber (integer $l)
  • integer $l
setFile (line 151)
void setFile (string $file)
  • string $file
setLineNumber (line 111)

Set starting line number

void setLineNumber (integer $number)
  • integer $number
setName (line 102)
void setName (string $name)
  • string $name
setPath (line 157)
void setPath (string $file)
  • string $file

Inherited Methods

Inherited From parserBase

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

Documentation generated on Mon, 05 Dec 2011 21:00:42 -0600 by phpDocumentor 1.4.4