]>
src.bluestatic.org Git - bugdar.git/blob - framework/xml.php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright (c)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 (c)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 = true)
122 $this->stack
= array();
123 $this->attribs
= array();
124 $this->result
= array();
129 $this->parser
= xml_parser_create('UTF-8');
133 $this->parser
= xml_parser_create('ISO-8859-1');
136 // create a new parser
137 xml_set_object($this->parser
, $this);
138 xml_parser_set_option($this->parser
, XML_OPTION_CASE_FOLDING
, 0);
139 xml_set_element_handler($this->parser
, 'handle_tag_start', 'handle_tag_end');
140 xml_set_character_data_handler($this->parser
, 'handle_cdata');
142 $this->attach_node($this->result
);
144 // parse the data and check for errors
145 if (!xml_parse($this->parser
, $data))
147 $error['code'] = xml_get_error_code($this->parser
);
148 $error['string'] = xml_error_string($error['code']);
149 $error['line'] = xml_get_current_line_number($this->parser
);
150 $error['column'] = xml_get_current_column_number($this->parser
);
151 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]", E_USER_ERROR
);
155 // destroy the parser
156 xml_parser_free($this->parser
);
158 // done... send the results back
159 return $this->result
;
162 // ###################################################################
164 * Process the opening location of an XML tag
168 * @param integer XML parser
169 * @param string Tag name
170 * @param array Tag attributes
172 function handle_tag_start(&$parser, $name, $attrs)
174 // we need to keep track of indicies to monitor the last key in $this->attribs
178 array_walk($attrs, 'trim');
181 if (isset($this->attribs
["$name"]))
183 // node set has < 1 child nodes
184 if (!isset($this->attribs["$name"][0]))
186 $tmp = $this->attribs
["$name"];
187 unset($this->attribs["$name"]);
188 $this->attribs
["$name"][0] = $tmp;
191 // create a new child node
192 $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
193 $this->attach_node($this->attribs["$name"][ $index["$name"] ]);
196 // node set doesn't exist, so create it
199 $this->attribs
["$name"] = (array)$attrs;
200 $this->attach_node($this->attribs["$name"]);
205 // ###################################################################
211 * @param integer XML parser
212 * @param string CDATA from tag
214 function handle_cdata(&$parser, $data)
216 $this->cdata .= $data;
219 // ###################################################################
221 * Process the closing of an XML tag
225 * @param integer XML parser
226 * @param string Tag name
228 function handle_tag_end(&$parser, $name)
230 // attach data to the node
231 if (($this->cdata = trim($this->cdata)) != '')
233 $this->attribs['value'] = $this->cdata;
239 $this->detach_node();
242 // ###################################################################
244 * Shifts the node tree
248 * @param array Node to place into the stack
250 function attach_node(&$node)
253 $this->stack[ sizeof($this->stack) ] =& $node;
255 // new attributes to work with
256 $this->attribs =& $node;
259 // ###################################################################
261 * Unshifts the node tree
265 function detach_node()
267 // drop the newest node
268 unset($this->stack[ sizeof($this->stack) - 1 ]);
270 // assign the attributes to the next newest node
271 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
274 // ###################################################################
276 * Unless a node has multiple children, there will not be a numerical
277 * index for the child node. So this means that if you have variable
278 * XML structure with some of the same types of nodes having one children
279 * or multiple children, you'd have different things to parse. If
280 * you want the node unified (as in, all single-children would be indexed
281 * numerically, run this function on the node. It works on references.
285 * @param array The node to int-index
287 function unify_node(&$node)
289 if (!isset($node[0]))
291 $node = array($node);