lib/xmlize.php

   1 <?php
   2
   3 /**
   4  * xmlize.php - xmlize() is by Hans Anderson, {@link http://www.hansanderson.com/contact/}
   5  *
   6  * Ye Ole "Feel Free To Use it However" License [PHP, BSD, GPL].
   7  * some code in xml_depth is based on code written by other PHPers
   8  * as well as one Perl script.  Poor programming practice and organization
   9  * on my part is to blame for the credit these people aren't receiving.
  10  * None of the code was copyrighted, though.
  11  *
  12  * @author Hans Anderson
  13  * @version This is a stable release, 1.0.  I don't foresee any changes, but you
  14  * might check {@link http://www.hansanderson.com/php/xml/} to see
  15  * @package moodlecore
  16  */
  17
  18 /**
  19  * Create xml formatted output from an array.
  20  *
  21  * usage:<br>
  22  * <code>
  23  * $xml = xmlize($array);
  24  * </code>
  25  * See the function {@link traverse_xmlize()} for information about the
  26  * structure of the array, it's much easier to explain by showing you.
  27  * Be aware that the array is somewhat tricky.  I use xmlize all the time,
  28  * but still need to use {@link traverse_xmlize()} quite often to show me the structure!
  29  *
  30  * THIS IS A PHP 5 VERSION:
  31  *
  32  * This modified version basically has a new optional parameter
  33  * to specify an OUTPUT encoding. If not specified, it defaults to UTF-8.
  34  * I recommend you to read this PHP bug. There you can see how PHP4, PHP5.0.0
  35  * and PHP5.0.2 will handle this.
  36  * {@link http://bugs.php.net/bug.php?id=29711}
  37  * Ciao, Eloy :-)
  38  *
  39  *
  40  * @author Hans Anderson
  41  * @param array $data The array to be converted
  42  * @param int $WHITE  If set to 1 allows the parser to skip "space" characters in xml document. Default is 0
  43  * @param string $encoding Specify an OUTPUT encoding. If not specified, it defaults to UTF-8.
  44  * @return array
  45  */
  46 function xmlize($data, $WHITE=1, $encoding='UTF-8') {
  47
  48     $data = trim($data);
  49     $vals = $index = $array = array();
  50     $parser = xml_parser_create($encoding);
  51     xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
  52     xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, $WHITE);
  53     xml_parse_into_struct($parser, $data, $vals, $index);
  54     xml_parser_free($parser);
  55
  56     $i = 0;
  57
  58     $tagname = $vals[$i]['tag'];
  59     if ( isset ($vals[$i]['attributes'] ) )
  60     {
  61         $array[$tagname]['@'] = $vals[$i]['attributes'];
  62     } else {
  63         $array[$tagname]['@'] = array();
  64     }
  65
  66     $array[$tagname]["#"] = xml_depth($vals, $i);
  67
  68
  69     return $array;
  70 }
  71
  72 /**
  73  * @internal You don't need to do anything with this function, it's called by
  74  * xmlize. It's a recursive function, calling itself as it goes deeper
  75  * into the xml levels.  If you make any improvements, please let me know.
  76  * @access private
  77  */
  78 function xml_depth($vals, &$i) {
  79     $children = array();
  80
  81     if ( isset($vals[$i]['value']) )
  82     {
  83         array_push($children, $vals[$i]['value']);
  84     }
  85
  86     while (++$i < count($vals)) {
  87
  88         switch ($vals[$i]['type']) {
  89
  90            case 'open':
  91
  92                 if ( isset ( $vals[$i]['tag'] ) )
  93                 {
  94                     $tagname = $vals[$i]['tag'];
  95                 } else {
  96                     $tagname = '';
  97                 }
  98
  99                 if ( isset ( $children[$tagname] ) )
 100                 {
 101                     $size = sizeof($children[$tagname]);
 102                 } else {
 103                     $size = 0;
 104                 }
 105
 106                 if ( isset ( $vals[$i]['attributes'] ) ) {
 107                     $children[$tagname][$size]['@'] = $vals[$i]["attributes"];
 108
 109                 }
 110
 111                 $children[$tagname][$size]['#'] = xml_depth($vals, $i);
 112
 113             break;
 114
 115
 116             case 'cdata':
 117                 array_push($children, $vals[$i]['value']);
 118             break;
 119
 120             case 'complete':
 121                 $tagname = $vals[$i]['tag'];
 122
 123                 if( isset ($children[$tagname]) )
 124                 {
 125                     $size = sizeof($children[$tagname]);
 126                 } else {
 127                     $size = 0;
 128                 }
 129
 130                 if( isset ( $vals[$i]['value'] ) )
 131                 {
 132                     $children[$tagname][$size]["#"] = $vals[$i]['value'];
 133                 } else {
 134                     $children[$tagname][$size]["#"] = '';
 135                 }
 136
 137                 if ( isset ($vals[$i]['attributes']) ) {
 138                     $children[$tagname][$size]['@']
 139                                              = $vals[$i]['attributes'];
 140                 }
 141
 142             break;
 143
 144             case 'close':
 145                 return $children;
 146             break;
 147         }
 148
 149     }
 150
 151         return $children;
 152
 153
 154 }
 155
 156
 157 /**
 158  * This helps you understand the structure of the array {@link xmlize()} outputs
 159  *
 160  * Function by acebone@f2s.com, a HUGE help!<br>
 161  * Usage:<br>
 162  * <code>
 163  * traverse_xmlize($xml, 'xml_');
 164  * print '<pre>' . implode("", $traverse_array . '</pre>';
 165  * </code>
 166  * @author acebone@f2s.com
 167  * @param array $array ?
 168  * @param string $arrName ?
 169  * @param int $level ?
 170  * @return int
 171  * @todo Finish documenting this function
 172  */
 173 function traverse_xmlize($array, $arrName = 'array', $level = 0) {
 174
 175     foreach($array as $key=>$val)
 176     {
 177         if ( is_array($val) )
 178         {
 179             traverse_xmlize($val, $arrName . '[' . $key . ']', $level + 1);
 180         } else {
 181             $GLOBALS['traverse_array'][] = '$' . $arrName . '[' . $key . '] = "' . $val . "\"\n";
 182         }
 183     }
 184
 185     return 1;
 186
 187 }
 188
 189 ?>