]>
src.bluestatic.org Git - isso.git/blob - xml.php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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.
34 * @author Iris Studios, Inc.
35 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
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();
92 * Fields array that is used in this module
97 'taghandler' => array(REQ_NO
, null, false)
100 // ###################################################################
104 function __construct(&$registry)
106 $this->registry
=& $registry;
109 // ###################################################################
111 * (PHP 4) Constructor
113 function XML(&$registry)
115 $this->__construct($registry);
118 // ###################################################################
124 * @param string Field name
125 * @param mixed Value of the field
127 function set($name, $value)
129 $this->registry
->do_set($name, $value, 'xml');
132 // ###################################################################
138 * @param string XML file data
140 * @return array Array with all the XML data parsed
142 function parse($data)
144 $this->registry
->check_isso_fields(get_class($this));
146 $this->stack
= array();
147 $this->attribs
= array();
148 $this->result
= array();
151 // create a new parser
152 $this->parser
= xml_parser_create();
153 xml_set_object($this->parser
, $this);
154 xml_parser_set_option($this->parser
, XML_OPTION_CASE_FOLDING
, 0);
155 xml_set_element_handler($this->parser
, 'handle_tag_start', 'handle_tag_end');
156 xml_set_character_data_handler($this->parser
, 'handle_cdata');
158 $this->attach_node($this->result
);
160 // parse the data and check for errors
161 if (!xml_parse($this->parser
, $data))
163 $error['code'] = xml_get_error_code($this->parser
);
164 $error['string'] = xml_error_string($error['code']);
165 $error['line'] = xml_get_current_line_number($this->parser
);
166 $error['column'] = xml_get_current_column_number($this->parser
);
167 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR
);
171 // destroy the parser
172 xml_parser_free($this->parser
);
174 // done... send the results back
175 return $this->result
;
178 // ###################################################################
180 * Process the opening location of an XML tag
184 * @param integer XML parser
185 * @param string Tag name
186 * @param array Tag attributes
188 function handle_tag_start(&$parser, $name, $attrs)
191 array_walk($attrs, 'trim');
194 if (isset($this->attribs
["$name"]))
196 // node set has < 1 child nodes
197 if (!isset($this->attribs["$name"][0]))
199 $tmp = $this->attribs
["$name"];
200 unset($this->attribs["$name"]);
201 $this->attribs
["$name"][0] = $tmp;
204 // create a new child node
205 $this->attach_node($this->attribs["$name"][] = (array)$attrs);
207 // node set doesn't exist, so create it
210 $this->attach_node($this->attribs
["$name"] = (array)$attrs);
214 // ###################################################################
220 * @param integer XML parser
221 * @param string CDATA from tag
223 function handle_cdata(&$parser, $data)
225 $this->cdata .= $data;
228 // ###################################################################
230 * Process the closing of an XML tag
234 * @param integer XML parser
235 * @param string Tag name
237 function handle_tag_end(&$parser, $name)
239 // attach data to the node
240 if (($this->cdata = trim($this->cdata)) != '')
242 // if we have a data handler, operate it now
243 if (isset($this->taghandler["$name"]))
245 $this->registry
->debug("handler: " . $this->taghandler
["$name"]);
246 if (function_exists($this->taghandler["$name"]))
248 $this->cdata
= $this->taghandler
["$name"]($this->cdata, $this);
252 trigger_error('Could not find the function [' . $this->taghandler["$name"] . '()] for the XML tag "' . $name . '"', E_USER_ERROR
);
256 $this->attribs
['value'] = $this->cdata
;
262 $this->detach_node();
265 // ###################################################################
267 * Shifts the node tree
271 * @param array Node to place into the stack
273 function attach_node(&$node)
276 $this->stack
[ count($this->stack
) ] =& $node;
278 // new attributes to work with
279 $this->attribs
=& $node;
282 // ###################################################################
284 * Unshifts the node tree
288 function detach_node()
290 // drop the newest node
291 unset($this->stack
[ count($this->stack
) - 1 ]);
293 // assign the attributes to the next newest node
294 $this->attribs
=& $this->stack
[ count($this->stack
) - 1 ];
298 /*=====================================================================*\
299 || ###################################################################
302 || ###################################################################
303 \*=====================================================================*/