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 * Static XML parser (Xml.php)
  24 *
  25 * @package      ISSO
  26 */
  27
  28 /**
  29 * XML Parser
  30 *
  31 * A simple XML parser that is run by calling BSXml::Parse( String xmlData) and an
  32 * array is returned with the parsed information.
  33 *
  34 * @author               Blue Static
  35 * @copyright    Copyright ©2002 - [#]year[#], Blue Static
  36 * @version              $Revision$
  37 * @package              ISSO
  38 *
  39 */
  40 class BSXml
  41 {
  42         /**
  43         * Parser resource
  44         * @var  integer
  45         */
  46         private $parser = null;
  47
  48         /**
  49         * An array of function names that are to be executed for each tag name (name => function)
  50         * @var  array()
  51         */
  52         private $taghandler = array();
  53
  54         /**
  55         * Current CDATA value
  56         * @var  string
  57         */
  58         private $cdata = '';
  59
  60         /**
  61         * Tag stack of all open nodes
  62         * @var  array
  63         */
  64         private $stack = array();
  65
  66         /**
  67         * Node list for all open tag attributes
  68         * @var  array
  69         */
  70         private $attribs = array();
  71
  72         /**
  73         * Resulting parsed array
  74         * @var  array
  75         */
  76         private $result = array();
  77
  78         // ###################################################################
  79         /**
  80         * Constructor
  81         */
  82         private function __construct() {}
  83
  84         // ###################################################################
  85         /**
  86         * Parse an XML file
  87         *
  88         * @param        string  XML file data
  89         * @param        string  Parse file as UTF-8 instead of ISSO-8859-1
  90         *
  91         * @return       array   Array with all the XML data parsed
  92         */
  93         public static function Parse($data, $utf8 = false)
  94         {
  95                 $parser = new BSXml();
  96
  97                 if ($utf8)
  98                 {
  99                         $data = utf8_encode($data);
 100                         $parser->parser = xml_parser_create('UTF-8');
 101                 }
 102                 else
 103                 {
 104                         $parser->parser = xml_parser_create('ISO-8859-1');
 105                 }
 106
 107                 // create a new parser
 108                 xml_set_object($parser->parser, $parser);
 109                 xml_parser_set_option($parser->parser, XML_OPTION_CASE_FOLDING, 0);
 110                 xml_set_element_handler($parser->parser, '_handleStartTag', '_handleEndTag');
 111                 xml_set_character_data_handler($parser->parser, '_handleCData');
 112
 113                 $parser->_attachNode($parser->result);
 114
 115                 // parse the data and check for errors
 116                 if (!xml_parse($parser->parser, $data))
 117                 {
 118                         $error['code'] = xml_get_error_code($parser->parser);
 119                         $error['string'] = xml_error_string($error['code']);
 120                         $error['line'] = xml_get_current_line_number($parser->parser);
 121                         $error['column'] = xml_get_current_column_number($parser->parser);
 122                         trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]");
 123                         exit;
 124                 }
 125
 126                 // destroy the parser
 127                 xml_parser_free($parser->parser);
 128
 129                 // done... send the results back
 130                 return $parser->result;
 131         }
 132
 133         // ###################################################################
 134         /**
 135         * Process the opening location of an XML tag
 136         *
 137         * @param        integer XML parser
 138         * @param        string  Tag name
 139         * @param        array   Tag attributes
 140         */
 141         private function _handleStartTag(&$parser, $name, $attrs)
 142         {
 143                 // we need to keep track of indicies to monitor the last key in $this->attribs
 144                 static $index;
 145
 146                 // trim attributes
 147                 array_walk($attrs, 'trim');
 148
 149                 // existing node set
 150                 if (isset($this->attribs["$name"]))
 151                 {
 152                         // node set has < 1 child nodes
 153                         if (!isset($this->attribs["$name"][0]))
 154                         {
 155                                 $tmp = $this->attribs["$name"];
 156                                 unset($this->attribs["$name"]);
 157                                 $this->attribs["$name"][0] = $tmp;
 158                         }
 159
 160                         // create a new child node
 161                         $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
 162                         $this->_attachNode($this->attribs["$name"][ $index["$name"] ]);
 163                         $index["$name"]++;
 164                 }
 165                 // node set doesn't exist, so create it
 166                 else
 167                 {
 168                         $this->attribs["$name"] = (array)$attrs;
 169                         $this->_attachNode($this->attribs["$name"]);
 170                         $index["$name"] = 1;
 171                 }
 172         }
 173
 174         // ###################################################################
 175         /**
 176         * Process XML CDATA
 177         *
 178         * @param        integer XML parser
 179         * @param        string  CDATA from tag
 180         */
 181         private function _handleCData(&$parser, $data)
 182         {
 183                 $this->cdata .= $data;
 184         }
 185
 186         // ###################################################################
 187         /**
 188         * Process the closing of an XML tag
 189         *
 190         * @param        integer XML parser
 191         * @param        string  Tag name
 192         */
 193         private function _handleEndTag(&$parser, $name)
 194         {
 195                 // attach data to the node
 196                 if (($this->cdata = trim($this->cdata)) != '')
 197                 {
 198                         $this->attribs['value'] = $this->cdata;
 199                 }
 200
 201                 $this->cdata = '';
 202
 203                 // remove the node
 204                 $this->_detachNode();
 205         }
 206
 207         // ###################################################################
 208         /**
 209         * Shifts the node tree
 210         *
 211         * @param        array   Node to place into the stack
 212         */
 213         private function _attachNode(&$node)
 214         {
 215                 // create a new node
 216                 $this->stack[ sizeof($this->stack) ] =& $node;
 217
 218                 // new attributes to work with
 219                 $this->attribs =& $node;
 220         }
 221
 222         // ###################################################################
 223         /**
 224         * Unshifts the node tree
 225         */
 226         private function _detachNode()
 227         {
 228                 // drop the newest node
 229                 unset($this->stack[ sizeof($this->stack) - 1 ]);
 230
 231                 // assign the attributes to the next newest node
 232                 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
 233         }
 234
 235         // ###################################################################
 236         /**
 237         * Unless a node has multiple children, there will not be a numerical
 238         * index for the child node. So this means that if you have variable
 239         * XML structure with some of the same types of nodes having one children
 240         * or multiple children, you'd have different things to parse. If
 241         * you want the node unified (as in, all single-children would be indexed
 242         * numerically, run this function on the node. It works on references.
 243         *
 244         * @param        array   The node to int-index
 245         */
 246         public static function UnifyNode(&$node)
 247         {
 248                 if (!isset($node[0]))
 249                 {
 250                         $node = array($node);
 251                 }
 252         }
 253 }
 254
 255 /*=====================================================================*\
 256 || ###################################################################
 257 || # $HeadURL$
 258 || # $Id$
 259 || ###################################################################
 260 \*=====================================================================*/
 261 ?>