2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework [#]issoversion[#]
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 \*=====================================================================*/
32 * This framework is a wrapper for a robust XML parser.
35 * @copyright Copyright ©2002 - [#]year[#], Blue Static
43 * Framework registry object
57 * An array of function names that are to be executed for each tag name (name => function)
61 var $taghandler = array();
71 * Tag stack of all open nodes
78 * Node list for all open tag attributes
82 var $attribs = array();
85 * Resulting parsed array
89 var $result = array();
91 // ###################################################################
95 function __construct(&$registry)
97 $this->registry
=& $registry;
100 // ###################################################################
102 * (PHP 4) Constructor
104 function XML(&$registry)
106 $this->__construct($registry);
109 // ###################################################################
115 * @param string XML file data
116 * @param string Parse file as UTF-8 instead of ISSO-8859-1
118 * @return array Array with all the XML data parsed
120 function parse($data, $utf8 = false
)
122 $this->registry
->check_isso_fields(get_class($this));
124 $this->stack
= array();
125 $this->attribs
= array();
126 $this->result
= array();
131 $data = utf8_encode($data);
132 $this->parser
= xml_parser_create('UTF-8');
136 $this->parser
= xml_parser_create('ISO-8859-1');
139 // create a new parser
140 xml_set_object($this->parser
, $this);
141 xml_parser_set_option($this->parser
, XML_OPTION_CASE_FOLDING
, 0);
142 xml_set_element_handler($this->parser
, 'handle_tag_start', 'handle_tag_end');
143 xml_set_character_data_handler($this->parser
, 'handle_cdata');
145 $this->attach_node($this->result
);
147 // parse the data and check for errors
148 if (!xml_parse($this->parser
, $data))
150 $error['code'] = xml_get_error_code($this->parser
);
151 $error['string'] = xml_error_string($error['code']);
152 $error['line'] = xml_get_current_line_number($this->parser
);
153 $error['column'] = xml_get_current_column_number($this->parser
);
154 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR
);
158 // destroy the parser
159 xml_parser_free($this->parser
);
161 // done... send the results back
162 return $this->result
;
165 // ###################################################################
167 * Process the opening location of an XML tag
171 * @param integer XML parser
172 * @param string Tag name
173 * @param array Tag attributes
175 function handle_tag_start(&$parser, $name, $attrs)
177 // we need to keep track of indicies to monitor the last key in $this->attribs
181 array_walk($attrs, 'trim');
184 if (isset($this->attribs
["$name"]))
186 // node set has < 1 child nodes
187 if (!isset($this->attribs
["$name"][0]))
189 $tmp = $this->attribs
["$name"];
190 unset($this->attribs
["$name"]);
191 $this->attribs
["$name"][0] = $tmp;
194 // create a new child node
195 $this->attribs
["$name"][ $index["$name"] ] = (array)$attrs;
196 $this->attach_node($this->attribs
["$name"][ $index["$name"] ]);
199 // node set doesn't exist, so create it
202 $this->attribs
["$name"] = (array)$attrs;
203 $this->attach_node($this->attribs
["$name"]);
208 // ###################################################################
214 * @param integer XML parser
215 * @param string CDATA from tag
217 function handle_cdata(&$parser, $data)
219 $this->cdata
.= $data;
222 // ###################################################################
224 * Process the closing of an XML tag
228 * @param integer XML parser
229 * @param string Tag name
231 function handle_tag_end(&$parser, $name)
233 // attach data to the node
234 if (($this->cdata
= trim($this->cdata
)) != '')
236 $this->attribs
['value'] = $this->cdata
;
242 $this->detach_node();
245 // ###################################################################
247 * Shifts the node tree
251 * @param array Node to place into the stack
253 function attach_node(&$node)
256 $this->stack
[ sizeof($this->stack
) ] =& $node;
258 // new attributes to work with
259 $this->attribs
=& $node;
262 // ###################################################################
264 * Unshifts the node tree
268 function detach_node()
270 // drop the newest node
271 unset($this->stack
[ sizeof($this->stack
) - 1 ]);
273 // assign the attributes to the next newest node
274 $this->attribs
=& $this->stack
[ sizeof($this->stack
) - 1 ];
277 // ###################################################################
279 * Unless a node has multiple children, there will not be a numerical
280 * index for the child node. So this means that if you have variable
281 * XML structure with some of the same types of nodes having one children
282 * or multiple children, you'd have different things to parse. If
283 * you want the node unified (as in, all single-children would be indexed
284 * numerically, run this function on the node. It works on references.
288 * @param array The node to int-index
290 function unify_node(&$node)
292 if (!isset($node[0]))
294 $node = array($node);
299 /*=====================================================================*\
300 || ###################################################################
303 || ###################################################################
304 \*=====================================================================*/