xml.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]issoversion[#]
   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         * Gets an ISSO field
 135         *
 136         * @access       public
 137         *
 138         * @param        string  Field name
 139         *
 140         * @return       mixed   Value of the field
 141         */
 142         function get($fieldname)
 143         {
 144                 return $this->registry->do_get($fieldname, 'xml');
 145         }
 146
 147         // ###################################################################
 148         /**
 149         * Parse an XML file
 150         *
 151         * @access       public
 152         *
 153         * @param        string  XML file data
 154         * @param        string  Parse file as UTF-8 instead of ISSO-8859-1
 155         *
 156         * @return       array   Array with all the XML data parsed
 157         */
 158         function parse($data, $utf8 = false)
 159         {
 160                 $this->registry->check_isso_fields(get_class($this));
 161
 162                 $this->stack = array();
 163                 $this->attribs = array();
 164                 $this->result = array();
 165                 $this->cdata = '';
 166
 167                 if ($utf8)
 168                 {
 169                         $data = utf8_encode($data);
 170                         $this->parser = xml_parser_create('UTF-8');
 171                 }
 172                 else
 173                 {
 174                         $this->parser = xml_parser_create('ISO-8859-1');
 175                 }
 176
 177                 // create a new parser
 178                 xml_set_object($this->parser, $this);
 179                 xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
 180                 xml_set_element_handler($this->parser, 'handle_tag_start', 'handle_tag_end');
 181                 xml_set_character_data_handler($this->parser, 'handle_cdata');
 182
 183                 $this->attach_node($this->result);
 184
 185                 // parse the data and check for errors
 186                 if (!xml_parse($this->parser, $data))
 187                 {
 188                         $error['code'] = xml_get_error_code($this->parser);
 189                         $error['string'] = xml_error_string($error['code']);
 190                         $error['line'] = xml_get_current_line_number($this->parser);
 191                         $error['column'] = xml_get_current_column_number($this->parser);
 192                         trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR);
 193                         exit;
 194                 }
 195
 196                 // destroy the parser
 197                 xml_parser_free($this->parser);
 198
 199                 // done... send the results back
 200                 return $this->result;
 201         }
 202
 203         // ###################################################################
 204         /**
 205         * Process the opening location of an XML tag
 206         *
 207         * @access       private
 208         *
 209         * @param        integer XML parser
 210         * @param        string  Tag name
 211         * @param        array   Tag attributes
 212         */
 213         function handle_tag_start(&$parser, $name, $attrs)
 214         {
 215                 // we need to keep track of indicies to monitor the last key in $this->attribs
 216                 static $index;
 217
 218                 // trim attributes
 219                 array_walk($attrs, 'trim');
 220
 221                 // existing node set
 222                 if (isset($this->attribs["$name"]))
 223                 {
 224                         // node set has < 1 child nodes
 225                         if (!isset($this->attribs["$name"][0]))
 226                         {
 227                                 $tmp = $this->attribs["$name"];
 228                                 unset($this->attribs["$name"]);
 229                                 $this->attribs["$name"][0] = $tmp;
 230                         }
 231
 232                         // create a new child node
 233                         $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
 234                         $this->attach_node($this->attribs["$name"][ $index["$name"] ]);
 235                         $index["$name"]++;
 236                 }
 237                 // node set doesn't exist, so create it
 238                 else
 239                 {
 240                         $this->attribs["$name"] = (array)$attrs;
 241                         $this->attach_node($this->attribs["$name"]);
 242                         $index["$name"] = 1;
 243                 }
 244         }
 245
 246         // ###################################################################
 247         /**
 248         * Process XML CDATA
 249         *
 250         * @access       private
 251         *
 252         * @param        integer XML parser
 253         * @param        string  CDATA from tag
 254         */
 255         function handle_cdata(&$parser, $data)
 256         {
 257                 $this->cdata .= $data;
 258         }
 259
 260         // ###################################################################
 261         /**
 262         * Process the closing of an XML tag
 263         *
 264         * @access       private
 265         *
 266         * @param        integer XML parser
 267         * @param        string  Tag name
 268         */
 269         function handle_tag_end(&$parser, $name)
 270         {
 271                 // attach data to the node
 272                 if (($this->cdata = trim($this->cdata)) != '')
 273                 {
 274                         // if we have a data handler, operate it now
 275                         if (isset($this->taghandler["$name"]))
 276                         {
 277                                 $this->registry->debug("handler: " . $this->taghandler["$name"]);
 278                                 if (function_exists($this->taghandler["$name"]))
 279                                 {
 280                                         $this->cdata = $this->taghandler["$name"]($this->cdata, $this);
 281                                 }
 282                                 else
 283                                 {
 284                                         trigger_error('Could not find the function [' . $this->taghandler["$name"] . '()] for the XML tag "' . $name . '"', E_USER_ERROR);
 285                                 }
 286                         }
 287
 288                         $this->attribs['value'] = $this->cdata;
 289                 }
 290
 291                 $this->cdata = '';
 292
 293                 // remove the node
 294                 $this->detach_node();
 295         }
 296
 297         // ###################################################################
 298         /**
 299         * Shifts the node tree
 300         *
 301         * @access       private
 302         *
 303         * @param        array   Node to place into the stack
 304         */
 305         function attach_node(&$node)
 306         {
 307                 // create a new node
 308                 $this->stack[ sizeof($this->stack) ] =& $node;
 309
 310                 // new attributes to work with
 311                 $this->attribs =& $node;
 312         }
 313
 314         // ###################################################################
 315         /**
 316         * Unshifts the node tree
 317         *
 318         * @access       private
 319         */
 320         function detach_node()
 321         {
 322                 // drop the newest node
 323                 unset($this->stack[ sizeof($this->stack) - 1 ]);
 324
 325                 // assign the attributes to the next newest node
 326                 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
 327         }
 328
 329         // ###################################################################
 330         /**
 331         * Unless a node has multiple children, there will not be a numerical
 332         * index for the child node. So this means that if you have variable
 333         * XML structure with some of the same types of nodes having one children
 334         * or multiple children, you'd have different things to parse. If
 335         * you want the node unified (as in, all single-children would be indexed
 336         * numerically, run this function on the node. It works on references.
 337         *
 338         * @access        public
 339         *
 340         * @param        array   The node to int-index
 341         */
 342         function unify_node(&$node)
 343         {
 344                 if (!isset($node[0]))
 345                 {
 346                         $node = array($node);
 347                 }
 348         }
 349 }
 350
 351 /*=====================================================================*\
 352 || ###################################################################
 353 || # $HeadURL$
 354 || # $Id$
 355 || ###################################################################
 356 \*=====================================================================*/
 357 ?>