Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocModuleAccessor

PhpdocObject
   |
  +-- PhpdocAccessor
     |
    +-- PhpdocDocumentAccessor
       |
      +-- PhpdocModuleAccessor

Provides functions to access phpdoc xml documents that contain modules.

 

private class PhpdocModuleAccessor extends PhpdocDocumentAccessor

Provides functions to access phpdoc xml documents that contain modules.

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

 

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

getModuledata()

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

Private Method Summary

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

string

$xmlkey

Kind of top-level container in the xml document.

Public Method Details

getModuledata

public array getModuledata( )

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

Returns array $class


Private Method Details

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

$xmlkey

private string $xmlkey

>>"module"<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta