Docs For Class parserConst

Description

parserBase
   |
   --parserElement
      |
      --parserConst

Located in File: /phpDocumentor/ParserElements.inc

author: - Greg Beaver <[email protected]>
version: - $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
copyright: - 2002-2008 Gregory Beaver
since: - 1.2.4

Class Variables

Summary:

string $class

string $type

$class = '' (line 1586)

Data type : string

var: - class that contains this var

$type = 'const' (line 1584)

Data type : string

Overrides: Array

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

var: - always 'const'

Class Constants

Summary:

Method Detail

Summary:

parserConst parserConst (string $class)

string getClass ()

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

Constructor parserConst (line 1591)

parserConst parserConst( string $class)

Parameters

string $class:

Info

Method getClass (line 1600)

string getClass( )

Retrieve the class name

Info

return - Class name that this var belongs to

Method 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:

Info

return - converter-specific link to this var

Class parserConst

Description

Class Variables

$class = '' (line 1586)

Data type : string

$type = 'const' (line 1584)

Data type : string

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

Class Constants

Method Detail

Constructor parserConst (line 1591)

parserConst parserConst( string $class)

Parameters

Info

Method getClass (line 1600)

string getClass( )

Retrieve the class name

Info

Method getLink (line 1611)

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

quick way to link to this element

Parameters

Info

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserElement

parserElement::$conflicts -

parserElement::$docblock -

parserElement::$endlinenumber - line number on file where this element stops

parserElement::$file - location of this element (filename)

parserElement::$linenumber - Line number in the source on which this element appears

parserElement::$name - name of this element, or include type if element is a parserInclude

parserElement::$path - full path location of this element (filename)

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class 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 Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value