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

Class: parserVar

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

Class Overview

parserBase
   |
   --parserElement
      |
      --parserVar



Author(s):

Version:

  • $Id$

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

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


[ Top ]


Class Variables

$class =  ''

[line 1430]

  • Var: class that contains this var

Type:   string


[ Top ]

$type =  'var'

[line 1428]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserVar (Constructor)   [line 1437]

parserVar parserVar( string $class)


Parameters:

string   $class     

[ Top ]

getClass   [line 1446]

string getClass( )

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

[ Top ]

getLink   [line 1475]

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 ]

getModifiers   [line 1455]

array getModifiers( )

Return a list of access modifiers (static/private/etc.)

[ Top ]

getOverrides   [line 1488]

mixed getOverrides( Converter &$c)

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

Parameters:

Converter   &$c     

[ Top ]

getOverridingVars   [line 1547]

array getOverridingVars( Converter &$c)


Parameters:

Converter   &$c     

[ Top ]

getOverridingVarsForClass   [line 1559]

array getOverridingVarsForClass( Converter &$c, parserClass &$class)

  • Return: an array of parserVars from ALL child classes that override this var in the given class

Parameters:

Converter   &$c     
parserClass   &$class     

[ Top ]

setModifiers   [line 1464]

string setModifiers( $m)

Return name of the class that contains this method

Parameters:

   $m     

[ Top ]


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