home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Web Server / PHP.EXE / pear / PHPDoc / accessor / PhpdocAccessor.php next >
Encoding:
PHP Script  |  2001-02-18  |  2.2 KB  |  79 lines
  1. <?php
  2. /**
  3. * Provides an API to access PHPDoc XML files.
  4. * 
  5. * It's up to you eigther to use this class to access 
  6. * the phpdoc xml files or to write your own parser.
  7. *
  8. * @version  $Id: PhpdocAccessor.php,v 1.2 2001/02/18 15:03:05 uw Exp $
  9. */
  10. class PhpdocAccessor extends PhpdocObject {
  11.  
  12.     /**
  13.     * Instance of PhpdocXMLReader
  14.     * @var  object  PhpdocXMLReader $xmlreader
  15.     */    
  16.     var $xmlreader;
  17.     
  18.     /**
  19.     * Result of the PhpdocXMLReader
  20.     * @var    array    $xml
  21.     */
  22.     var $xml = array();
  23.     
  24.     /**
  25.     * Free xml resources on calling a getXY() function?
  26.     * 
  27.     * One of the design goals was to minimize the memory consumption of PHPdoc.
  28.     * So PHPdoc tries to save data as soon as possible to the disk, reuse objects
  29.     * and free resources of an object when they are no longer needed. The default 
  30.     * value of true will cause the object to free the memory used by the 
  31.     * xml data as soon as possible.
  32.     * 
  33.     * @var  boolean
  34.     */    
  35.     var $freeOnGet = true;
  36.  
  37.     /**
  38.     * Reformatted PhpdocXMLReader result array
  39.     * @var  array
  40.     */
  41.     var $data = array();
  42.     
  43.     /**
  44.     * Loads the specified xml file. 
  45.     *
  46.     * @param    string  Name of the xml file
  47.     * @return   boolean False if the given xml file was not 
  48.     *                   found or is empty otherwise true.
  49.     * @access   public
  50.     * @see      init()
  51.     */
  52.     function loadXMLFile($filename) {
  53.     
  54.         $this->xmlreader = new PhpdocXMLReader;
  55.         
  56.         $this->xml = $this->xmlreader->parse($filename);
  57.         $this->xml = $this->xml["phpdoc"];
  58.         $ok = (!is_array($this->xml) || 0 == count($this->xml)) ? false : true;
  59.         
  60.         $this->init();
  61.         
  62.         return $ok;        
  63.     } // end func loadXMLFile
  64.         
  65.     /**
  66.     * Reformats the xml result array from the PhpdocXMLReader.
  67.     * 
  68.     * Every derived class must override this function to call the functions
  69.     * it needs to reorganize the data from the PhpdocXMLReader in a 
  70.     * way that it needs. 
  71.     *
  72.     * @abstract
  73.     * @see    $xml, $data
  74.     */
  75.     function init() {
  76.     } // end func init
  77.  
  78. } // end class PhpdocAccessor
  79. ?>