classes/xml/XMLParser.inc.php

<?php

// $Id: XMLParser.inc.php,v 1.15 2008/07/01 01:16:11 asmecher Exp $


// The default character encodings
define('XML_PARSER_SOURCE_ENCODING', Config::getVar('i18n', 'client_charset'));
define('XML_PARSER_TARGET_ENCODING', Config::getVar('i18n', 'client_charset'));

import('xml.XMLParserDOMHandler');

class XMLParser {

   var $magicQuotes;

   var $handler;

   function XMLParser() {
      // magic_quotes_runtime must be disabled for XML parsing
      $this->magicQuotes = get_magic_quotes_runtime();
      set_magic_quotes_runtime(0);
   }

   function &parse($file) {
      $parser = &$this->createParser();

      if (!isset($this->handler)) {
         // Use default handler for parsing
         $handler =& new XMLParserDOMHandler();
         $this->setHandler($handler);
      }

      xml_set_object($parser, $this->handler);
      xml_set_element_handler($parser, "startElement", "endElement");
      xml_set_character_data_handler($parser, "characterData");

      import('file.FileWrapper');
      $wrapper = &FileWrapper::wrapper($file);

      while (is_object($newWrapper = $wrapper->open())) if (is_object($newWrapper)) { // Handle redirects
         unset($wrapper);
         $wrapper =& $newWrapper;
         unset ($newWrapper);
      }

      if (!$wrapper) {
         $result = false;
         return $result;
      }

      while ($data = $wrapper->read()) {
         if (!xml_parse($parser, $data, $wrapper->eof())) {
            echo xml_error_string(xml_get_error_code($parser));
            $this->destroyParser($parser);
            $result = false;
            $wrapper->close();
            return $result;
         }
      }

      $wrapper->close();
      $this->destroyParser($parser);

      $result = &$this->handler->getResult();
      return $result;
   }

   function setHandler(&$handler) {
      $this->handler =& $handler;
   }

   function &parseStruct($file, $tagsToMatch = array()) {
      $parser = &$this->createParser();
      import('file.FileWrapper');
      $wrapper = &FileWrapper::wrapper($file);
      $fileContents = $wrapper->contents();
      if (!$fileContents) {
         $result = false;
         return $result;
      }
      xml_parse_into_struct($parser, $fileContents, $values, $tags);
      $this->destroyParser($parser);

      // Clean up data struct, removing undesired tags if necessary
      foreach ($tags as $key => $indices) {
         if (!empty($tagsToMatch) && !in_array($key, $tagsToMatch)) {
            continue;
         }

         $data[$key] = array();

         foreach ($indices as $index) {
            if (!isset($values[$index]['type']) || ($values[$index]['type'] != 'open' && $values[$index]['type'] != 'complete')) {
               continue;
            }

            $data[$key][] = array(
               'attributes' => isset($values[$index]['attributes']) ? $values[$index]['attributes'] : array(),
               'value' => isset($values[$index]['value']) ? trim($values[$index]['value']) : ''
            );
         }
      }

      return $data;
   }

   function &createParser() {
      $parser = xml_parser_create(XML_PARSER_SOURCE_ENCODING);
      xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, XML_PARSER_TARGET_ENCODING);
      xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, false);
      return $parser;
   }

   function destroyParser(&$parser) {
      xml_parser_free($parser);
      unset($parser);
   }

   function destroy() {
      // Set magic_quotes_runtime back to original setting
      set_magic_quotes_runtime($this->magicQuotes);
      unset($this);
   }

}

class XMLParserHandler {

   function startElement(&$parser, $tag, $attributes) {
   }

   function endElement(&$parser, $tag) {
   }

   function characterData(&$parser, $data) {
   }

   function &getResult() {
      // Default: Return null (must be by ref).
      $nullVar = null;
      return $nullVar;
   }

}

?>

---