This is an improved version of my previous XML To Array function submitted on 09/19/02. It supports XML tag attributes and also single tag XML elements. Check back for updates to this code (see last update date above).
Old Description: This function converts an xml file to an associative array. It supports multiple attributes of the same name on the same level through use of an array. It could be very useful in situations where small xml files are being used for config info or data.
By : simgar
<?php // {{{ toString() /** * This method converts a file to a string. It returns an Error object if it is unable to open the file. * * @param fileName String. The name of the file to convert. * * @return String * @author simgar */
// {{{ xmlFileToArray() /** * This static method converts an xml file to an associative array * duplicating the xml file structure. * * @param $fileName. String. The name of the xml file to convert. * This method returns an Error object if this file does not * exist or is invalid. * @param $includeTopTag. booleal. Whether or not the topmost xml tag * should be included in the array. The default value for this is false. * @param $lowerCaseTags. boolean. Whether or not tags should be * set to lower case. Default value for this parameter is true. * @access public static * @return Associative Array * @author Jason Read <jason@ace.us.com> */ function & xmlFileToArray($fileName, $includeTopTag = false, $lowerCaseTags = true) { // Definition file not found if (!file_exists($fileName)) { // Error return false; } $p = xml_parser_create(); xml_parse_into_struct($p,toString($fileName),$vals,$index); xml_parser_free($p); $xml = array(); $levels = array(); $multipleData = array(); $prevTag = ""; $currTag = ""; $topTag = false; foreach ($vals as $val) { // Open tag if ($val["type"] == "open") { if (!_xmlFileToArrayOpen($topTag, $includeTopTag, $val, $lowerCaseTags, $levels, $prevTag, $multipleData, $xml)) { continue; } } // Close tag else if ($val["type"] == "close") { if (!_xmlFileToArrayClose($topTag, $includeTopTag, $val, $lowerCaseTags, $levels, $prevTag, $multipleData, $xml)) { continue; } } // Data tag else if ($val["type"] == "complete" && isset($val["value"])) { $loc =& $xml; foreach ($levels as $level) { $temp =& $loc[str_replace(":arr#", "", $level)]; $loc =& $temp; } $tag = $val["tag"]; if ($lowerCaseTags) { $tag = strtolower($val["tag"]); } $loc[$tag] = str_replace("\\n", "\n", $val["value"]); } // Tag without data else if ($val["type"] == "complete") { _xmlFileToArrayOpen($topTag, $includeTopTag, $val, $lowerCaseTags, $levels, $prevTag, $multipleData, $xml); _xmlFileToArrayClose($topTag, $includeTopTag, $val, $lowerCaseTags, $levels, $prevTag, $multipleData, $xml); } } return $xml; } // }}}
// {{{ _xmlFileToArrayOpen() /** * Private support function for xmlFileToArray. Handles an xml OPEN tag. * * @param $topTag. String. xmlFileToArray topTag variable * @param $includeTopTag. boolean. xmlFileToArray includeTopTag variable * @param $val. String[]. xmlFileToArray val variable * @param $currTag. String. xmlFileToArray currTag variable * @param $lowerCaseTags. boolean. xmlFileToArray lowerCaseTags variable * @param $levels. String[]. xmlFileToArray levels variable * @param $prevTag. String. xmlFileToArray prevTag variable * @param $multipleData. boolean. xmlFileToArray multipleData variable * @param $xml. String[]. xmlFileToArray xml variable * @access private static * @return boolean * @author Jason Read <jason@ace.us.com> */ function _xmlFileToArrayOpen(& $topTag, & $includeTopTag, & $val, & $lowerCaseTags, & $levels, & $prevTag, & $multipleData, & $xml) { // don't include top tag if (!$topTag && !$includeTopTag) { $topTag = $val["tag"]; return false; } $currTag = $val["tag"]; if ($lowerCaseTags) { $currTag = strtolower($val["tag"]); } $levels[] = $currTag;
// {{{ _xmlFileToArrayClose() /** * Private support function for xmlFileToArray. Handles an xml OPEN tag. * * @param $topTag. String. xmlFileToArray topTag variable * @param $includeTopTag. boolean. xmlFileToArray includeTopTag variable * @param $val. String[]. xmlFileToArray val variable * @param $currTag. String. xmlFileToArray currTag variable * @param $lowerCaseTags. boolean. xmlFileToArray lowerCaseTags variable * @param $levels. String[]. xmlFileToArray levels variable * @param $prevTag. String. xmlFileToArray prevTag variable * @param $multipleData. boolean. xmlFileToArray multipleData variable * @param $xml. String[]. xmlFileToArray xml variable * @access private static * @return boolean * @author Jason Read <jason@ace.us.com> */ function _xmlFileToArrayClose(& $topTag, & $includeTopTag, & $val, & $lowerCaseTags, & $levels, & $prevTag, & $multipleData, & $xml) { // don't include top tag if ($topTag && !$includeTopTag && $val["tag"] == $topTag) { return false; } if ($multipleData[$currTag]["multiple"]) { $tkeys = array_reverse(array_keys($multipleData)); foreach ($tkeys as $tkey) { if ($multipleData[$tkey]["multiple"] && !$multipleData[$tkey]["popped"]) { array_pop($levels); $multipleData[$tkey]["popped"] = true; break; } else if (!$multipleData[$tkey]["multiple"]) { break; } } } $prevTag = array_pop($levels); if (strpos($prevTag, "arr#")) { $prevTag = array_pop($levels); } return true; } // }}} ?>
DISCLAIMER: The content provided in this article is not warranted or guaranteed by Developer Shed, Inc. The content provided is intended for entertainment and/or educational purposes in order to introduce to the reader key ideas, concepts, and/or product reviews. As such it is incumbent upon the reader to employ real-world tactics for security and implementation of best practices. We are not liable for any negative consequences that may result from implementing any information covered in our articles or tutorials. If this is a hardware review, it is not recommended to open and/or modify your hardware.
