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

Class: parserElement

Source Location: /phpDocumentor/ParserElements.inc

Class parserElement

Class Overview

all elements except parserPackagePage descend from this abstract class

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

parserBase
   |
   --parserElement
Author(s): API Tags:
Abstract:  

Information Tags:
Version:  $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
Copyright:  2002-2008 Gregory Beaver
Since:  1.0rc1

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserBase

parserBase::$type
parserBase::$value

Inherited From parserBase

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

[ Top ]
Property Summary
mixed   $conflicts  
mixed   $docblock  
false|integer   $endlinenumber   line number on file where this element stops
string   $file   location of this element (filename)
false|integer   $linenumber   Line number in the source on which this element appears
mixed   $name   name of this element, or include type if element is a parserInclude
string   $path   full path location of this element (filename)

[ Top ]
Method Summary
integer   getEndLineNumber()  
string   getFile()  
integer   getLineNumber()  
string   getName()  
string   getPackage()  
string   getPath()  
void   setDocBlock()  
void   setEndLineNumber()   Sets the ending line number of elements
void   setFile()  
void   setLineNumber()   Set starting line number
void   setName()  
void   setPath()  

[ Top ]
Properties
mixed   $conflicts = false [line 63]

[ Top ]
mixed   $docblock = false [line 54]

[ Top ]
false|integer   $endlinenumber = 0 [line 82]

line number on file where this element stops

Information Tags:
Since:  1.2

[ Top ]
string   $file = '' [line 69]

location of this element (filename)


[ Top ]
false|integer   $linenumber = false [line 89]

Line number in the source on which this element appears

Information Tags:
Since:  1.2

[ Top ]
mixed   $name [line 58]

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


[ Top ]
string   $path = '' [line 75]

full path location of this element (filename)


[ Top ]
Methods
getEndLineNumber  [line 136]

  integer getEndLineNumber( )



[ Top ]
getFile  [line 178]

  string getFile( )



[ Top ]
getLineNumber  [line 128]

  integer getLineNumber( )



[ Top ]
getName  [line 169]

  string getName( )



[ Top ]
getPackage  [line 142]

  string getPackage( )


API Tags:
Return:  package containing this element


[ Top ]
getPath  [line 187]

  string getPath( )



[ Top ]
setDocBlock  [line 94]

  void setDocBlock( parserDocBlock $docblock  )

Parameters:
parserDocBlock   $docblock: 


[ Top ]
setEndLineNumber  [line 120]

  void setEndLineNumber( integer $l  )

Sets the ending line number of elements

Parameters:
integer   $l: 


[ Top ]
setFile  [line 151]

  void setFile( string $file  )

Parameters:
string   $file: 


[ Top ]
setLineNumber  [line 111]

  void setLineNumber( integer $number  )

Set starting line number

Parameters:
integer   $number: 


[ Top ]
setName  [line 102]

  void setName( string $name  )

Parameters:
string   $name: 


[ Top ]
setPath  [line 157]

  void setPath( string $file  )

Parameters:
string   $file: 


[ Top ]

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