Class: parserElement

Source Location: /PhpDocumentor-1.4.0/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement

all elements except parserPackagePage descend from this abstract class

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: ParserElements.inc,v 1.19 2007/04/24 21:30:50 ashnazg Exp $

Variables

Methods

Child classes:

parserInclude

parserGlobal

parserFunction

parserClass

parserVar

parserConst

parserDefine

Inherited Variables

Class: parserBase

parserBase::$type
parserBase::$value

Inherited Methods

Class: parserBase

parserBase::getType()
parserBase::getValue()
parserBase::setValue()

Class Details

[line 49]
all elements except parserPackagePage descend from this abstract class

Author: Greg Beaver <cellog@php.net>
Version: $Id: ParserElements.inc,v 1.19 2007/04/24 21:30:50 ashnazg Exp $
Abstract:
Since: 1.0rc1

[ Top ]

Class Variables

$conflicts = false

[line 63]

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

Type:

mixed

[ Top ]

$docblock = false

[line 54]

Var: either false or a parserDocBlock

Type:

mixed

[ Top ]

$endlinenumber = 0

[line 82]

line number on file where this element stops

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

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 ]

Method Detail

getEndLineNumber [line 136]

integer getEndLineNumber(
)

[ Top ]

getFile [line 179]

string getFile(
)

[ Top ]

getLineNumber [line 128]

integer getLineNumber(
)

[ Top ]

getName [line 170]

string getName(
)

[ Top ]

getPackage [line 142]

string getPackage(
)

Return: package containing this element

[ Top ]

getPath [line 188]

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 ]