Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/cch/www/pear/PHPDoc/accessor/PhpdocClassAccessor.php
PEAR Repository - PHPDoc

PhpdocClassAccessor

PhpdocObject
   |
  +-- PhpdocAccessor
     |
    +-- PhpdocDocumentAccessor
       |
      +-- PhpdocClassAccessor

Provides functions to access phpdoc xml documents that contain classes.

 

private class PhpdocClassAccessor extends PhpdocDocumentAccessor

Provides functions to access phpdoc xml documents that contain classes.

AuthorsUlf Wendel <ulf.wendel@phpdoc.de>
Version1.0

 

Methods inherited from PhpdocDocumentAccessor

getfunctions, getfunctionsbyaccess, getvariables, getvariablesbyaccess, getconstants, getconstantsbyaccess, getuses, getusesbytype, getelements, getelementsbyaccess, builduseslist, getelementlist

Methods inherited from PhpdocAccessor

loadxmlfile

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

array

getClassdata()

Returns an array with the data of a class (no functions etc, just the class docs).
void

getInheritedFunctions()

Returns an array of inherited functions.
void

getInheritedVariables()

Returns an array of inherited variables.
void

getInheritedUses()

Returns an array of inherited included files.
void

getInheritedConstants()

Returns an array of inherited constants.
array

getClasstree()

Returns an array with the "path" of a class.
void

getSubclasses()

Returns an array with all subclasses of a class.

Private Method Summary

array

convertPath(array $xmlpath)

Converts a xml path array to a path that can be passed to the user.
void

buildInheritedlist()

Builds a list of inherited elements.
void

buildSubclasslist()

Builds a list of subclasses
void

init()

Reformats the xml result array from the PhpdocXMLReader.

Fields inherited from PhpdocAccessor

$xmlreader, $xml, $freeonget, $data

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

array

$inherited

Array of inherited elements
string

$xmlkey

Kind of top-level container in the xml document.

Public Method Details

getClassdata

public array getClassdata( )

  Returns an array with the data of a class (no functions etc, just the class docs).

Returns array $class


getInheritedFunctions

public void getInheritedFunctions( )

  Returns an array of inherited functions.

Returns void

See Also getInheritedVariables(), getInheritedUses(), getInheritedConstants()

getInheritedVariables

public void getInheritedVariables( )

  Returns an array of inherited variables.

Returns void

See Also getInheritedFunctions(), getInheritedUses(), getInheritedConstants()

getInheritedUses

public void getInheritedUses( )

  Returns an array of inherited included files.

Returns void

See Also getInheritedFunctions(), getInheritedUses(), getInheritedConstants()

getInheritedConstants

public void getInheritedConstants( )

  Returns an array of inherited constants.

Returns void

See Also getInheritedFunctions(), getInheritedVariables(), getInheritedUses()

getClasstree

public array getClasstree( )

  Returns an array with the "path" of a class.

Returns array $path

See Also getSubclasses()

getSubclasses

public void getSubclasses( )

  Returns an array with all subclasses of a class.

Returns void

See Also getClasstree()

Private Method Details

convertPath

private array convertPath( array $xmlpath )

  Converts a xml path array to a path that can be passed to the user.

The path is an array like path[0..n] = classname where path[0] is the
directs parent (extends path[0]) and path[n] is the baseclass.

Parameter
array $xmlpath
Returns array $path


buildInheritedlist

private void buildInheritedlist( )

  Builds a list of inherited elements.

Returns void

See Also $inherited

buildSubclasslist

private void buildSubclasslist( )

  Builds a list of subclasses

Returns void


init

private void init( )

  Reformats the xml result array from the PhpdocXMLReader.

Every derived class must override this function to call the functions
it needs to reorganize the data from the PhpdocXMLReader in a
way that it needs.

Returns void

See Also $xml, $data

Private Field Details

$inherited

private array $inherited

>>array()<<


$xmlkey

private string $xmlkey

>>"class"<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta