library/xmltoarray_parser_htmlfix.php

   1 <?php
   2 // +-----------------------------------------------------------------------------+
   3 // Copyright (C) 2011 ZMG LLC <sam@zhservices.com>
   4 //
   5 //
   6 // This program is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU General Public License
   8 // as published by the Free Software Foundation; either version 2
   9 // of the License, or (at your option) any later version.
  10 //
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16 //
  17 //
  18 // A copy of the GNU General Public License is included along with this program:
  19 // openemr/interface/login/GnuGPL.html
  20 // For more information write to the Free Software
  21 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22 //
  23 // Author:   Eldho Chacko <eldho@zhservices.com>
  24 //           Vinish K <vinish@zhservices.com>
  25 //
  26 // +------------------------------------------------------------------------------+
  27 /*
  28  * Proper usage for xmltoarray_parser_htmlfix class:
  29  * $xmltoarray = new xmltoarray_parser_htmlfix(); //create instance of class
  30  * $xmltoarray->xmlparser_setoption(XML_OPTION_SKIP_WHITE, 1); //set options same as xml_parser_set_option
  31  * $xmltoarray->xmlparser_setoption(XML_OPTION_CASE_FOLDING, 0);
  32  * $xmltoarray->xmlparser_fix_into_struct($xmlstring); //fixes html values for XML
  33  * $array = $xmltoarray->createArray(); //creates an array with fixed html values
  34  * foreach($array as $key => $value){
  35  *      $array[$key] = $xmltoarray->fix_html_entities($value); //returns proper html values
  36  * }
  37  */
  38 class xmltoarray_parser_htmlfix{
  39         var $values;
  40         var $index;
  41         var $thearray;
  42         var $parser;
  43
  44         /**
  45          * Default constructor for xmltoarray_parser_htmlfix.
  46          */
  47         function xmltoarray_parser_htmlfix(){
  48                 $this->values = array();
  49                 $this->index  = array();
  50                 $this->thearray  = array();
  51                 $this->parser = xml_parser_create();
  52         }
  53
  54         /**
  55          * xmlparser_setoption sets XML options based on xml_parser_set_option options.
  56          * @param $optionName - The name of the option from the xml_parser_set_option list.
  57          * @param $value - The value to set for the option.
  58          */
  59         function xmlparser_setoption($optionName, $value){
  60                 xml_parser_set_option($this->parser, $optionName, $value);
  61         }
  62
  63         /**
  64          * xmlparser_fix_into_struct fixes the XML and passes the XML into the struct parser.
  65          * @param $xml - A string XML value.
  66          */
  67         function xmlparser_fix_into_struct($xml){
  68                 $trans_table = get_html_translation_table(HTML_ENTITIES,ENT_QUOTES);
  69                 $keys = array();
  70                 foreach($trans_table as $key=>$value) {
  71             if($key != "<" && $key != ">" && $key != "&" && $key != "\"" && $key != "'" && $key != " "){
  72                                 $keys[$key] = $value;
  73                         }
  74                 }
  75                 foreach($keys as $key=>$value){
  76                         $xml =  preg_replace("/".$key."/",$value,$xml);
  77                 }
  78                 $xml =  str_replace("&","%and%",$xml);
  79
  80                 xml_parse_into_struct($this->parser, $xml, $this->values, $this->index);
  81                 xml_parser_free($this->parser);
  82         }
  83
  84         /**
  85          * createArray creates and returns the array.
  86          * @return The associative XML array.
  87          */
  88         function createArray(){
  89                 $i = 0;
  90                 $name = isset($this->values[$i]['tag']) ? $this->values[$i]['tag']: '';
  91                 $this->thearray[$name] = isset($this->values[$i]['attributes']) ? $this->values[$i]['attributes'] : '';
  92                 $this->thearray[$name] = $this->_struct_to_array($this->values, $i);
  93                 return $this->thearray;
  94         }//createArray
  95
  96         /**
  97          * _struct_to_array is a recursive function that takes the values and creates the array.
  98          * @param $values - The values of the XML
  99          * @param &$i - The index value
 100          * @return The child
 101          */
 102         function _struct_to_array($values, &$i){
 103                 $child = array();
 104                 if (isset($values[$i]['value'])) array_push($child, $values[$i]['value']);
 105
 106                 while ($i++ < count($values)) {
 107                         if(isset($values[$i])){
 108                                 switch ($values[$i]['type']) {
 109                                         case 'cdata':
 110                                         array_push($child, $values[$i]['value']);
 111                                         break;
 112
 113                                         case 'complete':
 114                                                 $name = $values[$i]['tag'];
 115                                                 if(!empty($name)){
 116                                                 $child[$name]= (isset($values[$i]['value']))?($values[$i]['value']):'';
 117                                                 if(isset($values[$i]['attributes'])) {
 118                                                         $child[$name] = $values[$i]['attributes'];
 119                                                 }
 120                                         }
 121                                         break;
 122
 123                                         case 'open':
 124                                                 $name = $values[$i]['tag'];
 125                                                 $size = isset($child[$name]) ? sizeof($child[$name]) : 0;
 126                                                 $child[$name][$size] = $this->_struct_to_array($values, $i);
 127                                         break;
 128
 129                                         case 'close':
 130                                         return $child;
 131                                         break;
 132                                 }
 133                         }
 134                 }
 135                 return $child;
 136         }//_struct_to_array
 137
 138         /**
 139          * fix_html_entities replaces all instances of '%and%' with '&', since the xml_parser can't handle '&'.
 140          * @param $string - A string value.
 141          * @return A fixed string with & instead of %and%.
 142          */
 143         function fix_html_entities($string){
 144                 $string =  str_replace("%and%","&",$string);
 145                 return $string;
 146         }
 147
 148 }
 149
 150 ?>