Class: parserElement

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 49]

parserBase
   |
   --parserElement

all elements except parserPackagePage descend from this abstract class

Author(s):

Version:

  • $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods

Child classes:

parserInclude
parserGlobal
parserFunction
parserClass
parserVar
parserConst
parserDefine

Inherited Variables

Class: parserBase

parserBase::$type
parserBase::$value

Inherited Constants

Inherited Methods

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

Class Details

all elements except parserPackagePage descend from this abstract class

Tags:

[ Top ]

Class Variables

$conflicts =  false

[line 63]

Tags:

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

Type: mixed

Overrides:

[ Top ]

$docblock =  false

[line 54]

Tags:

Type: mixed

Overrides:

[ Top ]

$endlinenumber =  0

[line 82]

line number on file where this element stops

Tags:

  • since - 1.2

Type: false|integer

Overrides:

[ Top ]

$file =  ''

[line 69]

location of this element (filename)

Type: string

Overrides:

[ Top ]

$linenumber =  false

[line 89]

Line number in the source on which this element appears

Tags:

  • since - 1.2

Type: false|integer

Overrides:

[ Top ]

$name

[line 58]

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

Type: mixed

Overrides:

[ Top ]

$path =  ''

[line 75]

full path location of this element (filename)

Type: string

Overrides:

[ Top ]

Class Methods

getEndLineNumber

integer getEndLineNumber( )

[line 136]

Parameters:

[ Top ]

getFile

string getFile( )

[line 178]

Parameters:

[ Top ]

getLineNumber

integer getLineNumber( )

[line 128]

Parameters:

[ Top ]

getName

string getName( )

[line 169]

Parameters:

[ Top ]

getPackage

string getPackage( )

[line 142]

Tags:

  • return - package containing this element

Parameters:

[ Top ]

getPath

string getPath( )

[line 187]

Parameters:

[ Top ]

setDocBlock

void setDocBlock( parserDocBlock $docblock)

[line 94]

Parameters:

[ Top ]

setEndLineNumber

void setEndLineNumber( integer $l)

[line 120]

Sets the ending line number of elements

Parameters:

  • integer $l -

[ Top ]

setFile

void setFile( string $file)

[line 151]

Parameters:

  • string $file -

[ Top ]

setLineNumber

void setLineNumber( integer $number)

[line 111]

Set starting line number

Parameters:

  • integer $number -

[ Top ]

setName

void setName( string $name)

[line 102]

Parameters:

  • string $name -

[ Top ]

setPath

void setPath( string $file)

[line 157]

Parameters:

  • string $file -

[ Top ]

Class Constants

Documentation generated on Tue, 06 Dec 2011 07:08:20 -0600 by phpDocumentor 1.4.4