]>
src.bluestatic.org Git - isso.git/blob - Xml.php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright ©2002-[#]year[#] Blue Static
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.
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
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 \*=====================================================================*/
23 * Static XML parser (Xml.php)
31 * A simple XML parser that is run by calling BSXml::Parse( String xmlData) and an
32 * array is returned with the parsed information.
35 * @copyright Copyright ©2002 - [#]year[#], Blue Static
46 private $parser = null;
49 * An array of function names that are to be executed for each tag name (name => function)
52 private $taghandler = array();
61 * Tag stack of all open nodes
64 private $stack = array();
67 * Node list for all open tag attributes
70 private $attribs = array();
73 * Resulting parsed array
76 private $result = array();
78 // ###################################################################
82 private function __construct() {}
84 // ###################################################################
88 * @param string XML file data
89 * @param bool Parse file as UTF-8 instead of ISSO-8859-1?
91 * @return array Array with all the XML data parsed
93 public static function Parse($data, $utf8 = false)
95 $parser = new BSXml();
99 $parser->parser
= xml_parser_create('UTF-8');
103 $parser->parser
= xml_parser_create('ISO-8859-1');
106 // create a new parser
107 xml_set_object($parser->parser
, $parser);
108 xml_parser_set_option($parser->parser
, XML_OPTION_CASE_FOLDING
, 0);
109 xml_set_element_handler($parser->parser
, '_handleStartTag', '_handleEndTag');
110 xml_set_character_data_handler($parser->parser
, '_handleCData');
112 $parser->_attachNode($parser->result
);
114 // parse the data and check for errors
115 if (!xml_parse($parser->parser
, $data))
117 $error['code'] = xml_get_error_code($parser->parser
);
118 $error['string'] = xml_error_string($error['code']);
119 $error['line'] = xml_get_current_line_number($parser->parser
);
120 $error['column'] = xml_get_current_column_number($parser->parser
);
121 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]");
124 // destroy the parser
125 xml_parser_free($parser->parser
);
127 // done... send the results back
128 return $parser->result
;
131 // ###################################################################
133 * Process the opening location of an XML tag
135 * @param integer XML parser
136 * @param string Tag name
137 * @param array Tag attributes
139 private function _handleStartTag(&$parser, $name, $attrs)
141 // we need to keep track of indicies to monitor the last key in $this->attribs
145 array_walk($attrs, 'trim');
148 if (isset($this->attribs
["$name"]))
150 // node set has < 1 child nodes
151 if (!isset($this->attribs["$name"][0]))
153 $tmp = $this->attribs
["$name"];
154 unset($this->attribs["$name"]);
155 $this->attribs
["$name"][0] = $tmp;
158 // create a new child node
159 $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
160 $this->_attachNode($this->attribs["$name"][ $index["$name"] ]);
163 // node set doesn't exist, so create it
166 $this->attribs
["$name"] = (array)$attrs;
167 $this->_attachNode($this->attribs["$name"]);
172 // ###################################################################
176 * @param integer XML parser
177 * @param string CDATA from tag
179 private function _handleCData(&$parser, $data)
181 $this->cdata .= $data;
184 // ###################################################################
186 * Process the closing of an XML tag
188 * @param integer XML parser
189 * @param string Tag name
191 private function _handleEndTag(&$parser, $name)
193 // attach data to the node
194 if (($this->cdata = trim($this->cdata)) != '')
196 $this->attribs['value'] = $this->cdata;
202 $this->_detachNode();
205 // ###################################################################
207 * Shifts the node tree
209 * @param array Node to place into the stack
211 private function _attachNode(&$node)
214 $this->stack[ sizeof($this->stack) ] =& $node;
216 // new attributes to work with
217 $this->attribs =& $node;
220 // ###################################################################
222 * Unshifts the node tree
224 private function _detachNode()
226 // drop the newest node
227 unset($this->stack[ sizeof($this->stack) - 1 ]);
229 // assign the attributes to the next newest node
230 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
233 // ###################################################################
235 * Unless a node has multiple children, there will not be a numerical
236 * index for the child node. So this means that if you have variable
237 * XML structure with some of the same types of nodes having one children
238 * or multiple children, you'd have different things to parse. If
239 * you want the node unified (as in, all single-children would be indexed
240 * numerically, run this function on the node. It works on references.
242 * @param array The node to int-index
244 public static function UnifyNode(&$node)
246 if (!isset($node[0]))
248 $node = array($node);
253 /*=====================================================================*\
254 || ###################################################################
257 || ###################################################################
258 \*=====================================================================*/