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

Class: parserElement

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

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

Methods


Child classes:

Inherited Variables

Inherited Methods

Class: parserBase

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

Class Details



[ Top ]


Class Variables

$conflicts =  false

[line 63]



Tags:

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

Type:   mixed


[ Top ]

$docblock =  false

[line 54]



Tags:

var:  either false or a parserDocBlock

Type:   mixed


[ Top ]

$endlinenumber =  0

[line 82]

line number on file where this element stops



Tags:

since:  1.2

Type:   false|integer


[ Top ]

$file =  ''

[line 69]

location of this element (filename)


Type:   string


[ Top ]

$linenumber =  false

[line 89]

Line number in the source on which this element appears



Tags:

since:  1.2

Type:   false|integer


[ Top ]

$name =

[line 58]

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


Type:   mixed


[ Top ]

$path =  ''

[line 75]

full path location of this element (filename)


Type:   string


[ Top ]



Class Methods


method getEndLineNumber [line 136]

integer getEndLineNumber( )



[ Top ]

method getFile [line 178]

string getFile( )



[ Top ]

method getLineNumber [line 128]

integer getLineNumber( )



[ Top ]

method getName [line 169]

string getName( )



[ Top ]

method getPackage [line 142]

string getPackage( )



Tags:

return:  package containing this element


[ Top ]

method getPath [line 187]

string getPath( )



[ Top ]

method setDocBlock [line 94]

void setDocBlock( parserDocBlock $docblock)



Parameters:

parserDocBlock   $docblock  

[ Top ]

method setEndLineNumber [line 120]

void setEndLineNumber( integer $l)

Sets the ending line number of elements



Parameters:

integer   $l  

[ Top ]

method setFile [line 151]

void setFile( string $file)



Parameters:

string   $file  

[ Top ]

method setLineNumber [line 111]

void setLineNumber( integer $number)

Set starting line number



Parameters:

integer   $number  

[ Top ]

method setName [line 102]

void setName( string $name)



Parameters:

string   $name  

[ Top ]

method setPath [line 157]

void setPath( string $file)



Parameters:

string   $file  

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:32 -0600 by phpDocumentor 1.4.4