9 * @author Greg Beaver <cellog@php.net>
10 * @author Stephan Schmidt (original XML_Unserializer code)
11 * @copyright 1997-2009 The Authors
12 * @license http://opensource.org/licenses/bsd-license New BSD License
13 * @link http://pear.php.net/package/PEAR
14 * @since File available since Release 1.4.0a1
18 * Parser for any xml file
21 * @author Greg Beaver <cellog@php.net>
22 * @author Stephan Schmidt (original XML_Unserializer code)
23 * @copyright 1997-2009 The Authors
24 * @license http://opensource.org/licenses/bsd-license New BSD License
25 * @version Release: 1.10.1
26 * @link http://pear.php.net/package/PEAR
27 * @since Class available since Release 1.4.0a1
33 * @var string $_serializedData
35 var $_unserializedData = null;
38 * name of the root tag
44 * stack for all data that is found
45 * @var array $_dataStack
47 var $_dataStack = array();
50 * stack for all values that are generated
51 * @var array $_valStack
53 var $_valStack = array();
62 * The XML encoding to use
63 * @var string $encoding
65 var $encoding = 'ISO-8859-1';
72 return $this->_unserializedData;
76 * @param string xml content
77 * @return true|PEAR_Error
81 if (!extension_loaded('xml')) {
82 include_once 'PEAR.php';
83 return PEAR::raiseError("XML Extension not found", 1);
85 $this->_dataStack = $this->_valStack = array();
89 strpos($data, 'encoding="UTF-8"')
90 || strpos($data, 'encoding="utf-8"')
91 || strpos($data, "encoding='UTF-8'")
92 || strpos($data, "encoding='utf-8'")
94 $this->encoding = 'UTF-8';
97 $xp = xml_parser_create($this->encoding);
98 xml_parser_set_option($xp, XML_OPTION_CASE_FOLDING, 0);
99 xml_set_object($xp, $this);
100 xml_set_element_handler($xp, 'startHandler', 'endHandler');
101 xml_set_character_data_handler($xp, 'cdataHandler');
102 if (!xml_parse($xp, $data)) {
103 $msg = xml_error_string(xml_get_error_code($xp));
104 $line = xml_get_current_line_number($xp);
105 xml_parser_free($xp);
106 include_once 'PEAR.php';
107 return PEAR::raiseError("XML Error: '$msg' on line '$line'", 2);
109 xml_parser_free($xp);
114 * Start element handler for XML parser
117 * @param object $parser XML parser object
118 * @param string $element XML element
119 * @param array $attribs attributes of XML tag
122 function startHandler($parser, $element, $attribs)
125 $this->_dataStack[$this->_depth] = null;
131 'childrenKeys' => array(),
132 'aggregKeys' => array()
135 if (count($attribs) > 0) {
136 $val['children'] = array();
137 $val['type'] = 'array';
138 $val['children']['attribs'] = $attribs;
141 array_push($this->_valStack, $val);
147 * @param string $data
148 * @param string $element element name
150 function postProcess($data, $element)
156 * End element handler for XML parser
159 * @param object XML parser object
163 function endHandler($parser, $element)
165 $value = array_pop($this->_valStack);
166 $data = $this->postProcess($this->_dataStack[$this->_depth], $element);
168 // adjust type of the value
169 switch (strtolower($value['type'])) {
170 // unserialize an array
173 $value['children']['_content'] = $data;
176 $value['value'] = isset($value['children']) ? $value['children'] : array();
180 * unserialize a null value
187 * unserialize any scalar value
190 settype($data, $value['type']);
191 $value['value'] = $data;
195 $parent = array_pop($this->_valStack);
196 if ($parent === null) {
197 $this->_unserializedData = &$value['value'];
198 $this->_root = &$value['name'];
202 // parent has to be an array
203 if (!isset($parent['children']) || !is_array($parent['children'])) {
204 $parent['children'] = array();
205 if ($parent['type'] != 'array') {
206 $parent['type'] = 'array';
210 if (!empty($value['name'])) {
211 // there already has been a tag with this name
212 if (in_array($value['name'], $parent['childrenKeys'])) {
213 // no aggregate has been created for this tag
214 if (!in_array($value['name'], $parent['aggregKeys'])) {
215 if (isset($parent['children'][$value['name']])) {
216 $parent['children'][$value['name']] = array($parent['children'][$value['name']]);
218 $parent['children'][$value['name']] = array();
220 array_push($parent['aggregKeys'], $value['name']);
222 array_push($parent['children'][$value['name']], $value['value']);
224 $parent['children'][$value['name']] = &$value['value'];
225 array_push($parent['childrenKeys'], $value['name']);
228 array_push($parent['children'],$value['value']);
230 array_push($this->_valStack, $parent);
236 * Handler for character data
239 * @param object XML parser object
240 * @param string CDATA
243 function cdataHandler($parser, $cdata)
245 $this->_dataStack[$this->_depth] .= $cdata;