Class: parserClass

Source Location: /phpDocumentor/ParserElements.inc

Class Overview [line 682]

parserBase
   |
   --parserElement
      |
      --parserClass

Variables

Constants

Methods




Class Details

Tags:

[ Top ]


Class Variables

$curfile =  false

[line 725]

Tags:

Type: string

Overrides:

[ Top ]

$extends =  false

[line 695]

Tags:

  • var - false or contents of extends clause in class declaration

Type: mixed

Overrides:

[ Top ]

$ignore =  false

[line 720]

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

Tags:

Type: boolean

Overrides:

[ Top ]

$parent =  false

[line 714]

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

Type: mixed

Overrides:

[ Top ]

$sourceLocation =  ''

[line 691]

Tags:

Type: string

Overrides:

[ Top ]

$tutorial =  false

[line 729]

Tags:

  • var - either a link to the tutorial associated with this class, or false

Type: tutorialLink|false

Overrides:

[ Top ]

$type =  'class'

[line 688]

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

Tags:

  • var - always 'class'

Type: string

Overrides: Array

[ Top ]

$_implements = array()

[line 699]

Tags:

  • var - a list of interfaces this class implements

Type: array

Overrides:

[ Top ]


Class Methods

addImplements

void addImplements( string $implements)

[line 1379]

Parameters:

  • string $implements -

[ Top ]

addTutorial

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

[line 755]

Parameters:

[ Top ]

getChildClassList

array getChildClassList( Converter &$c)

[line 1308]

returns a list of all child classes of this class

Tags:

Parameters:

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

[ Top ]

getConflicts

mixed getConflicts( Converter &$c)

[line 776]

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

Tags:

Parameters:

[ Top ]

getConstNames

array getConstNames( Converter &$c)

[line 1034]

Tags:

  • 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

array getConsts( Converter &$c)

[line 1009]

Tags:

  • return - returns a simple array of const objects

Parameters:

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

[ Top ]

getExtends

boolean getExtends( [ $raw = false])

[line 1396]

Tags:

Parameters:

  • $raw -

[ Top ]

getImplements

array getImplements( )

[line 1387]

Parameters:

[ Top ]

getInheritedConsts

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

[line 1225]

Tags:

  • 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

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

[line 1051]

Tags:

  • 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

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

[line 1149]

Tags:

  • 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

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

[line 789]

quick way to link to this element

Tags:

  • 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

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

[line 914]

Tags:

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

array getMethodNames( Converter &$c)

[line 943]

Tags:

  • 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

array getMethods( Converter &$c)

[line 903]

Tags:

  • return - returns a simple array of method objects

Parameters:

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

[ Top ]

getModifiers

array|false getModifiers( )

[line 736]

Get the PHP5+ modifiers for this class

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

Parameters:

[ Top ]

getParent

mixed &getParent( Converter &$c)

[line 889]

retrieve object that represents the parent class

Tags:

  • 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

array getParentClassTree( Converter &$c)

[line 1289]

Tags:

Parameters:

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

[ Top ]

getSourceLocation

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

[line 1337]

Tags:

Parameters:

[ Top ]

getTutorial

parserTutorial getTutorial( )

[line 766]

Get the associated tutorial for this class, if any

Tags:

Parameters:

[ Top ]

getVar

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

[line 934]

Tags:

Parameters:

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

[ Top ]

getVarNames

array getVarNames( Converter &$c)

[line 1018]

Tags:

  • 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

array getVars( Converter &$c)

[line 1000]

Tags:

  • return - returns a simple array of var objects

Parameters:

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

[ Top ]

hasConst

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

[line 991]

Tags:

  • 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

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

[line 961]

Tags:

  • 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

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

[line 981]

Tags:

  • 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

boolean isInterface( )

[line 870]

Tags:

  • return - true if this is an interface class

Parameters:

[ Top ]

setAccessModifiers

void setAccessModifiers( array $modifiers)

[line 879]

Use this method to set access modifiers for a class

Parameters:

  • array $modifiers -

[ Top ]

setExtends

void setExtends( string $extends)

[line 1362]

Tags:

Parameters:

  • string $extends -

[ Top ]

setInterface

void setInterface( )

[line 862]

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

Parameters:

[ Top ]

setModifiers

void setModifiers( string $m)

[line 746]

Set the PHP5+ modifiers for this class

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

Parameters:

  • string $m -

[ Top ]

setParent

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

[line 805]

Tags:

Parameters:

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

[ Top ]

setParentNoClass

void setParentNoClass( string $par)

[line 854]

Parameters:

[ Top ]

setSourceLocation

void setSourceLocation( string $sl)

[line 1326]

Tags:

Parameters:

  • string $sl -

[ Top ]


Class Constants


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