]> src.bluestatic.org Git - isso.git/blob - Xml.php
Updating makepo.sh.php to reflect the new way ScanDir() works
[isso.git] / Xml.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright ©2002-[#]year[#] Blue Static
6 || #
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.
10 || #
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
14 || # more details.
15 || #
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 \*=====================================================================*/
21
22 /**
23 * Static XML parser (Xml.php)
24 *
25 * @package ISSO
26 */
27
28 /**
29 * XML Parser
30 *
31 * A simple XML parser that is run by calling BSXml::Parse( String xmlData) and an
32 * array is returned with the parsed information.
33 *
34 * @author Blue Static
35 * @copyright Copyright ©2002 - [#]year[#], Blue Static
36 * @version $Revision$
37 * @package ISSO
38 *
39 */
40 class BSXml
41 {
42 /**
43 * Parser resource
44 * @var integer
45 */
46 private $parser = null;
47
48 /**
49 * An array of function names that are to be executed for each tag name (name => function)
50 * @var array()
51 */
52 private $taghandler = array();
53
54 /**
55 * Current CDATA value
56 * @var string
57 */
58 private $cdata = '';
59
60 /**
61 * Tag stack of all open nodes
62 * @var array
63 */
64 private $stack = array();
65
66 /**
67 * Node list for all open tag attributes
68 * @var array
69 */
70 private $attribs = array();
71
72 /**
73 * Resulting parsed array
74 * @var array
75 */
76 private $result = array();
77
78 // ###################################################################
79 /**
80 * Constructor
81 */
82 private function __construct() {}
83
84 // ###################################################################
85 /**
86 * Parse an XML file
87 *
88 * @param string XML file data
89 * @param bool Parse file as UTF-8 instead of ISSO-8859-1?
90 *
91 * @return array Array with all the XML data parsed
92 */
93 public static function Parse($data, $utf8 = false)
94 {
95 $parser = new BSXml();
96
97 if ($utf8)
98 {
99 $parser->parser = xml_parser_create('UTF-8');
100 }
101 else
102 {
103 $parser->parser = xml_parser_create('ISO-8859-1');
104 }
105
106 // create a new parser
107 xml_set_object($parser->parser, $parser);
108 xml_parser_set_option($parser->parser, XML_OPTION_CASE_FOLDING, 0);
109 xml_set_element_handler($parser->parser, '_handleStartTag', '_handleEndTag');
110 xml_set_character_data_handler($parser->parser, '_handleCData');
111
112 $parser->_attachNode($parser->result);
113
114 // parse the data and check for errors
115 if (!xml_parse($parser->parser, $data))
116 {
117 $error['code'] = xml_get_error_code($parser->parser);
118 $error['string'] = xml_error_string($error['code']);
119 $error['line'] = xml_get_current_line_number($parser->parser);
120 $error['column'] = xml_get_current_column_number($parser->parser);
121 trigger_error("XML Error: $error[string] at line $error[line] colunn $error[column]");
122 }
123
124 // destroy the parser
125 xml_parser_free($parser->parser);
126
127 // done... send the results back
128 return $parser->result;
129 }
130
131 // ###################################################################
132 /**
133 * Process the opening location of an XML tag
134 *
135 * @param integer XML parser
136 * @param string Tag name
137 * @param array Tag attributes
138 */
139 private function _handleStartTag(&$parser, $name, $attrs)
140 {
141 // we need to keep track of indicies to monitor the last key in $this->attribs
142 static $index;
143
144 // trim attributes
145 array_walk($attrs, 'trim');
146
147 // existing node set
148 if (isset($this->attribs["$name"]))
149 {
150 // node set has < 1 child nodes
151 if (!isset($this->attribs["$name"][0]))
152 {
153 $tmp = $this->attribs["$name"];
154 unset($this->attribs["$name"]);
155 $this->attribs["$name"][0] = $tmp;
156 }
157
158 // create a new child node
159 $this->attribs["$name"][ $index["$name"] ] = (array)$attrs;
160 $this->_attachNode($this->attribs["$name"][ $index["$name"] ]);
161 $index["$name"]++;
162 }
163 // node set doesn't exist, so create it
164 else
165 {
166 $this->attribs["$name"] = (array)$attrs;
167 $this->_attachNode($this->attribs["$name"]);
168 $index["$name"] = 1;
169 }
170 }
171
172 // ###################################################################
173 /**
174 * Process XML CDATA
175 *
176 * @param integer XML parser
177 * @param string CDATA from tag
178 */
179 private function _handleCData(&$parser, $data)
180 {
181 $this->cdata .= $data;
182 }
183
184 // ###################################################################
185 /**
186 * Process the closing of an XML tag
187 *
188 * @param integer XML parser
189 * @param string Tag name
190 */
191 private function _handleEndTag(&$parser, $name)
192 {
193 // attach data to the node
194 if (($this->cdata = trim($this->cdata)) != '')
195 {
196 $this->attribs['value'] = $this->cdata;
197 }
198
199 $this->cdata = '';
200
201 // remove the node
202 $this->_detachNode();
203 }
204
205 // ###################################################################
206 /**
207 * Shifts the node tree
208 *
209 * @param array Node to place into the stack
210 */
211 private function _attachNode(&$node)
212 {
213 // create a new node
214 $this->stack[ sizeof($this->stack) ] =& $node;
215
216 // new attributes to work with
217 $this->attribs =& $node;
218 }
219
220 // ###################################################################
221 /**
222 * Unshifts the node tree
223 */
224 private function _detachNode()
225 {
226 // drop the newest node
227 unset($this->stack[ sizeof($this->stack) - 1 ]);
228
229 // assign the attributes to the next newest node
230 $this->attribs =& $this->stack[ sizeof($this->stack) - 1 ];
231 }
232
233 // ###################################################################
234 /**
235 * Unless a node has multiple children, there will not be a numerical
236 * index for the child node. So this means that if you have variable
237 * XML structure with some of the same types of nodes having one children
238 * or multiple children, you'd have different things to parse. If
239 * you want the node unified (as in, all single-children would be indexed
240 * numerically, run this function on the node. It works on references.
241 *
242 * @param array The node to int-index
243 */
244 public static function UnifyNode(&$node)
245 {
246 if (!isset($node[0]))
247 {
248 $node = array($node);
249 }
250 }
251 }
252
253 /*=====================================================================*\
254 || ###################################################################
255 || # $HeadURL$
256 || # $Id$
257 || ###################################################################
258 \*=====================================================================*/
259 ?>