xml.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework [#]issoversion[#]
   5 || # Copyright ©2002-[#]year[#] Blue Static
   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               Blue Static
  35 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  36 * @version              $Revision$
  37 * @package              ISSO
  38 *
  39 */
  40 class XML
  41 {
  42         /**
  43         * Framework registry object
  44         * @var  object
  45         */
  46         private $registry = null;
  47
  48         /**
  49         * Parser resource
  50         * @var  integer
  51         */
  52         private $parser = null;
  53
  54         /**
  55         * An array of function names that are to be executed for each tag name (name => function)
  56         * @var  array()
  57         */
  58         private $taghandler = array();
  59
  60         /**
  61         * Current CDATA value
  62         * @var  string
  63         */
  64         private $cdata = '';
  65
  66         /**
  67         * Tag stack of all open nodes
  68         * @var  array
  69         */
  70         private $stack = array();
  71
  72         /**
  73         * Node list for all open tag attributes
  74         * @var  array
  75         */
  76         private $attribs = array();
  77
  78         /**
  79         * Resulting parsed array
  80         * @var  array
  81         */
  82         private $result = array();
  83
  84         /**
  85         * Fields array that is used in this module
  86         * @var  array
  87         */
  88         private $fields = array(
  89                 'taghandler'    => array(REQ_NO,        null,   false)
  90         );
  91
  92         // ###################################################################
  93         /**
  94         * Constructor
  95         */
  96         function __construct(&$registry)
  97         {
  98                 $this->registry =& $registry;
  99         }
 100
 101         // ###################################################################
 102         /**
 103         * Sets an ISSO field
 104         *
 105         * @access       public
 106         *
 107         * @param        string  Field name
 108         * @param        mixed   Value of the field
 109         */
 110         function set($name, $value)
 111         {
 112                 $this->registry->do_set($name, $value, 'xml');
 113         }
 114
 115         // ###################################################################
 116         /**
 117         * Gets an ISSO field
 118         *
 119         * @access       public
 120         *
 121         * @param        string  Field name
 122         *
 123         * @return       mixed   Value of the field
 124         */
 125         function get($fieldname)
 126         {
 127                 return $this->registry->do_get($fieldname, 'xml');
 128         }
 129
 130         // ###################################################################
 131         /**
 132         * Parse an XML file
 133         *
 134         * @access       public
 135         *
 136         * @param        string  XML file data
 137         * @param        string  Parse file as UTF-8 instead of ISSO-8859-1
 138         *
 139         * @return       array   Array with all the XML data parsed
 140         */
 141         function parse($data, $utf8 = false)
 142         {
 143                 $this->registry->check_isso_fields(get_class($this));
 144
 145                 $this->stack = array();
 146                 $this->attribs = array();
 147                 $this->result = array();
 148                 $this->cdata = '';
 149
 150                 if ($utf8)
 151                 {
 152                         $data = utf8_encode($data);
 153                         $this->parser = xml_parser_create('UTF-8');
 154                 }
 155                 else
 156                 {
 157                         $this->parser = xml_parser_create('ISO-8859-1');
 158                 }
 159
 160                 // create a new parser
 161                 xml_set_object($this->parser, $this);
 162                 xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
 163                 xml_set_element_handler($this->parser, 'handle_tag_start', 'handle_tag_end');
 164                 xml_set_character_data_handler($this->parser, 'handle_cdata');
 165
 166                 $this->attach_node($this->result);
 167
 168                 // parse the data and check for errors
 169                 if (!xml_parse($this->parser, $data))
 170                 {
 171                         $error['code'] = xml_get_error_code($this->parser);
 172                         $error['string'] = xml_error_string($error['code']);
 173                         $error['line'] = xml_get_current_line_number($this->parser);
 174                         $error['column'] = xml_get_current_column_number($this->parser);
 175                         trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR);
 176                         exit;
 177                 }
 178
 179                 // destroy the parser
 180                 xml_parser_free($this->parser);
 181
 182                 // done... send the results back
 183                 return $this->result;
 184         }
 185
 186         // ###################################################################
 187         /**
 188         * Process the opening location of an XML tag
 189         *
 190         * @access       private
 191         *
 192         * @param        integer XML parser
 193         * @param        string  Tag name
 194         * @param        array   Tag attributes
 195         */
 196         function handle_tag_start(&$parser, $name, $attrs)
 197         {
 198                 // we need to keep track of indicies to monitor the last key in $this->attribs
 199                 static $index;
 200
 201                 // trim attributes
 202                 array_walk($attrs, 'trim');
 203
 204                 // existing node set
 205                 if (isset($this->attribs["$name"]))
 206                 {
 207                         // node set has < 1 child nodes
 208                         if (!isset($this->attribs["$name"][0]))
 209                         {
 210                                 $tmp = $this->attribs["$name"];
 211                                 unset($this->attribs["$name"]);
 212                                 $this->attribs["$name"][0] = $tmp;
 213                         }
 214
 215                         // create a new child node
 216                         $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
 217                         $this->attach_node($this->attribs["$name"][ $index["$name"] ]);
 218                         $index["$name"]++;
 219                 }
 220                 // node set doesn't exist, so create it
 221                 else
 222                 {
 223                         $this->attribs["$name"] = (array)$attrs;
 224                         $this->attach_node($this->attribs["$name"]);
 225                         $index["$name"] = 1;
 226                 }
 227         }
 228
 229         // ###################################################################
 230         /**
 231         * Process XML CDATA
 232         *
 233         * @access       private
 234         *
 235         * @param        integer XML parser
 236         * @param        string  CDATA from tag
 237         */
 238         function handle_cdata(&$parser, $data)
 239         {
 240                 $this->cdata .= $data;
 241         }
 242
 243         // ###################################################################
 244         /**
 245         * Process the closing of an XML tag
 246         *
 247         * @access       private
 248         *
 249         * @param        integer XML parser
 250         * @param        string  Tag name
 251         */
 252         function handle_tag_end(&$parser, $name)
 253         {
 254                 // attach data to the node
 255                 if (($this->cdata = trim($this->cdata)) != '')
 256                 {
 257                         // if we have a data handler, operate it now
 258                         if (isset($this->taghandler["$name"]))
 259                         {
 260                                 $this->registry->debug("handler: " . $this->taghandler["$name"]);
 261                                 if (function_exists($this->taghandler["$name"]))
 262                                 {
 263                                         $this->cdata = $this->taghandler["$name"]($this->cdata, $this);
 264                                 }
 265                                 else
 266                                 {
 267                                         trigger_error('Could not find the function [' . $this->taghandler["$name"] . '()] for the XML tag "' . $name . '"', E_USER_ERROR);
 268                                 }
 269                         }
 270
 271                         $this->attribs['value'] = $this->cdata;
 272                 }
 273
 274                 $this->cdata = '';
 275
 276                 // remove the node
 277                 $this->detach_node();
 278         }
 279
 280         // ###################################################################
 281         /**
 282         * Shifts the node tree
 283         *
 284         * @access       private
 285         *
 286         * @param        array   Node to place into the stack
 287         */
 288         function attach_node(&$node)
 289         {
 290                 // create a new node
 291                 $this->stack[ sizeof($this->stack) ] =& $node;
 292
 293                 // new attributes to work with
 294                 $this->attribs =& $node;
 295         }
 296
 297         // ###################################################################
 298         /**
 299         * Unshifts the node tree
 300         *
 301         * @access       private
 302         */
 303         function detach_node()
 304         {
 305                 // drop the newest node
 306                 unset($this->stack[ sizeof($this->stack) - 1 ]);
 307
 308                 // assign the attributes to the next newest node
 309                 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
 310         }
 311
 312         // ###################################################################
 313         /**
 314         * Unless a node has multiple children, there will not be a numerical
 315         * index for the child node. So this means that if you have variable
 316         * XML structure with some of the same types of nodes having one children
 317         * or multiple children, you'd have different things to parse. If
 318         * you want the node unified (as in, all single-children would be indexed
 319         * numerically, run this function on the node. It works on references.
 320         *
 321         * @access        public
 322         *
 323         * @param        array   The node to int-index
 324         */
 325         function unify_node(&$node)
 326         {
 327                 if (!isset($node[0]))
 328                 {
 329                         $node = array($node);
 330                 }
 331         }
 332 }
 333
 334 /*=====================================================================*\
 335 || ###################################################################
 336 || # $HeadURL$
 337 || # $Id$
 338 || ###################################################################
 339 \*=====================================================================*/
 340 ?>