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

Class: parserClass

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

Class Overview

parserBase
   |
   --parserElement
      |
      --parserClass



Author(s):

Version:

  • $Id$

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

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


[ Top ]


Class Variables

$curfile =  false

[line 731]


Type:   string


[ Top ]

$extends =  false

[line 701]

  • Var: false or contents of extends clause in class declaration

Type:   mixed


[ Top ]

$ignore =  false

[line 726]

Used to determine whether a class should be ignored or not. Helps maintain integrity of parsing

Type:   boolean


[ Top ]

$parent =  false

[line 720]

Format: array(file, parent) where parent class is found or false if no parent

Type:   mixed


[ Top ]

$sourceLocation =  ''

[line 697]


Type:   string


[ Top ]

$tutorial =  false

[line 735]

  • Var: either a link to the tutorial associated with this class, or false

Type:   tutorialLink|false


[ Top ]

$type =  'class'

[line 694]

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

Type:   string
Overrides:   Array


[ Top ]



Method Detail

addImplements   [line 1385]

void addImplements( string $implements)


Parameters:

string   $implements     

[ Top ]

addTutorial   [line 761]

void addTutorial( parserTutorial $t, Converter &$c)


Parameters:

parserTutorial   $t     
Converter   &$c     

[ Top ]

getChildClassList   [line 1314]

array getChildClassList( Converter &$c)

returns a list of all child classes of this class

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getConflicts   [line 782]

mixed getConflicts( Converter &$c)

Returns all classes in other packages that have the same name as this class

Parameters:

Converter   &$c     

[ Top ]

getConstNames   [line 1040]

array getConstNames( Converter &$c)

  • Return: returns a simple array of const name strings

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getConsts   [line 1015]

array getConsts( Converter &$c)

  • Return: returns a simple array of const objects

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getExtends   [line 1402]

boolean getExtends( [ $raw = false])


Parameters:

   $raw     

[ Top ]

getImplements   [line 1393]

array getImplements( )


[ Top ]

getInheritedConsts   [line 1231]

array getInheritedConsts( Converter &$c, [boolean $override = false], [ $consts = false])

  • Return: returns an array of consts by parent classname array(name => array(const1,const2..),name2 => array(const1....))

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
boolean   $override     determines whether overriden vars should be included in the list of inherited vars
   $consts     

[ Top ]

getInheritedMethods   [line 1057]

array getInheritedMethods( Converter &$c, [boolean $override = false])

  • Return: returns an array of methods by parent classname array(name => array(method1,method2..),name2 => array(method1....))

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
boolean   $override     determines whether overriden methods should be included in the list of inherited methods

[ Top ]

getInheritedVars   [line 1155]

array getInheritedVars( Converter &$c, [boolean $override = true], [ $vars = false])

  • Return: returns an array of vars by parent classname array(name => array(var1,var1..),name2 => array(var1....))

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
boolean   $override     determines whether overriden vars should be included in the list of inherited vars
   $vars     

[ Top ]

getLink   [line 795]

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

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

Parameters:

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

[ Top ]

getMethod   [line 920]

mixed getMethod( Converter &$c, string $name, [boolean $inherited = false])


Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
string   $name     method name in this class
boolean   $inherited     determines whether to search inherited methods as well

[ Top ]

getMethodNames   [line 949]

array getMethodNames( Converter &$c)

  • Return: returns a simple array of method name strings

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getMethods   [line 909]

array getMethods( Converter &$c)

  • Return: returns a simple array of method objects

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getModifiers   [line 742]

array|false getModifiers( )

Get the PHP5+ modifiers for this class

(abstract/final/static/private/protected/public)


[ Top ]

getParent   [line 895]

mixed &getParent( Converter &$c)

retrieve object that represents the parent class
  • Return: returns the parserClass representation of the parent class, or false if no parent class

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getParentClassTree   [line 1295]

array getParentClassTree( Converter &$c)


Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getSourceLocation   [line 1343]

string getSourceLocation( Converter $c, [boolean $pearize = false])


Parameters:

Converter   $c     
boolean   $pearize     

[ Top ]

getTutorial   [line 772]

parserTutorial getTutorial( )

Get the associated tutorial for this class, if any

[ Top ]

getVar   [line 940]

mixed getVar( Converter &$c, string $name)


Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
string   $name     var name in this class

[ Top ]

getVarNames   [line 1024]

array getVarNames( Converter &$c)

  • Return: returns a simple array of var name strings

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

getVars   [line 1006]

array getVars( Converter &$c)

  • Return: returns a simple array of var objects

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing

[ Top ]

hasConst   [line 997]

boolean hasConst( Converter &$c, string $name)

  • Return: whether this class has a constant of name $name

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
string   $name     class constant name

[ Top ]

hasMethod   [line 967]

boolean hasMethod( Converter &$c, string $name, [boolean $inherited = false])

  • Return: whether this class has a method of name $name

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
string   $name     method name
boolean   $inherited     determines whether to search inherited methods as well

[ Top ]

hasVar   [line 987]

boolean hasVar( Converter &$c, string $name)

  • Return: whether this class has a var of name $name

Parameters:

Converter   &$c     this function will not work before the Conversion stage of parsing
string   $name     var name

[ Top ]

isInterface   [line 876]

boolean isInterface( )

  • Return: true if this is an interface class

[ Top ]

setAccessModifiers   [line 885]

void setAccessModifiers( array $modifiers)

Use this method to set access modifiers for a class

Parameters:

array   $modifiers     

[ Top ]

setExtends   [line 1368]

void setExtends( string $extends)


Parameters:

string   $extends     

[ Top ]

setInterface   [line 868]

void setInterface( )

Use this method to set the type of class to be an interface

[ Top ]

setModifiers   [line 752]

void setModifiers( string $m)

Set the PHP5+ modifiers for this class

(abstract/final/static/private/protected/public)


Parameters:

string   $m     

[ Top ]

setParent   [line 811]

void setParent( string $p, string $f, Classes &$c)


Parameters:

string   $p     parent class name
string   $f     parent class file
Classes   &$c     Classes object currently calling setParent

[ Top ]

setParentNoClass   [line 860]

void setParentNoClass( string $par)


Parameters:

string   $par     parent class name (used by Classes::setClassParent() if parent class not found

[ Top ]

setSourceLocation   [line 1332]

void setSourceLocation( string $sl)


Parameters:

string   $sl     

[ Top ]


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