Packageindex Classtrees Modulegroups Elementlist Report XML Files
File: c:/www/apache/doc2//accessor/PhpdocClassAccessor.php
PHPDOC 2000/12/03 - 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).
array

getInheritedFunctions()

Returns an array of inherited functions.
array

getInheritedVariables()

Returns an array of inherited variables.
array

getInheritedUses()

Returns an array of inherited included files.
array

getInheritedConstants()

Returns an array of inherited constants.
array

getClasstree()

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

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.Warning: documentation is missing.

Fields inherited from PhpdocAccessor
$xmlreader, $xml, $freeonget, $data

Fields inherited from PhpdocObject
$err, $application, $warn, $flag_output

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 array getInheritedFunctions( )
  Returns an array of inherited functions.

Returns array

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

getInheritedVariables

public array getInheritedVariables( )
  Returns an array of inherited variables.

Returns array

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

getInheritedUses

public array getInheritedUses( )
  Returns an array of inherited included files.

Returns array

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

getInheritedConstants

public array getInheritedConstants( )
  Returns an array of inherited constants.

Returns array

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 array getSubclasses( )
  Returns an array with all subclasses of a class.

Returns array

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 thedirects 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 functionsit needs to reorganize the data from the PhpdocXMLReader in away that it needs.

Warning: documentation is missing.

Returns void

See Also $xml, $data

Private Field Details

$inherited

private array $inherited

>>array()<<

Array of inherited elements

$xmlkey

private string $xmlkey

>>"class"<<

Kind of top-level container in the xml document.
Must be set by all derived classes.

Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta