xml.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * XML Parser
  24 * xml.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 /**
  30 * XML Parser
  31 *
  32 * This framework is a wrapper for a robust XML parser.
  33 *
  34 * @author               Iris Studios, Inc.
  35 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  36 * @version              $Revision$
  37 * @package              ISSO
  38 *
  39 */
  40 class XML
  41 {
  42         /**
  43         * Framework registry object
  44         * @var  object
  45         * @access       private
  46         */
  47         var $registry = null;
  48
  49         /**
  50         * Parser resource
  51         * @var  integer
  52         * @access       private
  53         */
  54         var $parser = null;
  55
  56         /**
  57         * An array of function names that are to be executed for each tag name (name => function)
  58         * @var  array()
  59         * @access       private
  60         */
  61         var $taghandler = array();
  62
  63         /**
  64         * Current CDATA value
  65         * @var  string
  66         * @access       private
  67         */
  68         var $cdata = '';
  69
  70         /**
  71         * Tag stack of all open nodes
  72         * @var  array
  73         * @access       private
  74         */
  75         var $stack = array();
  76
  77         /**
  78         * Node list for all open tag attributes
  79         * @var  array
  80         * @access       private
  81         */
  82         var $attribs = array();
  83
  84         /**
  85         * Resulting parsed array
  86         * @var  array
  87         * @access       private
  88         */
  89         var $result = array();
  90
  91         /**
  92         * Fields array that is used in this module
  93         * @var  array
  94         * @access       private
  95         */
  96         var $fields = array(
  97                 'taghandler'    => array(REQ_NO,        null,   false)
  98         );
  99
 100         // ###################################################################
 101         /**
 102         * Constructor
 103         */
 104         function __construct(&$registry)
 105         {
 106                 $this->registry =& $registry;
 107         }
 108
 109         // ###################################################################
 110         /**
 111         * (PHP 4) Constructor
 112         */
 113         function XML(&$registry)
 114         {
 115                 $this->__construct($registry);
 116         }
 117
 118         // ###################################################################
 119         /**
 120         * Sets an ISSO field
 121         *
 122         * @access       public
 123         *
 124         * @param        string  Field name
 125         * @param        mixed   Value of the field
 126         */
 127         function set($name, $value)
 128         {
 129                 $this->registry->do_set($name, $value, 'xml');
 130         }
 131
 132         // ###################################################################
 133         /**
 134         * Parse an XML file
 135         *
 136         * @access       public
 137         *
 138         * @param        string  XML file data
 139         *
 140         * @return       array   Array with all the XML data parsed
 141         */
 142         function parse($data)
 143         {
 144                 $this->registry->check_isso_fields(get_class($this));
 145
 146                 $this->stack = array();
 147                 $this->attribs = array();
 148                 $this->result = array();
 149                 $this->cdata = '';
 150
 151                 // create a new parser
 152                 $this->parser = xml_parser_create();
 153                 xml_set_object($this->parser, $this);
 154                 xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
 155                 xml_set_element_handler($this->parser, 'handle_tag_start', 'handle_tag_end');
 156                 xml_set_character_data_handler($this->parser, 'handle_cdata');
 157
 158                 $this->attach_node($this->result);
 159
 160                 // parse the data and check for errors
 161                 if (!xml_parse($this->parser, $data))
 162                 {
 163                         $error['code'] = xml_get_error_code($this->parser);
 164                         $error['string'] = xml_error_string($error['code']);
 165                         $error['line'] = xml_get_current_line_number($this->parser);
 166                         $error['column'] = xml_get_current_column_number($this->parser);
 167                         trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR);
 168                         exit;
 169                 }
 170
 171                 // destroy the parser
 172                 xml_parser_free($this->parser);
 173
 174                 // done... send the results back
 175                 return $this->result;
 176         }
 177
 178         // ###################################################################
 179         /**
 180         * Process the opening location of an XML tag
 181         *
 182         * @access       private
 183         *
 184         * @param        integer XML parser
 185         * @param        string  Tag name
 186         * @param        array   Tag attributes
 187         */
 188         function handle_tag_start(&$parser, $name, $attrs)
 189         {
 190                 // trim attributes
 191                 array_walk($attrs, 'trim');
 192
 193                 // existing node set
 194                 if (isset($this->attribs["$name"]))
 195                 {
 196                         // node set has < 1 child nodes
 197                         if (!isset($this->attribs["$name"][0]))
 198                         {
 199                                 $tmp = $this->attribs["$name"];
 200                                 unset($this->attribs["$name"]);
 201                                 $this->attribs["$name"][0] = $tmp;
 202                         }
 203
 204                         // create a new child node
 205                         $this->attach_node($this->attribs["$name"][] = (array)$attrs);
 206                 }
 207                 // node set doesn't exist, so create it
 208                 else
 209                 {
 210                         $this->attach_node($this->attribs["$name"] = (array)$attrs);
 211                 }
 212         }
 213
 214         // ###################################################################
 215         /**
 216         * Process XML CDATA
 217         *
 218         * @access       private
 219         *
 220         * @param        integer XML parser
 221         * @param        string  CDATA from tag
 222         */
 223         function handle_cdata(&$parser, $data)
 224         {
 225                 $this->cdata .= $data;
 226         }
 227
 228         // ###################################################################
 229         /**
 230         * Process the closing of an XML tag
 231         *
 232         * @access       private
 233         *
 234         * @param        integer XML parser
 235         * @param        string  Tag name
 236         */
 237         function handle_tag_end(&$parser, $name)
 238         {
 239                 // attach data to the node
 240                 if (($this->cdata = trim($this->cdata)) != '')
 241                 {
 242                         // if we have a data handler, operate it now
 243                         if (isset($this->taghandler["$name"]))
 244                         {
 245                                 $this->registry->debug("handler: " . $this->taghandler["$name"]);
 246                                 if (function_exists($this->taghandler["$name"]))
 247                                 {
 248                                         $this->cdata = $this->taghandler["$name"]($this->cdata, $this);
 249                                 }
 250                                 else
 251                                 {
 252                                         trigger_error('Could not find the function [' . $this->taghandler["$name"] . '()] for the XML tag "' . $name . '"', E_USER_ERROR);
 253                                 }
 254                         }
 255
 256                         $this->attribs['value'] = $this->cdata;
 257                 }
 258
 259                 $this->cdata = '';
 260
 261                 // remove the node
 262                 $this->detach_node();
 263         }
 264
 265         // ###################################################################
 266         /**
 267         * Shifts the node tree
 268         *
 269         * @access       private
 270         *
 271         * @param        array   Node to place into the stack
 272         */
 273         function attach_node(&$node)
 274         {
 275                 // create a new node
 276                 $this->stack[ count($this->stack) ] =& $node;
 277
 278                 // new attributes to work with
 279                 $this->attribs =& $node;
 280         }
 281
 282         // ###################################################################
 283         /**
 284         * Unshifts the node tree
 285         *
 286         * @access       private
 287         */
 288         function detach_node()
 289         {
 290                 // drop the newest node
 291                 unset($this->stack[ count($this->stack) - 1 ]);
 292
 293                 // assign the attributes to the next newest node
 294                 $this->attribs =& $this->stack[ count($this->stack) - 1 ];
 295         }
 296 }
 297
 298 /*=====================================================================*\
 299 || ###################################################################
 300 || # $HeadURL$
 301 || # $Id$
 302 || ###################################################################
 303 \*=====================================================================*/
 304 ?>