xml.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Blue Static ISSO Framework
   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         * @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         /**
  93         * Constructor
  94         */
  95         function __construct(&$registry)
  96         {
  97                 $this->registry =& $registry;
  98         }
  99
 100         // ###################################################################
 101         /**
 102         * (PHP 4) Constructor
 103         */
 104         function XML(&$registry)
 105         {
 106                 $this->__construct($registry);
 107         }
 108
 109         // ###################################################################
 110         /**
 111         * Parse an XML file
 112         *
 113         * @access       public
 114         *
 115         * @param        string  XML file data
 116         * @param        string  Parse file as UTF-8 instead of ISSO-8859-1
 117         *
 118         * @return       array   Array with all the XML data parsed
 119         */
 120         function parse($data, $utf8 = true)
 121         {
 122                 $this->stack = array();
 123                 $this->attribs = array();
 124                 $this->result = array();
 125                 $this->cdata = '';
 126
 127                 if ($utf8)
 128                 {
 129                         $this->parser = xml_parser_create('UTF-8');
 130                 }
 131                 else
 132                 {
 133                         $this->parser = xml_parser_create('ISO-8859-1');
 134                 }
 135
 136                 // create a new parser
 137                 xml_set_object($this->parser, $this);
 138                 xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, 0);
 139                 xml_set_element_handler($this->parser, 'handle_tag_start', 'handle_tag_end');
 140                 xml_set_character_data_handler($this->parser, 'handle_cdata');
 141
 142                 $this->attach_node($this->result);
 143
 144                 // parse the data and check for errors
 145                 if (!xml_parse($this->parser, $data))
 146                 {
 147                         $error['code'] = xml_get_error_code($this->parser);
 148                         $error['string'] = xml_error_string($error['code']);
 149                         $error['line'] = xml_get_current_line_number($this->parser);
 150                         $error['column'] = xml_get_current_column_number($this->parser);
 151                         trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR);
 152                         exit;
 153                 }
 154
 155                 // destroy the parser
 156                 xml_parser_free($this->parser);
 157
 158                 // done... send the results back
 159                 return $this->result;
 160         }
 161
 162         // ###################################################################
 163         /**
 164         * Process the opening location of an XML tag
 165         *
 166         * @access       private
 167         *
 168         * @param        integer XML parser
 169         * @param        string  Tag name
 170         * @param        array   Tag attributes
 171         */
 172         function handle_tag_start(&$parser, $name, $attrs)
 173         {
 174                 // we need to keep track of indicies to monitor the last key in $this->attribs
 175                 static $index;
 176
 177                 // trim attributes
 178                 array_walk($attrs, 'trim');
 179
 180                 // existing node set
 181                 if (isset($this->attribs["$name"]))
 182                 {
 183                         // node set has < 1 child nodes
 184                         if (!isset($this->attribs["$name"][0]))
 185                         {
 186                                 $tmp = $this->attribs["$name"];
 187                                 unset($this->attribs["$name"]);
 188                                 $this->attribs["$name"][0] = $tmp;
 189                         }
 190
 191                         // create a new child node
 192                         $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
 193                         $this->attach_node($this->attribs["$name"][ $index["$name"] ]);
 194                         $index["$name"]++;
 195                 }
 196                 // node set doesn't exist, so create it
 197                 else
 198                 {
 199                         $this->attribs["$name"] = (array)$attrs;
 200                         $this->attach_node($this->attribs["$name"]);
 201                         $index["$name"] = 1;
 202                 }
 203         }
 204
 205         // ###################################################################
 206         /**
 207         * Process XML CDATA
 208         *
 209         * @access       private
 210         *
 211         * @param        integer XML parser
 212         * @param        string  CDATA from tag
 213         */
 214         function handle_cdata(&$parser, $data)
 215         {
 216                 $this->cdata .= $data;
 217         }
 218
 219         // ###################################################################
 220         /**
 221         * Process the closing of an XML tag
 222         *
 223         * @access       private
 224         *
 225         * @param        integer XML parser
 226         * @param        string  Tag name
 227         */
 228         function handle_tag_end(&$parser, $name)
 229         {
 230                 // attach data to the node
 231                 if (($this->cdata = trim($this->cdata)) != '')
 232                 {
 233                         $this->attribs['value'] = $this->cdata;
 234                 }
 235
 236                 $this->cdata = '';
 237
 238                 // remove the node
 239                 $this->detach_node();
 240         }
 241
 242         // ###################################################################
 243         /**
 244         * Shifts the node tree
 245         *
 246         * @access       private
 247         *
 248         * @param        array   Node to place into the stack
 249         */
 250         function attach_node(&$node)
 251         {
 252                 // create a new node
 253                 $this->stack[ sizeof($this->stack) ] =& $node;
 254
 255                 // new attributes to work with
 256                 $this->attribs =& $node;
 257         }
 258
 259         // ###################################################################
 260         /**
 261         * Unshifts the node tree
 262         *
 263         * @access       private
 264         */
 265         function detach_node()
 266         {
 267                 // drop the newest node
 268                 unset($this->stack[ sizeof($this->stack) - 1 ]);
 269
 270                 // assign the attributes to the next newest node
 271                 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
 272         }
 273
 274         // ###################################################################
 275         /**
 276         * Unless a node has multiple children, there will not be a numerical
 277         * index for the child node. So this means that if you have variable
 278         * XML structure with some of the same types of nodes having one children
 279         * or multiple children, you'd have different things to parse. If
 280         * you want the node unified (as in, all single-children would be indexed
 281         * numerically, run this function on the node. It works on references.
 282         *
 283         * @access        public
 284         *
 285         * @param        array   The node to int-index
 286         */
 287         function unify_node(&$node)
 288         {
 289                 if (!isset($node[0]))
 290                 {
 291                         $node = array($node);
 292                 }
 293         }
 294 }
 295
 296 /*=====================================================================*\
 297 || ###################################################################
 298 || # $HeadURL$
 299 || # $Id$
 300 || ###################################################################
 301 \*=====================================================================*/
 302 ?>