Class: parserVar

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 1415]

parserBase
   |
   --parserElement
      |
      --parserVar

Author(s):

Version:

  • $Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Constants

Methods




Class Details

Tags:

[ Top ]


Class Variables

$class =  ''

[line 1423]

Tags:

  • var - class that contains this var

Type: string

Overrides:

[ Top ]

$type =  'var'

[line 1421]

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

Tags:

  • var - always 'var'

Type: string

Overrides: Array

[ Top ]

$_modifiers

[line 1425]

Type: array

Overrides:

[ Top ]


Class Methods

parserVar

parserVar parserVar( string $class)

[line 1430]

Parameters:

  • string $class -

[ Top ]

getClass

string getClass( )

[line 1439]

Retrieve the class name

Tags:

  • return - Class name that this var belongs to

Parameters:

[ Top ]

getLink

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

[line 1468]

quick way to link to this element

Tags:

  • 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

array getModifiers( )

[line 1448]

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

Parameters:

[ Top ]

getOverrides

mixed getOverrides( Converter &$c)

[line 1481]

Tags:

  • return - parserVar representing var this var overrides from the parent class, or false if none

Parameters:

[ Top ]

getOverridingVars

array getOverridingVars( Converter &$c)

[line 1540]

Tags:

Parameters:

[ Top ]

getOverridingVarsForClass

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

[line 1552]

Tags:

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

Parameters:

[ Top ]

setModifiers

string setModifiers( $m)

[line 1457]

Return name of the class that contains this method

Parameters:

  • $m -

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:24 -0600 by phpDocumentor 1.4.4