Class: parserConst

Source Location: /phpDocumentor/ParserElements.inc

Class parserConst

Class Overview

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

parserBase
   |
   --parserElement
      |
      --parserConst

Author(s):

Greg Beaver <[email protected]>

Information Tags:

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

Properties

$class
$type

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserElement

parserElement::$conflicts

parserElement::$docblock

parserElement::$endlinenumber

parserElement::$file

parserElement::$linenumber

parserElement::$name

parserElement::$path

Inherited From parserBase

parserBase::$value

Inherited From parserElement

parserElement::getEndLineNumber()

parserElement::getFile()

parserElement::getLineNumber()

parserElement::getName()

parserElement::getPackage()

parserElement::getPath()

parserElement::setDocBlock()

parserElement::setEndLineNumber()

Sets the ending line number of elements

parserElement::setFile()

parserElement::setLineNumber()

Set starting line number

parserElement::setName()

parserElement::setPath()

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string	$class
string	$type	Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Method Summary

parserConst	parserConst()
string	getClass()	Retrieve the class name
mixed	getLink()	quick way to link to this element

[ Top ]

Properties

string $class = '' [line 1586]

[ Top ]

string $type = 'const' [line 1584]

Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

Redefinition of:

parserBase::$type: Type is used by many functions to skip the hassle of if

[ Top ]

Methods

Constructor parserConst [line 1591]

parserConst parserConst(
string
$class 
)

Parameters:

string

$class:

[ Top ]

getClass [line 1600]

string getClass(
)

Retrieve the class name

API Tags:

Return:

Class name that this var belongs to

[ Top ]

getLink [line 1611]

mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false] 
)

quick way to link to this element

Parameters:

Converter	$c:
string	$text:	text to display for the link or false for default text
	$returnobj:

API Tags:

Return:

converter-specific link to this var

[ Top ]

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

	phpDocumentor ParserElements

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