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

Class: parserElement

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement

all elements except parserPackagePage descend from this abstract class


Author(s):

Version:

  • $Id$

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

[line 51]
all elements except parserPackagePage descend from this abstract class
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • Copyright: 2002-2008 Gregory Beaver
  • Abstract:
  • Since: 1.0rc1


[ Top ]


Class Variables

$conflicts =  false

[line 65]

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

Type:   mixed


[ Top ]

$docblock =  false

[line 56]


Type:   mixed


[ Top ]

$endlinenumber =  0

[line 84]

line number on file where this element stops
  • Since: 1.2

Type:   false|integer


[ Top ]

$file =  ''

[line 71]

location of this element (filename)

Type:   string


[ Top ]

$linenumber =  false

[line 91]

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

Type:   false|integer


[ Top ]

$name =

[line 60]

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

Type:   mixed


[ Top ]

$path =  ''

[line 77]

full path location of this element (filename)

Type:   string


[ Top ]



Method Detail

getEndLineNumber   [line 138]

integer getEndLineNumber( )


[ Top ]

getFile   [line 180]

string getFile( )


[ Top ]

getLineNumber   [line 130]

integer getLineNumber( )


[ Top ]

getName   [line 171]

string getName( )


[ Top ]

getPackage   [line 144]

string getPackage( )

  • Return: package containing this element

[ Top ]

getPath   [line 189]

string getPath( )


[ Top ]

setDocBlock   [line 96]

void setDocBlock( parserDocBlock $docblock)


Parameters:

parserDocBlock   $docblock     

[ Top ]

setEndLineNumber   [line 122]

void setEndLineNumber( integer $l)

Sets the ending line number of elements

Parameters:

integer   $l     

[ Top ]

setFile   [line 153]

void setFile( string $file)


Parameters:

string   $file     

[ Top ]

setLineNumber   [line 113]

void setLineNumber( integer $number)

Set starting line number

Parameters:

integer   $number     

[ Top ]

setName   [line 104]

void setName( string $name)


Parameters:

string   $name     

[ Top ]

setPath   [line 159]

void setPath( string $file)


Parameters:

string   $file     

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:40 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.