PhpdocAccessor

PhpdocObject
|
+-- PhpdocAccessor

Provides an API to access PHPDoc XML files.

Provides an API to access PHPDoc XML files.
It's up to you eigther to use this class to accessthe phpdoc xml files or to write your own parser.

Authors Ulf Wendel <ulf.wendel@phpdoc.de>

Version $Id: $

Direct known subclasses: PhpdocDocumentAccessor, PhpdocIndexAccessor, PhpdocWarningAccessor

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.

Private Field Summary
object PhpdocXMLReader	$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

public boolean loadXMLFile( string $filename )

Loads the specified xml file.

Parameter

string	$filename
	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 functionsit needs to reorganize the data from the PhpdocXMLReader in away that it needs.
Returns	void
See Also	$xml, $data

Private Field Details
$xmlreader
private object PhpdocXMLReader $xmlreader >><< Instance of PhpdocXMLReader

$xml
private array $xml >>`array()`<< Result of the PhpdocXMLReader

$freeOnGet
private boolean $freeOnGet >>`true`<< Free xml resources on calling a getXY() function? One of the design goals was to minimize the memory consumption of PHPdoc.So PHPdoc tries to save data as soon as possible to the disk, reuse objectsand free resources of an object when they are no longer needed. The defaultvalue of true will cause the object to free the memory used by thexml data as soon as possible.

$data
private array $data >>`array()`<< Reformatted PhpdocXMLReader result array