Packageindex Classtrees Modulegroups Elementlist Report XML Files

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

PhpdocAccessor

PhpdocObject
   |
  +-- PhpdocAccessor

Provides an API to access PHPDoc XML files.

It's up to you eigther to use this class to access
the phpdoc xml files or to write your own parser.

 

private class PhpdocAccessor extends PhpdocObject

Provides an API to access PHPDoc XML files.

It's up to you eigther to use this class to access
the phpdoc xml files or to write your own parser.

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

 
Direct known subclasses: PhpdocDocumentAccessor, PhpdocIndexAccessor, PhpdocWarningAccessor

Methods inherited from PhpdocObject

setflagoutput, out, nametourl, outl, introspection

Public Method Summary

boolean

loadXMLFile(string $filename)

Loads the specified xml file.

Private Method Summary

void

init()

Reformats the xml result array from the PhpdocXMLReader.

Fields inherited from PhpdocObject

$err, $flag_output, $application, $warn

Private Field Summary

unknown

$xmlreader

Instance of PhpdocXMLReader
array

$xml

Result of the PhpdocXMLReader
boolean

$freeOnGet

Free xml resources on calling a getXY() function?
array

$data

Reformatted PhpdocXMLReader result array

Public Method Details

loadXMLFile

public boolean loadXMLFile( string $filename )

  Loads the specified xml file.

Parameter
string $filename
Name of the xml file
Returns boolean

False if the given xml file was not
found or is empty otherwise true.

See Also init()

Private Method Details

init

private abstract 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

$xmlreader

private unknown $xmlreader

>>unknown<<


$xml

private array $xml

>>array()<<


$freeOnGet

private boolean $freeOnGet

>>true<<


$data

private array $data

>>array()<<



Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta