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

Class: parserConst

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

Class Overview

parserBase
   |
   --parserElement
      |
      --parserConst



Author(s):

Version:

  • $Id$

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 1586]
  • Author: Greg Beaver <cellog@php.net>
  • Version: $Id$
  • Copyright: 2002-2008 Gregory Beaver
  • Since: 1.2.4


[ Top ]


Class Variables

$class =  ''

[line 1594]

  • Var: class that contains this var

Type:   string


[ Top ]

$type =  'const'

[line 1592]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserConst (Constructor)   [line 1599]

parserConst parserConst( string $class)


Parameters:

string   $class     

[ Top ]

getClass   [line 1608]

string getClass( )

Retrieve the class name
  • Return: Class name that this var belongs to

[ Top ]

getLink   [line 1619]

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

quick way to link to this element
  • Return: converter-specific link to this var

Parameters:

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

[ Top ]


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