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

Class: parserVar

Source Location: /phpDocumentor/ParserElements.inc

Class parserVar

Class Overview

Located in /phpDocumentor/ParserElements.inc [line 1415]

parserBase
   |
   --parserElement
      |
      --parserVar
Author(s): Information Tags:
Version:  $Id: ParserElements.inc,v 1.15 2006/08/17 02:36:50 cellog Exp $
Since:  1.0rc1

Properties

Methods

[ Top ]
Property Summary
string   $class  
string   $type   Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
array   $_modifiers  

[ Top ]
Method Summary
parserVar   parserVar()  
string   getClass()   Retrieve the class name
mixed   getLink()   quick way to link to this element
array   getModifiers()   Return a list of access modifiers (static/private/etc.)
mixed   getOverrides()  
array   getOverridingVars()  
array   getOverridingVarsForClass()  
string   setModifiers()   Return name of the class that contains this method

[ Top ]
Properties
string   $class = '' [line 1423]

[ Top ]
string   $type = 'var' [line 1421]

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


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

[ Top ]
array   $_modifiers [line 1425]

[ Top ]
Methods
Constructor parserVar  [line 1430]

  parserVar parserVar( string $class  )

Parameters:
string   $class: 


[ Top ]
getClass  [line 1439]

  string getClass( )

Retrieve the class name


API Tags:
Return:  Class name that this var belongs to


[ Top ]
getLink  [line 1468]

  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: 

API Tags:
Return:  converter-specific link to this var


[ Top ]
getModifiers  [line 1448]

  array getModifiers( )

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



[ Top ]
getOverrides  [line 1481]

  mixed getOverrides( Converter &$c  )

Parameters:
Converter   &$c: 

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


[ Top ]
getOverridingVars  [line 1540]

  array getOverridingVars( Converter &$c  )

Parameters:
Converter   &$c: 

API Tags:
Return:  an array of parserVars from ALL child classes that override this var
Usedby:  Converter::getFormattedDescVars()


[ Top ]
getOverridingVarsForClass  [line 1552]

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

Parameters:
Converter   &$c: 
parserClass   &$class: 

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


[ Top ]
setModifiers  [line 1457]

  string setModifiers( $m  )

Return name of the class that contains this method

Parameters:
   $m: 


[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:25:17 -0500 by phpDocumentor 1.3.1