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

Class: parserVar

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserVar



Author(s):

Version:

  • $Id: ParserElements.inc,v 1.33 2003/01/14 08:40:36 CelloG Exp $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 978]


[ Top ]


Class Variables

$class =  ''

[line 986]

  • Var: class that contains this var

Type:   string


[ Top ]

$type =  'var'

[line 984]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserVar (Constructor)   [line 991]

parserVar parserVar( string $class)


Parameters:

string   $class     

[ Top ]

getLink   [line 1002]

mixed getLink( Converter $c, [string $text = false], [mixed $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

[ Top ]

getOverrides   [line 1019]

mixed getOverrides( Converter &$c)

  • Return: parserVar representing var this var overrides from the parent class, or false if none

Parameters:

Converter   &$c     

[ Top ]


Documentation generated on Fri, 30 Apr 2004 22:10:32 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.