Class parserElement

(line 49)

Description

parserBase
   |
   --parserElement

Located in File: /phpDocumentor/ParserElements.inc

all elements except parserPackagePage descend from this abstract class


Classes extended from parserElement:
parserInclude
parserGlobal
parserFunction
parserClass
parserVar
parserConst
parserDefine

Class Variables

Summary:
mixed $conflicts
mixed $docblock
false|integer $endlinenumber
string $file
false|integer $linenumber
mixed $name
string $path

$conflicts = false (line 63)

Data type : mixed

  • var: - either false or an array of paths to files with conflicts

$docblock = false (line 54)

Data type : mixed

$endlinenumber = 0 (line 82)

Data type : false|integer

line number on file where this element stops
  • since: - 1.2

$file = '' (line 69)

Data type : string

location of this element (filename)

$linenumber = false (line 89)

Data type : false|integer

Line number in the source on which this element appears
  • since: - 1.2

$name (line 58)

Data type : mixed

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

$path = '' (line 75)

Data type : string

full path location of this element (filename)

Class Constants

Summary:

Method Detail

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)

Method getEndLineNumber (line 136)

integer getEndLineNumber( )

Info

Method getFile (line 178)

string getFile( )

Info

Method getLineNumber (line 128)

integer getLineNumber( )

Info

Method getName (line 169)

string getName( )

Info

Method getPackage (line 142)

string getPackage( )

Info

  • return - package containing this element

Method getPath (line 187)

string getPath( )

Info

Method setDocBlock (line 94)

void setDocBlock( parserDocBlock $docblock)

Parameters

Info

Method setEndLineNumber (line 120)

void setEndLineNumber( integer $l)

Sets the ending line number of elements

Parameters

  • integer $l:

Info

Method setFile (line 151)

void setFile( string $file)

Parameters

  • string $file:

Info

Method setLineNumber (line 111)

void setLineNumber( integer $number)

Set starting line number

Parameters

  • integer $number:

Info

Method setName (line 102)

void setName( string $name)

Parameters

  • string $name:

Info

Method setPath (line 157)

void setPath( string $file)

Parameters

  • string $file:

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserBase

parserBase::$type - Type is used by many functions to skip the hassle of if

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



Documentation generated on Mon, 05 Dec 2011 21:28:43 -0600 by phpDocumentor 1.4.4