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
55 * An array of function names that are to be executed for each tag name (name => function)
58 var $taghandler = array();
67 * Tag stack of all open nodes
73 * Node list for all open tag attributes
76 var $attribs = array();
79 * Resulting parsed array
82 var $result = array();
87 function __construct(&$registry)
89 $this->registry
=& $registry;
95 function XML(&$registry)
97 $this->__construct($registry);
103 * @param string XML file data
105 * @return array Array with all the XML data parsed
107 function parse($data)
109 $this->stack
= array();
110 $this->attribs
= array();
111 $this->result
= array();
114 // create a new parser
115 $this->parser
= xml_parser_create();
116 xml_set_object($this->parser
, $this);
117 xml_parser_set_option($this->parser
, XML_OPTION_CASE_FOLDING
, 0);
118 xml_set_element_handler($this->parser
, 'handle_tag_start', 'handle_tag_end');
119 xml_set_character_data_handler($this->parser
, 'handle_cdata');
121 $this->attach_node($this->result
);
123 // parse the data and check for errors
124 if (!xml_parse($this->parser
, $data))
126 $error['code'] = xml_get_error_code($this->parser
);
127 $error['string'] = xml_error_string($error['code']);
128 $error['line'] = xml_get_current_line_number($this->parser
);
129 $error['column'] = xml_get_current_column_number($this->parser
);
130 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR
);
134 // destroy the parser
135 xml_parser_free($this->parser
);
137 // done... send the results back
138 return $this->result
;
142 * Process the opening location of an XML tag
144 * @param integer XML parser
145 * @param string Tag name
146 * @param array Tag attributes
148 function handle_tag_start(&$parser, $name, $attrs)
151 array_walk($attrs, 'trim');
154 if (isset($this->attribs
["$name"]))
156 // node set has < 1 child nodes
157 if (!isset($this->attribs
["$name"][0]))
159 $tmp = $this->attribs
["$name"];
160 unset($this->attribs
["$name"]);
161 $this->attribs
["$name"][0] = $tmp;
164 // create a new child node
165 $this->attach_node($this->attribs
["$name"][] = (array)$attrs);
167 // node set doesn't exist, so create it
170 $this->attach_node($this->attribs
["$name"] = (array)$attrs);
177 * @param integer XML parser
178 * @param string CDATA from tag
180 function handle_cdata(&$parser, $data)
182 $this->cdata
.= $data;
186 * Process the closing of an XML tag
188 * @param integer XML parser
189 * @param string Tag name
191 function handle_tag_end(&$parser, $name)
193 // attach data to the node
194 if (($this->cdata
= trim($this->cdata
)) != '')
196 // if we have a data handler, operate it now
197 if (isset($this->taghandler
["$name"]))
199 $this->registry
->debug("handler: " . $this->taghandler
["$name"]);
200 if (function_exists($this->taghandler
["$name"]))
202 $this->cdata
= $this->taghandler
["$name"]($this->cdata
, $this);
206 trigger_error('Could not find the function [' . $this->taghandler
["$name"] . '()] for the XML tag "' . $name . '"', E_USER_ERROR
);
210 $this->attribs
['value'] = $this->cdata
;
216 $this->detach_node();
220 * Shifts the node tree
222 * @param array Node to place into the stack
224 function attach_node(&$node)
227 $this->stack
[ count($this->stack
) ] =& $node;
229 // new attributes to work with
230 $this->attribs
=& $node;
234 * Unshifts the node tree
236 function detach_node()
238 // drop the newest node
239 unset($this->stack
[ count($this->stack
) - 1 ]);
241 // assign the attributes to the next newest node
242 $this->attribs
=& $this->stack
[ count($this->stack
) - 1 ];
246 /*=====================================================================*\
247 || ###################################################################
250 || ###################################################################
251 \*=====================================================================*/