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 \*=====================================================================*/
29 $OBJECT = 'XML Parser';
30 $CLASS = 'XML_Parser';
36 * This framework is a wrapper for a robust XML parser.
38 * @author Iris Studios, Inc.
39 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
47 * Framework registry object
59 * An array of function names that are to be executed for each tag name (name => function)
62 var $taghandler = array();
71 * Tag stack of all open nodes
77 * Node list for all open tag attributes
80 var $attribs = array();
83 * Resulting parsed array
86 var $result = array();
91 function XML_Parser(&$registry)
93 $this->registry
=& $registry;
99 * @param string XML file data
101 * @return array Array with all the XML data parsed
103 function parse($data)
105 $this->stack
= array();
106 $this->attribs
= array();
107 $this->result
= array();
110 // create a new parser
111 $this->parser
= xml_parser_create();
112 xml_set_object($this->parser
, $this);
113 xml_parser_set_option($this->parser
, XML_OPTION_CASE_FOLDING
, 0);
114 xml_set_element_handler($this->parser
, 'handle_tag_start', 'handle_tag_end');
115 xml_set_character_data_handler($this->parser
, 'handle_cdata');
117 $this->attach_node($this->result
);
119 // parse the data and check for errors
120 if (!xml_parse($this->parser
, $data))
122 $error['code'] = xml_get_error_code($this->parser
);
123 $error['string'] = xml_error_string($error['code']);
124 $error['line'] = xml_get_current_line_number($this->parser
);
125 $error['column'] = xml_get_current_column_number($this->parser
);
126 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR
);
130 // destroy the parser
131 xml_parser_free($this->parser
);
133 // done... send the results back
134 return $this->result
;
138 * Process the opening location of an XML tag
140 * @param integer XML parser
141 * @param string Tag name
142 * @param array Tag attributes
144 function handle_tag_start(&$parser, $name, $attrs)
147 array_walk($attrs, 'trim');
150 if (isset($this->attribs
["$name"]))
152 // node set has < 1 child nodes
153 if (!isset($this->attribs
["$name"][0]))
155 $tmp = $this->attribs
["$name"];
156 unset($this->attribs
["$name"]);
157 $this->attribs
["$name"][0] = $tmp;
160 // create a new child node
161 $this->attach_node($this->attribs
["$name"][] = (array)$attrs);
163 // node set doesn't exist, so create it
166 $this->attach_node($this->attribs
["$name"] = (array)$attrs);
173 * @param integer XML parser
174 * @param string CDATA from tag
176 function handle_cdata(&$parser, $data)
178 $this->cdata
.= $data;
182 * Process the closing of an XML tag
184 * @param integer XML parser
185 * @param string Tag name
187 function handle_tag_end(&$parser, $name)
189 // attach data to the node
190 if (($this->cdata
= trim($this->cdata
)) != '')
192 // if we have a data handler, operate it now
193 if (isset($this->taghandler
["$name"]))
195 $this->registry
->debug("handler: " . $this->taghandler
["$name"]);
196 if (function_exists($this->taghandler
["$name"]))
198 $this->cdata
= $this->taghandler
["$name"]($this->cdata
, $this);
202 trigger_error('Could not find the function [' . $this->taghandler
["$name"] . '()] for the XML tag "' . $name . '"', E_USER_ERROR
);
206 $this->attribs
['value'] = $this->cdata
;
212 $this->detach_node();
216 * Shifts the node tree
218 * @param array Node to place into the stack
220 function attach_node(&$node)
223 $this->stack
[ count($this->stack
) ] =& $node;
225 // new attributes to work with
226 $this->attribs
=& $node;
230 * Unshifts the node tree
232 function detach_node()
234 // drop the newest node
235 unset($this->stack
[ count($this->stack
) - 1 ]);
237 // assign the attributes to the next newest node
238 $this->attribs
=& $this->stack
[ count($this->stack
) - 1 ];
242 /*=====================================================================*\
243 || ###################################################################
246 || ###################################################################
247 \*=====================================================================*/