downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | links | conferences | my php.net

search for in the

utf8_decode> <XML External Entity Example
Last updated: Fri, 06 Nov 2009

view this page in

XML Parser Functions

Table of Contents



utf8_decode> <XML External Entity Example
Last updated: Fri, 06 Nov 2009
 
add a note add a note User Contributed Notes
XML Parser Functions
wolfon.AT-DoG.inbox.ru
28-Jul-2008 10:09
Finally a simple xml => array class.
Functioning like SimpleXML library.

<?php
class xml  {
    private
$parser;
    private
$pointer;
    public
$dom;
   
    public function
__construct($data) {
       
$this->pointer =& $this->dom;
       
$this->parser = xml_parser_create();
       
xml_set_object($this->parser, $this);
       
xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, false);
       
xml_set_element_handler($this->parser, "tag_open", "tag_close");
       
xml_set_character_data_handler($this->parser, "cdata");
       
xml_parse($this->parser, $data);
    }
  
    private function
tag_open($parser, $tag, $attributes) {
        if (isset(
$this->pointer[$tag]['@attributes'])) {
           
$content = $this->pointer[$tag];
           
$this->pointer[$tag] = array(0 => $content);
           
$idx = 1;
        } else if (isset(
$this->pointer[$tag]))
           
$idx = count($this->pointer[$tag]);

        if (isset(
$idx)) {
           
$this->pointer[$tag][$idx] = Array(
               
'@idx' => $idx,
               
'@parent' => &$this->pointer);
              
$this->pointer =& $this->pointer[$tag][$idx];
        } else {
           
$this->pointer[$tag] = Array(
               
'@parent' => &$this->pointer);
           
$this->pointer =& $this->pointer[$tag];
        }
        if (!empty(
$attributes))
           
$this->pointer['@attributes'] = $attributes;
    }

    private function
cdata($parser, $cdata) {
          
$this->pointer['@data'] = $cdata;
    }

    private function
tag_close($parser, $tag) {
       
$current = & $this->pointer;
        if (isset(
$this->pointer['@idx']))
            unset(
$current['@idx']);
       
       
$this->pointer = & $this->pointer['@parent'];
       
          unset(
$current['@parent']);
           if (isset(
$current['@data']) && count($current) == 1)
              
$current = $current['@data'];
           else if (empty(
$current['@data'])||$current['@data']==0)
               unset(
$current['@data']);
    }
}
?>

maybe I'll do some explanations on habr
Anonymous
18-May-2008 07:18
This is peace of the code. It edit xml file.
<?
$songs = Array();
function start_element($parser, $name, $attrs){
    global $songs;
    if($name == "song"){
        array_push($songs, $attrs);
    }
}
function end_element ($parser, $name){}
$playlist_string = file_get_contents("test.xml");
$parser = xml_parser_create();
xml_set_element_handler($parser, "start_element", "end_element");
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
xml_parse($parser, $playlist_string) or die("Error parsing XML document.");
print "<br />";
if($_POST['action'] == "ins"){
    array_push($songs, Array(
                "title" => $_POST['title'],
                "artist" => $_POST['artist'],
                "path" => $_POST['path']));
    $songs_final = $songs;
}else if($_POST['action'] == "del"){
    $songs_final = Array();
    foreach($songs as $song){
        if($song['title'] != $_POST['title']){
            array_push($songs_final, $song);
        }
    }
}
$write_string = "<songs>";
foreach($songs_final as $song){

    $write_string .= "<song>";
    $write_string .= "<title>".$song['title']."</title>";
    $write_string .= "<artist>".$song['artist']."</artist>";
    $write_string .= "<path>".$song['path']."</path>";
    $write_string .= "</song>";

}
$write_string .= "</songs>";
$fp = fopen("test.xml", "w+");
fwrite($fp, $write_string) or die("Error writing to file");
fclose($fp);
print "<em>Song inserted or deleted successfully :)</em><br />";
print "<a href=\"index.php\" title=\"return\">Return</a>";
?>
galen dot senogles at gmail dot com
29-Apr-2008 08:48
An update to the function below.  Fixes a bug where the data of the first tag, would occasionally get appended to the beginning of the tag data of the second tag.

<?php

   
foreach($dom['child_nodes'][0]['child_nodes'] as $key => $value) {
     
$tagname  = $value['tag_name'];
      if(isset(
$value['child_nodes'][0])) {
       
$numarrays = count($value['child_nodes']);
        if(
$numarrays > 1) {
         
$contents = "";
          foreach(
$value['child_nodes'] as $key => $value2) {
           
$contents .= $value2;
          }
        }else {
         
$contents = $value['child_nodes'][0];
        }
      }else {
       
$contents = 'isempty';
      }
    
     
$artmp = array($tagname => $contents);
     
array_push_associative($xmlarray,$artmp);
      unset(
$artmp);
    }

?>
galen dot senogles at gmail dot com
25-Apr-2008 09:28
If anyone else is having issues figuring out how to utilize the xml class that people have created and  modified, don't worry as you are not alone.  It took me a bit to come up with a solution that I liked, but I feel this does the job quite nice.

I read through the entire structure of the xml file and create an associative array based on the tag names.

I didn't worry about tag attributes as I didn't need to use them; so remember that if you use this method, you are only getting the tag name and the data inside the tag...that is all, no attributes!!

I am not going to include the xml class as it has been copy pasted multiple times already on this thread. Just scroll down for the xml class.

First let me show just an example of the EXTREMELY simple xml structure I was working with. Again, you will need to make modifications depending on the structure of the xml file you are working with! (I know I could use simplexml but I have php4 and not 5).

<?xml version="1.0"?>
<menuitems>
  <menutype>1</menutype>
  <product>Just some product info</product>
  <shipping>some stuff</shipping>
</menuitems>

The custom associative array push function taken from:
http://us.php.net/manual/en/function.array-push.php#58705

The xml class file is located here:
http://us.php.net/manual/en/ref.xml.php#81910

<?php
   
// Obtain the exact path to the xml file
   
$xmlfile = "mydata.xml";
   
$fp = fopen($xmlfile,"r");             // open the xml file
   
$xml = fread($fp, filesize($xmlfile)); // read in the size of the file into the variable xml
   
fclose($fp);                           // close the stream
   
   
$xml_parser = new xml();  // create a new xml class instance
   
$xml_parser->parse($xml); // parse the variable xml which contains our xml data
   
$dom = $xml_parser->dom// make a variable that holds the entire dom

/*
      This part extracts the xml nodes from the dom and places them into an associative array.
      The associative array key is the name of the tag; the value is the tag contents.
      We simply create an array on the fly using the name and contents, and hit that array
      with our original array using the array_push_associative function. We then check if
      isset to prevent errors from being displayed.  If the tag contents are empty,
      I put the string isempty inside so I can easily check to see later if there is contents or not.
*/ 

   
$xmlarray = array(); // the array we are going to store the information within the tag
   
$contents = "";
   
    foreach(
$dom['child_nodes'][0]['child_nodes'] as $key => $value) {
     
$tagname  = $value['tag_name'];
      if(isset(
$value['child_nodes'][0])) {
       
$numarrays = count($value['child_nodes']);
        if(
$numarrays > 1) {
          foreach(
$value['child_nodes'] as $key => $value2) {
           
$contents .= $value2;
          }
        }else {
         
$contents = $value['child_nodes'][0];
        }
      }else {
       
$contents = 'isempty';
      }
     
     
$artmp = array($tagname => $contents);
     
array_push_associative($xmlarray,$artmp);
      unset(
$artmp);
    }

    unset(
$xml);        // free up resources
   
unset($xml_parser); // free up resources
   
unset($dom);        // free up resources
?>

You may be wondering why there is a nested count and foreach loop inside the main foreach loop.  The reason that exists is that the xml class that I am using in this example, the one that is four posts down from this one, has the wonderful behavior in that when something hits the length of 1024 characters, it creates a new element in the array and puts the next 1024 characters into that next element etc.  This caused me massive confusion as to why some of my data was getting cut off.

So say I wanted to display the data inside the product tag, all I would need to do is this:

<?php
  
echo $xmlarray['product']
?>

I sincerely hope this helps people figure out how to utilize the xml class quicker than I did!

If anyone has suggestions, modifications, or whatever, please post it here!

Thanks
galen dot senogles at gmail dot com
19-Apr-2008 07:10
I used shawn's code that is an ongoing fix/update of a very nice php 4 & 5 compatible class.

It works great, only it kept giving me errors when the array isn't set, (I have errors set to show all).
<?php
// Here is the old function that gave errors:
   
function makeChildNode() {
        if (!
is_array($this->pointer['child_nodes'])){
           
$this->pointer['child_nodes'] = array();
        }
        return
count($this->pointer['child_nodes']);
    }

// Here is the new function that does not spit errors:
   
function makeChildNode() {
        if (!isset(
$this->pointer['child_nodes'])){
           
$this->pointer['child_nodes'] = array();
        }
        return
count($this->pointer['child_nodes']);
    }

?>
shawn dot rapp at gmail dot com
03-Apr-2008 07:24
Well I posted my script with an example fread($fp, 4096) meaning that it will only read 4k.  It was just for a quick example.  If you used that to input data from a really long XML file to the parser that would be the problem.
you could replace the 4096 with filesize("file.xml") or try replacing that example test code part with:

$xml = implode('',file("http://localhost/test.xml"));
$xml_parser = new XML_Class();
$xml_parser->parse($xml);
print_r($xml_parser->dom);

I've tried to recreate your problems by posting entire howto of installing LDAP into character data space of a node and can't get it to fail.  Please email with more info if the above isn't the problem.
But on that routine you posted from that website.  The problem with that one is it seems to be padding with unnecessary arrays.  It will overwrite different nodes with the same name if they are within the same parent.  And the number one biggest issue for me is that it drops attributes.  That is totally bogus.  It's a lot cleaner to store most values in attributes than making a zillion nodes and storing the data for something small like a integer or a float as character data.
Example: 
<coords x="1.53234" y="56.287" z="4.32" />
VS
<coords><x>1.53234</x><y>56.287</y><z>4.32</z></coords>

To me the top is very readable where the later makes my eyes bleed.
Any ways what is good about the links code is the error checking.  Isolating all the code in the parse method instead of constructor so the object is recyclable. And than releases the xml parser.
I'm definitely going to be putting that stuff into my class after I post this note.
 
But let me know if its still truncating.
shawn dot rapp at gmail dot com
19-Mar-2008 02:52
The reason why you would want to make your own simplistic DOM parser is because a lack of compatible between PHP 4's domxml and PHP 5's dom.
So it is for portability without having to wrapper the two different DOMs.
If you need a simple light weight XML parser that is portable this is the best way.  If you are writing applications for a particular server and more concerned with functionality and speed go with a compiled in DOM.
Here is the fix to Emmetts code...

<?PHP
$fp
= fopen("test.xml","r");
$xml = fread($fp, 4096);
fclose($fp);
$xml_parser = new xml();
$xml_parser->parse($xml);
$dom = $xml_parser->dom;
print_r($dom);

class
xml  {
    var
$parser;
    var
$pointer;
    var
$dom;
    function
xml() {
       
$this->pointer =& $this->dom;
       
$this->parser = xml_parser_create();
       
xml_set_object($this->parser, $this);
       
xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, false);
       
xml_set_element_handler($this->parser, "tag_open", "tag_close");
       
xml_set_character_data_handler($this->parser, "cdata");
    }

    function
parse($data) {
       
xml_parse($this->parser, $data);
    }
  
    function
makeChildNode() {
        if (!
is_array($this->pointer['child_nodes'])){
           
$this->pointer['child_nodes'] = array();
        }
        return
count($this->pointer['child_nodes']);
    }

    function
tag_open($parser, $tag, $attributes) {
       
$idx = $this->makeChildNode();
       
$this->pointer['child_nodes'][$idx] = Array(
           
'_idx' => $idx,
           
'_parent' => &$this->pointer,
           
'tag_name' => $tag,
           
'attributes' => $attributes,
        );
       
$this->pointer =& $this->pointer['child_nodes'][$idx];
    }

    function
cdata($parser, $cdata) {
       
//drop text nodes that are just white space formatting characters
       
if (trim($cdata) != "") {
           
$idx = $this->makeChildNode();
           
$this->pointer['child_nodes'][$idx] = $cdata;
            }
    }

    function
tag_close($parser, $tag) {
       
$idx =& $this->pointer['_idx'];
       
$this->pointer =& $this->pointer['_parent'];
        unset(
$this->pointer['child_nodes'][$idx]['_idx']);
        unset(
$this->pointer['child_nodes'][$idx]['_parent']);
    }
}
?>
jesdisciple at gmail dot com
07-Mar-2008 10:00
@[emmett dot thesane at yahoo dot com]: That code didn't work for me, but it seems that using the DOM functions (http://php.net/manual/en/ref.dom.php) would be more efficient.
emmett dot thesane at yahoo dot com
11-Dec-2007 12:19
There's a couple of vital flaws in aquariusrick's example:
1. Multiple tags of the same name will overwrite one another.
2. Text nodes within an element are all strung together, with no information saved regarding their order with respect to non-text nodes.

It provided a good starting point, however, for a DOM-builder that *does* allow those things.  This should be a more familiar structure for people used to DOM-walking in the browser; children of each node are stored in "childNodes". Text nodes are simply a child node that is only a string, instead of an array.

$xml_parser = new xml();
$xml_parser->parse($xml);
$dom = $xml_parser->dom;
print_r($dom);

class xml  {
    var $parser;
    var $pointer;
    var $dom;
    function xml() {
        $this->pointer =& $this->dom;
        $this->parser = xml_parser_create();
        xml_set_object($this->parser, $this);
        xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, false);
        xml_set_element_handler($this->parser, "tag_open", "tag_close");
        xml_set_character_data_handler($this->parser, "cdata");
    }

    function parse($data) {
        xml_parse($this->parser, $data);
    }
   
    function makeChildNode() {
        if (!isset($this->pointer['childNodes'])){
            $this->pointer['childNodes'] = array();
        }
        return count($this->pointer['childNodes']);
    }

    function tag_open($parser, $tag, $attributes) {
        $idx = $this->makeChildNode();
        $this->pointer['childNodes'][$idx] = Array(
            '_idx' => $idx,
            'tagName' => $tag,
            'parentNode' => &$this->pointer,
            'attributes' => $attributes,
        );
        $this->pointer =& $this->pointer['childNodes'][$idx];
    }

    function cdata($parser, $cdata) {
        $idx = $this->makeChildNode();
        $this->pointer['childNodes'][$idx] = $cdata;
        //text node -- has no other attributes than the content
    }

    function tag_close($parser, $tag) {
        $idx =& $this->pointer['_idx'];
        $this->pointer =& $this->pointer['_parent'];
        unset($this->pointer['childNodes'][$idx]['_idx']);
    }
}
aquariusrick
06-Dec-2007 04:43
Here's another attempt at a very simple script that parses XML into a structure:

<?php
#Usage:
    //$xml_parser = new xml();
    //$xml_parser->parse($xml);
    //$dom = $xml_parser->dom;

class xml  {
    var
$parser;
    var
$pointer;
    var
$dom;
    function
xml() {
       
$this->pointer =& $this->dom;
       
$this->parser = xml_parser_create();
       
xml_set_object($this->parser, $this);
       
xml_parser_set_option($this->parser, XML_OPTION_CASE_FOLDING, false);
       
xml_set_element_handler($this->parser, "tag_open", "tag_close");
       
xml_set_character_data_handler($this->parser, "cdata");
    }

    function
parse($data) {
       
xml_parse($this->parser, $data);
    }

    function
tag_open($parser, $tag, $attributes) {
       
$this->pointer[$tag] = Array(
           
'_parent'   => &$this->pointer,
           
'_content'  => null,
           
'_attributes' => $attributes,
        );
       
$this->pointer =& $this->pointer[$tag];
    }

    function
cdata($parser, $cdata) {
       
$this->pointer['_content'] .= $cdata;
    }

    function
tag_close($parser, $tag) {
       
$this->pointer =& $this->pointer['_parent'];
        unset(
$this->pointer[$tag]['_parent']);
    }

}
// end xml class
?>
yousuf at philipz dot com
25-Nov-2007 07:53
Here is my modification of < dmeekins att gmail doot com > XMLParser class, as i have used it for quite a bit. There were 2 problems with his post, which of course was a modification of an earlier post, so the problem continued through the many versions. The problems were in the dataHandler function. The first problem was with '$data = trim($data);' which removed line breakers from data which went over many lines and the second problem was when a tag had a value 0. So here is the corrected function.

<?php
   
function dataHandler($parser, $data)
    {
        if(!empty(
$data) || strval($data) != "" )
        {

            if(isset(
$this->currTag['data']))
               
$this->currTag['data'] .= $data;
            else
               
$this->currTag['data'] = $data;
        }
    }
?>

By removing '$data = trim($data);', you will notice that some [data] elements, mainly the root ones, will have alot of line breakers in them with no actual data.

The code by < geoffers [at] gmail [dot] com > was also quite good as it keeps things alot smaller than XMLParser and here's my modification of part of his code, as i preferred to have it look similar to how XMLParser has it (removes the ['child'] entry and changes 'attribs' to 'attr').

<?php
   
function parse($data)
    {
       
$this->parser = xml_parser_create('UTF-8');
       
xml_set_object($this->parser, $this);
       
xml_parser_set_option($this->parser, XML_OPTION_SKIP_WHITE, 1);
       
xml_set_element_handler($this->parser, 'tag_open', 'tag_close');
       
xml_set_character_data_handler($this->parser, 'cdata');
        if (!
xml_parse($this->parser, $data))
        {
           
$this->data = array();
           
$this->error_code = xml_get_error_code($this->parser);
           
$this->error_string = xml_error_string($this->error_code);
           
$this->current_line = xml_get_current_line_number($this->parser);
           
$this->current_column = xml_get_current_column_number($this->parser);
        }
        else
        {
           
$this->data = $this->data;
        }
       
xml_parser_free($this->parser);
    }

    function
tag_open($parser, $tag, $attribs)
    {
       
$this->data[$tag][] = array('data' => '', 'attr' => $attribs);
       
$this->datas[] =& $this->data;
       
$this->data =& $this->data[$tag][count($this->data[$tag])-1];
    }
?>

The code by < adamaflynn at criticaldevelopment dot net > and < geoff at spacevs dot com > are also quite good but use xmlObject object rather than standard arrays.
geoff at spacevs dot com
08-Nov-2007 05:13
Reading xml into a class:

<?PHP
       
class XmlData {}
       
$elements = array();
       
$elements[] =& new XmlData();
        function
startElement($parser, $name, $attrs) {
                global
$elements;
               
$element =& new XMLData();
               
$elements[count($elements)-1]->$name =& $element;
               
$elements[] =& $element;
        }
        function
endElement($parser, $name) {
                global
$elements;
               
array_pop($elements);
        }
        function
characterData($parser, $data) {
                global
$elements;
               
$elements[count($elements)-1]->data = $data;
        }
       
$xml_parser     = xml_parser_create();
       
xml_set_element_handler($xml_parser, "startElement", "endElement");
       
xml_set_character_data_handler($xml_parser, "characterData");
       
xml_parse($xml_parser, $xml, true);
       
xml_parser_free($xml_parser);
       
$request =& array_pop($elements);

        echo
$request->LOGIN->USER->data;
?>
demonpants at gmail dot com
23-Oct-2007 03:59
I wanted to access the ISBN database, and was previously parsing the HTML string generated from their main page, that is until I discovered they have an API that returns XML.

So, if anyone wants to get some information from the ISBN database, all you need to do is the following.

<?php
//Search the ISBN database for the book.
           
$url = "http://www.isbndb.com/api/books.xml? access_key=KEY&index1=isbn&value1=$_GET[ISBN]";
           
$p = xml_parser_create();
           
xml_parse_into_struct($p,file_get_contents($url),$results,$index);
           
xml_parser_free($p);

           
$title = $results[$index[TITLELONG][0]][value];
           
$author = $results[$index[AUTHORSTEXT][0]][value];
           
$publisher = $results[$index[PUBLISHERTEXT][0]][value];
?>

You will need to get an access key from isbndb.com, but it takes two seconds and is free. When you get it, replace KEY in the URL with your own key. Also, my code above will search for the book that fits the ISBN number stored in the GET variable ISBN - you can search by other parameters and return more than one result, but my example is  for a simple ISBN search.
TeerachaiJ at GMail dot com
15-Oct-2007 09:17
I enhance xml2array (can't remember who author) to work with duplicate key index by change "tagData" function with this ->

<?
  function tagData($parser, $tagData) {  

    // set the latest open tag equal to the tag data

    $strEval = "\$this->arrOutput";
    foreach ($this->arrName as $value) {
      $strEval .= "[" . $value . "]";
      $arr .= "[" . $value . "]";        //*Enhance by T•J (array when dup)
    }

    eval("\$x=\$this->arrOutput" . $arr . ";");        //*Enhance by T•J (array when dup)
    if($x) { $strEval = $strEval . "[" . ++$this->arrOutput[$arr] . "] = \$tagData;"; }        //*Enhance by T•J (array when dup)
     else { $strEval = $strEval . " = \$tagData;"; }
   
    eval ($strEval);
  }
?>

I not sure have another do it now.
Hope!!! It will help your work.
Zvjezdan Patz
09-Sep-2007 03:22
The problem I had was I needed to generate xml on the screen for users to actually see and copy to a file. 

I'm generating the xml manually from a php file and the browser kept interpreting the xml...not very helpful. 

This is how you get around it:

<?

$file  = file_get_contents("http://fileurl/xml.php?whatever=$whatever");
print nl2br(htmlentities($file));

?>

Prints all my xml quite nicely.
v9 at fakehalo dot us
14-Jul-2007 03:04
I needed this for work/personal use.  Sometimes you'll have a XML string generated as one long string and no line breaks...nusoap in the case of today/work, but there are any other number of possible things that will generate these.  Anyways, this simply takes a long XML string and returns an indented/line-breaked version of the string for display/readability.

<?
function xmlIndent($str){
    $ret = "";
    $indent = 0;
    $indentInc = 3;
    $noIndent = false;
    while(($l = strpos($str,"<",$i))!==false){
        if($l!=$r && $indent>0){ $ret .= "\n" . str_repeat(" ",$indent) . substr($str,$r,($l-$r)); }
        $i = $l+1;
        $r = strpos($str,">",$i)+1;
        $t = substr($str,$l,($r-$l));
        if(strpos($t,"/")==1){
            $indent -= $indentInc;
            $noIndent = true;
        }
        else if(($r-$l-strpos($t,"/"))==2 || substr($t,0,2)=="<?"){ $noIndent = true; }
        if($indent<0){ $indent = 0; }
        if($ret){ $ret .= "\n"; }
        $ret .= str_repeat(" ",$indent);
        $ret .= $t;
        if(!$noIndent){ $indent += $indentInc; }
        $noIndent = false;
    }
    $ret .= "\n";
    return($ret);
}
?>

(...this was only tested for what i needed at work, could POSSIBLY need additions)
ricardo at sismeiro dot com
08-Jun-2007 11:29
<?php

/**
 * correction of the previous code
 */

/**
 * Converts XML into Array
 *
 * @param array $result
 * @param object  $root
 * @param string $rootname
 */
function convert_xml2array(&$result,$root,$rootname='root'){
   
   
$n=count($root->children());

    if (
$n>0){

       
/**
         * start of the correction
         */
       
if (!isset($result[$rootname]['@attributes'])){
           
$result[$rootname]['@attributes']=array();
            foreach (
$root->attributes() as $atr=>$value){
               
$result[$rootname]['@attributes'][$atr]=(string)$value;
            }           
        }
       
/**
         *  end of the correction
         */
       
        
foreach ($root->children() as $child){
            
$name=$child->getName();    
            
convert_xml2array($result[$rootname][],$child,$name);                         
         }
    } else {       
       
$result[$rootname]= (array) $root;
        if (!isset(
$result[$rootname]['@attributes'])){
           
$result[$rootname]['@attributes']=array();
        }
    }
}

/**
 * Example how to use the function convert_xml2array
 */

/**
 * Return  Array from a xml string
 *
 * @param string $xml
 * @return array
 */
function get_array_fromXML($xml){       
   
   
$result=array();   
   
   
$doc=simplexml_load_string($xml);    
   
   
convert_xml2array($result,$doc);    
   
    return
$result['root'];   
}

?>
adamaflynn at criticaldevelopment dot net
14-Apr-2007 06:50
Here is an example of another XML parsing script that parses the document into an array/object structure instead of relying on startElement, endElement, etc handlers.

You can find the documentation at:
http://www.criticaldevelopment.net/xml/doc.php

And the code (both PHP4 and PHP5 versions):
http://www.criticaldevelopment.net/xml/parser_php4.phps
http://www.criticaldevelopment.net/xml/parser_php5.phps

If you have any questions about it, just drop me an e-mail.
phpzmurf[at]yahoo.com
12-Apr-2007 11:19
/*
 * Parse rss news, quotes etc.
 *
 * author : phpZmurf <phpzmurf[at]yahoo.com>
 * created: 12.04.2007
 * ver    : 1.0
 *
*/

$data = implode("", file("http://feeds.feedburner.com/quotationspage/qotd/"));
$parser = xml_parser_create();
xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
xml_parse_into_struct($parser, $data, $values, $tags);
xml_parser_free($parser);

# data saved here
$arrQuotes = array();
# at the beginig - the tag is set colsed
$tagOpen = false;

foreach($values as $key => $item) {
    if(!$tagOpen and $item['tag'] == 'item' and $item['type'] == 'open') {
        # item tag opens
        $tagOpen = true;
        # empty temporary variables
        $temp_title = '';
        $temp_description = '';
        $temp_guid = '';
        $temp_link = '';
    } elseif($item['tag'] == 'item' and $item['type'] == 'close') {
        # item tag ends
        $tagOpen = false;
        # if all 4 tags contain data... add them to output array
        if($temp_title != '' and $temp_description != '' and $temp_guid != '' and $temp_link != '') {
            $arrQuotes[] = array(
                'title' => $temp_title,
                'description' => $temp_description,
                'guid' => $temp_guid,
                'link' => $temp_link
            );
        }
    } else {
        # save data into temporary variables
        switch($item['tag']) {
            case 'title':
                $temp_title = $item['value'];
            break;
            case 'description':
                # this here quz there was a fuggin <p> at the end of the desription
                #$temp_description = $item['value'];
                $temp_description = substr($item['value'], 0, strpos($item['value'], '<'));
            break;
            case 'guid':
                $temp_guid = $item['value'];
            break;
            case 'link':
                $temp_link = $item['value'];
            break;
            default: break;
        }
    }
}

foreach($arrQuotes as $key => $item) {
    print_r($item);
}
Sheer Pullen
15-Mar-2007 02:27
I took the code posted by forqoun and modified it to be somewhat more readable (by me), somewhat more friendly to the idea of parsing multiple files with the same object, and to be compatable with a HTTP POST of XML data. Anyone who's interested in my version of associated array output can check it out at http://www.sheer.us/code/php/xml-parse-to-associative-array.phpsrc

Be nice to me, this is my first published php code
geoffers [at] gmail [dot] com
30-Dec-2006 11:27
Time to add my attempt at a very simple script that parses XML into a structure:

<?php

class Simple_Parser
{
    var
$parser;
    var
$error_code;
    var
$error_string;
    var
$current_line;
    var
$current_column;
    var
$data = array();
    var
$datas = array();
   
    function
parse($data)
    {
       
$this->parser = xml_parser_create('UTF-8');
       
xml_set_object($this->parser, $this);
       
xml_parser_set_option($this->parser, XML_OPTION_SKIP_WHITE, 1);
       
xml_set_element_handler($this->parser, 'tag_open', 'tag_close');
       
xml_set_character_data_handler($this->parser, 'cdata');
        if (!
xml_parse($this->parser, $data))
        {
           
$this->data = array();
           
$this->error_code = xml_get_error_code($this->parser);
           
$this->error_string = xml_error_string($this->error_code);
           
$this->current_line = xml_get_current_line_number($this->parser);
           
$this->current_column = xml_get_current_column_number($this->parser);
        }
        else
        {
           
$this->data = $this->data['child'];
        }
       
xml_parser_free($this->parser);
    }

    function
tag_open($parser, $tag, $attribs)
    {
       
$this->data['child'][$tag][] = array('data' => '', 'attribs' => $attribs, 'child' => array());
       
$this->datas[] =& $this->data;
       
$this->data =& $this->data['child'][$tag][count($this->data['child'][$tag])-1];
    }

    function
cdata($parser, $cdata)
    {
       
$this->data['data'] .= $cdata;
    }

    function
tag_close($parser, $tag)
    {
       
$this->data =& $this->datas[count($this->datas)-1];
       
array_pop($this->datas);
    }
}

$xml_parser = new Simple_Parser;
$xml_parser->parse('<foo><bar>test</bar></foo>');

?>
Didier: dlvb ** free * fr
24-Dec-2006 05:53
Hi !

After parsing the XML and modifying it, I just add a method to rebuild the XML form the internal structure (xmlp->document).
The method xmlp->toXML writes into xmlp->XML attributes. Then, you just have to output it.
I hope it helps.

class XMLParser {

var $parser;
var $filePath;
var $document;
var $currTag;
var $tagStack;
var $XML;
var $_tag_to_close = false;
var $TAG_ATTRIBUT = 'attr';
var $TAG_DATA = 'data';

function XMLParser($path) {
    $this->parser = xml_parser_create();
    $this->filePath = $path;
    $this->document = array();
    $this->currTag =& $this->document;
    $this->tagStack = array();
    $this->XML = "";
}

function parse() {
    xml_set_object($this->parser, $this);
    xml_set_character_data_handler($this->parser, 'dataHandler');
    xml_set_element_handler($this->parser, 'startHandler', 'endHandler');

   if(!($fp = fopen($this->filePath, "r"))) {
       die("Cannot open XML data file: $this->filePath");
       return false;
     }

    while($data = fread($fp, 4096)) {
        if(!xml_parse($this->parser, $data, feof($fp))) {
            die(sprintf("XML error: %s at line %d",
                xml_error_string(xml_get_error_code($this->parser)),
             xml_get_current_line_number($this->parser)));
      }
    }

    fclose($fp);
    xml_parser_free($this->parser);

    return true;
}

function startHandler($parser, $name, $attribs) {
     if(!isset($this->currTag[$name]))
          $this->currTag[$name] = array();

     $newTag = array();
     if(!empty($attribs))
          $newTag[$this->TAG_ATTRIBUT] = $attribs;
     array_push($this->currTag[$name], $newTag);

     $t =& $this->currTag[$name];
     $this->currTag =& $t[count($t)-1];
     array_push($this->tagStack, $name);
}

function dataHandler($parser, $data) {
    $data = trim($data);

    if(!empty($data)) {
      if(isset($this->currTag[$this->TAG_DATA]))
            $this->currTag[$this->TAG_DATA] .= $data;
      else
            $this->currTag[$this->TAG_DATA] = $data;
    }
}

function endHandler($parser, $name) {
     $this->currTag =& $this->document;
     array_pop($this->tagStack);

     for($i = 0; $i < count($this->tagStack); $i++) {
          $t =& $this->currTag[$this->tagStack[$i]];
          $this->currTag =& $t[count($t)-1];
     }
}

function clearOutput () {
    $this->XML = "";
}

function openTag ($tag) {
    $this->XML.="<".strtolower ($tag);
    $this->_tag_to_close = true;
}

function closeTag () {
    if ($this->_tag_to_close) {
        $this->XML.=">";
        $this->_tag_to_close = false;
    }
}

function closingTag ($tag) {
    $this->XML.="</".strtolower ($tag).">";
}

function output_attributes ($contenu_fils) {
    foreach ($contenu_fils[$this->TAG_ATTRIBUT] as $nomAttribut => $valeur) {
        $this->XML.= " ".strtolower($nomAttribut)."=\"".$valeur."\"";
    }
}

function addData ($texte) {
// to be completed
    $ca  = array ("é", "è", "ê", "à");
    $par = array ("&eacute;", "&egrave;", "&ecirc;", "agrave;");
    return htmlspecialchars(str_replace ($ca, $par, $texte), ENT_NOQUOTES);
}

function toXML ($tags="") {
    if ($tags=="") {
        $tags = $this->document;
      $this->clearOutput ();
    }

    foreach ($tags as $tag => $contenu) {
        $this->process ($tag, $contenu);
    }
}

function process ($tag, $contenu) {
     // Pour tous les TAGs
    foreach ($contenu as $indice => $contenu_fils) {
         $this->openTag ($tag);

         // Pour tous les fils (non attribut et non data)
         foreach ($contenu_fils as $tagFils => $fils) {
             switch ($tagFils) {
                 case $this->TAG_ATTRIBUT:
                         $this->output_attributes ($contenu_fils);
                        $this->closeTag ();
                         break;
                 case $this->TAG_DATA:
                        $this->closeTag ();
                         $this->XML.= $this->addData ($contenu_fils [$this->TAG_DATA]);
                         break;
                 default:
                         $this->closeTag ();
                         $this->process ($tagFils, $fils);
                         break;
             }
         }

        $this->closingTag ($tag);
    }
}

}
dmeekins att gmail doot com
20-Dec-2006 03:02
I reworked some of the code I found posted previously here, mainly so I could access the structure of the parsed xml file by the tags' names. So if I was parsing html that's also valid xml, I could access the page title by $xmlp->document['HTML'][0]['HEAD'][0]['TITLE'][0]['data']. The index after the tag name corresponds to the occurrence of that tag. If there were two <head></head> in the same depth, then the second one could get accessed by ['HEAD'][1].

<?php
class XMLParser
{
        var
$parser;
    var
$filePath;
    var
$document;
    var
$currTag;
    var
$tagStack;
   
    function
XMLParser($path)
    {
       
$this->parser = xml_parser_create();
   
$this->filePath = $path;
   
$this->document = array();
   
$this->currTag =& $this->document;
   
$this->tagStack = array();
    }
   
    function
parse()
    {
       
xml_set_object($this->parser, $this);
       
xml_set_character_data_handler($this->parser, 'dataHandler');
       
xml_set_element_handler($this->parser, 'startHandler', 'endHandler');
       
    if(!(
$fp = fopen($this->filePath, "r")))
        {
            die(
"Cannot open XML data file: $this->filePath");
            return
false;
        }
   
        while(
$data = fread($fp, 4096))
        {
            if(!
xml_parse($this->parser, $data, feof($fp)))
            {
                die(
sprintf("XML error: %s at line %d",
                           
xml_error_string(xml_get_error_code($this->parser)),
                           
xml_get_current_line_number($this->parser)));
            }
        }
   
       
fclose($fp);
   
xml_parser_free($this->parser);
   
        return
true;
    }
   
    function
startHandler($parser, $name, $attribs)
    {
        if(!isset(
$this->currTag[$name]))
           
$this->currTag[$name] = array();
       
       
$newTag = array();
        if(!empty(
$attribs))
           
$newTag['attr'] = $attribs;
       
array_push($this->currTag[$name], $newTag);
       
       
$t =& $this->currTag[$name];
       
$this->currTag =& $t[count($t)-1];
       
array_push($this->tagStack, $name);
    }
   
    function
dataHandler($parser, $data)
    {
       
$data = trim($data);
       
        if(!empty(
$data))
        {
            if(isset(
$this->currTag['data']))
               
$this->currTag['data'] .= $data;
            else
               
$this->currTag['data'] = $data;
        }
    }
   
    function
endHandler($parser, $name)
    {
       
$this->currTag =& $this->document;
       
array_pop($this->tagStack);
       
        for(
$i = 0; $i < count($this->tagStack); $i++)
        {
           
$t =& $this->currTag[$this->tagStack[$i]];
           
$this->currTag =& $t[count($t)-1];
        }
    }
}
?>
vavricek at volny dot cz
18-Dec-2006 07:53
RE: forquan (29-Jan-2006 12:45)

Thanks, for your code (it was what I need), but ... it didn't works with my XML file. I think that you tested it on simple XML. Never mind.
I change few lines (problem was in endHandler function), and now it WORKS :-)

<?php
 $p
=& new xmlParser();
 
$p->parse("/* XML file*/");
 echo
"<pre>";
 
print_r($p->output);
 echo
"</pre>";

class
xmlParser{
   var
$xml_obj = null;
   var
$output = array();
   var
$attrs;

   function
xmlParser(){
      
$this->xml_obj = xml_parser_create();
      
xml_set_object($this->xml_obj,$this);
      
xml_set_character_data_handler($this->xml_obj, 'dataHandler');
      
xml_set_element_handler($this->xml_obj, "startHandler", "endHandler");
   }

   function
parse($path){
       if (!(
$fp = fopen($path, "r"))) {
           die(
"Cannot open XML data file: $path");
           return
false;
       }

       while (
$data = fread($fp, 4096)) {
           if (!
xml_parse($this->xml_obj, $data, feof($fp))) {
               die(
sprintf("XML error: %s at line %d",
              
xml_error_string(xml_get_error_code($this->xml_obj)),
              
xml_get_current_line_number($this->xml_obj)));
              
xml_parser_free($this->xml_obj);
           }
       }

       return
true;
   }

   function
startHandler($parser, $name, $attribs){
       
$_content = array();
       
$_content['name'] = $name;
        if(!empty(
$attribs))
           
$_content['attrs'] = $attribs;
       
array_push($this->output, $_content);
}

   function
dataHandler($parser, $data){
        if(!empty(
$data) && $data!="\n") {
           
$_output_idx = count($this->output) - 1;
           
$this->output[$_output_idx]['content'] .= $data;
        }
   }

   function
endHandler($parser, $name){
        if(
count($this->output) > 1) {
           
$_data = array_pop($this->output);
           
$_output_idx = count($this->output) - 1;
           
$add = array();
            if(!
$this->output[$_output_idx]['child'])
               
$this->output[$_output_idx]['child'] = array();
           
array_push($this->output[$_output_idx]['child'], $_data);
        }  
   }
}
?>
sasha at goldnet dot ca
15-Dec-2006 11:55
Re: hutch at midwales dot com

That function looks like major overkill.

To remove all white space between tags you could simply do:
preg_replace (">/\s+</" , "><" , $string);
hutch at midwales dot com
01-Oct-2006 04:26
First off, I'd like thank all and sundry for providing this excellent resource, it has been very helpful in getting my head around xml parsing.

I was recently handed the task of collecting a variety of xml streams, from many different sources and of widely varying quality.

If have found that the following function helped parsing the input by cleaning it up. It removes all leading and trailing whitespace and removes carriage returns and linefeeds.

Using this function before using xml_parser_create() has helped reduce a number of otherwise unexplainable anomalies, such as arbitrary cutoff of data or the data being divided into two, requiring concatenation. Data longer than 1024 characters still has to be concatenated, but I can live with that.

<?php
// remove whitespace and linefeeds and returns the name of a temporary file
// takes the name of an existing file as a parameter
function cleanxmlfile($file, $tmpdir="/tmp", $prefix="xxx_") {
   
$tmp = file_get_contents ($file);
   
$tmp = preg_replace("/^\s+/m","",$tmp);
   
$tmp = preg_replace("/\s+$/m","",$tmp);
   
$tmp = preg_replace("/\r/","",$tmp);
   
$tmp = preg_replace("/\n/","",$tmp);
   
$tmpfname = tempnam($tmpdir, $prefix);
   
$handle = fopen($tmpfname, "w");
   
fwrite($handle, "$tmp");
   
fclose($handle);
    return(
$tmpfname);
}
?>

HTH
forquan
28-Jan-2006 11:45
Here's code that will create an associative array from an xml file.  Keys are the tag data and subarrays are formed from attributes and child tags

<?php
$p
=& new xmlParser();
$p->parse('/*xml file*/');
print_r($p->output);
?>

<?php
class xmlParser{
   var
$xml_obj = null;
   var
$output = array();
   var
$attrs;

   function
xmlParser(){
      
$this->xml_obj = xml_parser_create();
      
xml_set_object($this->xml_obj,$this);
      
xml_set_character_data_handler($this->xml_obj, 'dataHandler');
      
xml_set_element_handler($this->xml_obj, "startHandler", "endHandler");
   }

   function
parse($path){
       if (!(
$fp = fopen($path, "r"))) {
           die(
"Cannot open XML data file: $path");
           return
false;
       }

       while (
$data = fread($fp, 4096)) {
           if (!
xml_parse($this->xml_obj, $data, feof($fp))) {
               die(
sprintf("XML error: %s at line %d",
              
xml_error_string(xml_get_error_code($this->xml_obj)),
              
xml_get_current_line_number($this->xml_obj)));
              
xml_parser_free($this->xml_obj);
           }
       }

       return
true;
   }

   function
startHandler($parser, $name, $attribs){
      
$_content = array();
       if(!empty(
$attribs))
        
$_content['attrs'] = $attribs;
      
array_push($this->output, $_content);
   }

   function
dataHandler($parser, $data){
       if(!empty(
$data) && $data!="\n") {
          
$_output_idx = count($this->output) - 1;
          
$this->output[$_output_idx]['content'] .= $data;
       }
   }

   function
endHandler($parser, $name){
       if(
count($this->output) > 1) {
          
$_data = array_pop($this->output);
          
$_output_idx = count($this->output) - 1;
          
$add = array();
           if (
$_data['attrs'])
               
$add['attrs'] = $_data['attrs'];
           if (
$_data['child'])
               
$add['child'] = $_data['child'];
          
$this->output[$_output_idx]['child'][$_data['content']] = $add;
       }    
   }
}
?>
Greg S
17-Nov-2005 04:56
If you need utf8_encode support and configure PHP with --disable-all you will have some trouble. Unfortunately the configure options aren't completely documented. If you need utf8 functions and have everything disabled just recompile PHP with --enable-xml and you should be good to go.
simonguada at yahoo dot fr
06-Apr-2005 09:31
to import xml into mysql

$file = "article_2_3032005467.xml";
$feed = array();
$key = "";
$info = "";

function startElement($xml_parser,  $attrs ) {
  global $feed;
   }

function endElement($xml_parser, $name) {
  global $feed,  $info;
   $key = $name;
  $feed[$key] = $info;
  $info = ""; }

function charData($xml_parser, $data ) {
  global $info;
  $info .= $data; }

$xml_parser = xml_parser_create();
xml_set_element_handler($xml_parser, "startElement", "endElement");
xml_set_character_data_handler($xml_parser, "charData" );
$fp = fopen($file, "r");
while ($data = fread($fp, 8192))
!xml_parse($xml_parser, $data, feof($fp));
xml_parser_free($xml_parser);

$sql= "INSERT INTO `article` ( `";
$j=0;
$i=count($feed);
foreach( $feed as $assoc_index => $value )
  {
  $j++;
  $sql.= strtolower($assoc_index);
  if($i>$j) $sql.= "` , `";
  if($i<=$j) {$sql.= "` ) VALUES ('";}
  }
 $h=0;
foreach( $feed as $assoc_index => $value )
  {
  $h++;
  $sql.= utf8_decode(trim(addslashes($value)));
  if($i-1>$h) $sql.= "', '";
  if($i<=$h) $sql.= "','')";
  }
  $sql=trim($sql);
  echo $sql;
compu_global_hyper_mega_net_2 at yahoo dot com
19-Sep-2004 08:35
The documentation regarding white space was never complete I think.

The XML_OPTION_SKIP_WHITE doesn't appear to do anything.  I want to preserve the newlines in a cdata section.  Setting XML_OPTION_SKIP_WHITE to 0 or false doesn't appear to help.  My character_data_handler is getting called once for each line.  This obviously should be reflected in the documentation as well.  When/how often does the handler get called exactly?  Having to build separate test cases is very time consuming.

Inserting newlines myself in my cdata handler is no good either.  For non actual CDATA sections that cause my handler to get called, long lines are split up in multiple calls.  My handler would not be able to tell the difference whether or not the subsequent calls would be due to the fact that the data is coming from the next line or the fact that some internal buffer is long enough for it to 'flush' out and call the handler.
This behaviour also needs to be properly documented.
odders
19-Mar-2004 06:36
I wrote a simple xml parser mainly to deal with rss version 2. I found lots of examples on the net, but they were all masive and bloated and hard to manipulate.

Output is sent to an array, which holds arrays containg data for each item.

Obviously, you will have to make modifications to the code to suit your needs, but there isnt a lot of code there, so that shouldnt be a problem.

<?php

   $currentElements
= array();
  
$newsArray = array();

  
readXml("./news.xml");

   echo(
"<pre>");
  
print_r($newsArray);
   echo(
"</pre>");

  
// Reads XML file into formatted html
  
function readXML($xmlFile)
   {

     
$xmlParser = xml_parser_create();

     
xml_parser_set_option($xmlParser, XML_OPTION_CASE_FOLDING, false);
     
xml_set_element_handler($xmlParser, startElement, endElement);
     
xml_set_character_data_handler($xmlParser, characterData);

     
$fp = fopen($xmlFile, "r");

      while(
$data = fread($fp, filesize($xmlFile))){
        
xml_parse($xmlParser, $data, feof($fp));}

     
xml_parser_free($xmlParser);

   }

  
// Sets the current XML element, and pushes itself onto the element hierarchy
  
function startElement($parser, $name, $attrs)
   {

      global
$currentElements, $itemCount;

     
array_push($currentElements, $name);

      if(
$name == "item"){$itemCount += 1;}

   }

  
// Prints XML data; finds highlights and links
  
function characterData($parser, $data)
   {

      global
$currentElements, $newsArray, $itemCount;

     
$currentCount = count($currentElements);
     
$parentElement = $currentElements[$currentCount-2];
     
$thisElement = $currentElements[$currentCount-1];

      if(
$parentElement == "item"){
        
$newsArray[$itemCount-1][$thisElement] = $data;}
      else{
         switch(
$name){
            case
"title":
               break;
            case
"link":
               break;
            case
"description":
               break;
            case
"language":
               break;
            case
"item":
               break;}}

   }

  
// If the XML element has ended, it is poped off the hierarchy
  
function endElement($parser, $name)
   {

      global
$currentElements;

     
$currentCount = count($currentElements);
      if(
$currentElements[$currentCount-1] == $name){
        
array_pop($currentElements);}

   }

?>
talraith at withouthonor dot com
03-Feb-2004 10:27
I have created a class set that both parses XML into an object structure and from that structure creates XML code.  It is mostly finished but I thought I would post here as it may help someone out or if someone wants to use it as a base for their own parser.  The method for creating the object is original compared to the posts before this one.

The object tree is created by created seperate tag objects for each tag inside the main document object and associating them together by way of object references.  An index table is created so that each tag is assigned an ID number (in numerical order from 0) and can be accessed directly using that ID number.  Each tag has object references to its children.  There are no uses of eval() in this code.

The code is too long to post here, so I have made a HTML page that has it:  http://www.withouthonor.com/obj_xml.html

Sample code would look something like this:

<?

$xml = new xml_doc($my_xml_code);
$xml->parse();

$root_tag =& $xml->xml_index[0];
$children =& $root_tag->children;

// and so forth

// To create XML code using the object, would be similar to this:

$my_xml = new xml_doc();

$root_tag = $my_xml->CreateTag('ROOTTAG');
$my_xml->CreateTag('CHILDTAG',array(),'',$root_tag);

// The following is used for the CreateTag() method
// string Name (The name of the child tag)
// array Attributes (associative array of attributes for tag)
// string Content (textual data for the child tag)
// int ParentID (Index number for parent tag)

// To generate the XML, use the following method

$out_xml = $my_xml->generate();

?>
bradparks at bradparks dot com
17-Dec-2003 10:38
Hey;

If you need to parse XML on an older version of PHP (e.g. 4.0) or if you can't get the expat extension enabled on your server, you might want to check out the Saxy and DOMIT! xml parsers from Engage Interactive. They're opensource and pure php, so no extensions or changes to your server are required. I've been using them for over a month on some projects with no problems whatsoever!

Check em out at:

DOMIT!, a DOM based xml parser, uses Saxy (included)
http://www.engageinteractive.com/redir.php?resource=1&target=domit

or

Saxy, a sax based xml parser
http://www.engageinteractive.com/redir.php?resource=2&target=saxy

Brad
chris at hitcatcher dot com
07-Nov-2003 10:48
In regards to jon at gettys dot org's XML object, The data should be TRIM()ed to remove any whitespace that could appear in CDATA entered as :

<xml_tag>
    cdata here. cdata here. cdata here. cdata here.
</xml_tag>

So, after applying fred at barron dot com's suggested change to the characterData function, the function should appear as:

function characterData($parser, $data)
{
    global $obj;
    $data = addslashes($data);
    eval($obj->tree."->data.='".trim($data)."';");
}

SIDE NOTE: I'm fairly new to XML so perhaps it is considered bad form to enter CDATA as I did in my example. Is this true or is the extra whitespace for the sake of readablity acceptable?
ml at csite dot com
02-Jul-2003 03:29
A fix for the fread breaking thing:

while ($data = fread($fp, 4096)) {

    $data = $cache . $data;

    if (!feof($fp)) {
        if (preg_match_all("(</?[a-z0-9A-Z]+>)", $data, $regs)) {
            $lastTagname = $regs[0][count($regs[0])-1];
            $split = false;
            for ($i=strlen($data)-strlen($lastTagname); $i>=strlen($lastTagname); $i--) {
                if ($lastTagname == substr($data, $i, strlen($lastTagname))) {
                    $cache = substr($data, $i, strlen($data));
                    $data = substr($data, 0, $i);
                    $split = true;
                    break;
                }
            }
        }
        if (!$split) {
            $cache = $data;
        }
    }

    if (!xml_parse($xml_parser, $data, feof($fp))) {
        die(sprintf("XML error: %s at line %d", xml_error_string(xml_get_error_code($xml_parser)), xml_get_current_line_number($xml_parser)));
    }
}
panania at 3ringwebs dot com
20-May-2003 10:12
The above example doesn't work when you're parsing a string being returned from a curl operation (why I don't know!) I kept getting undefined offsets at the highest element number in both the start and end element functions. It wasn't the string itself I know, because I substringed it to death with the same results. But I fixed the problem by adding these lines of code...

function defaultHandler($parser, $name) {
    global $depth;
@    $depth[$parser]--;
}

xml_set_default_handler($xml_parser, "defaultHandler");

Hope this helps 8-}
fred at barron dot com
23-Apr-2003 12:28
regarding jon at gettys dot org's nice XML to Object code, I've made some useful changes (IMHO) to the characterData function... my minor modifications allow multiple lines of data and it escapes quotes so errors don't occur in the eval...

function characterData($parser, $data)
{
    global $obj;
    $data = addslashes($data);
    eval($obj->tree."->data.='".$data."';");
}
software at serv-a-com dot com
17-Feb-2003 05:10
2. Pre Parser Strings and New Line Delimited Data
One important thing to note at this point is that the xml_parse function requires a string variable. You can manipulate the content of any string variable easily as we all know.

A better approach to removing newlines than:
while ($data = fread($fp, 4096)) {
$data = preg_replace("/\n|\r/","",$data); //flarp
if (!xml_parse($xml_parser, $data, feof($fp))) {...

Above works across all 3 line-delimited text files  (\n, \r, \r\n). But this could potentially (or will most likely) damage or scramble data contained in for example CDATA areas. As far as I am concerned end of line characters should not be used _within_ XML tags. What seems to be the ultimate solution is to pre-parse the loaded data this would require checking the position within the XML document and adding or subtracting (using a in-between fread temporary variable) data based on conditions like: "Is within tag", "Is within CDATA" etc. before fedding it to the parser. This of course opens up a new can of worms (as in parse data for the parser...). (above procedure would take place between fread and xml_parser calls this method would be compatible with the general usage examples on top of the page)

3. The Answer to parsing arbitrary XML and Preprocessor Revisited
You can't just feed any XML document to the parser you constructed and assuming that it will work! You have to know what kind of methods for storing data are used, for example is there a end of line delimited data in the  file ?, Are there any carriage returns in the tags etc... XML files come formatted in different ways some are just a one long string of characters with out any end of line markers others have newlines, carriage returns or both (Microsloth Windows). May or may not contain space and other whitespace between tags. For this reason it is important to what I call Normalize the data before feeding it to the parser. You can perform this with regular expressions or plain old str_replace and concatenation. In many cases this can be done to the file it self sometimes to string data on the fly( as shown in the example above). But I feel it is important to normalize the data before even calling the function to call xml_parse. If you have the ability to access all data before that call you can convert it to what you fell the data should have been in the first place and omit many surprises and expensive regular expression substitution (in a tight spot) while fread'ing the data.
software at serv-a-com dot com
17-Feb-2003 05:09
My previous XML post (software at serv-a-com dot com/22-Jan-2003 03:08) resulted in some of the visitors e-mailg me on the carriage return stripping issue with questions. I'll try to make the following mumble as brief and easy to understand as possible.

1. Overview of the 4096 fragmentation issue
As you know the following freads the file 4096 bytes at a time (that is 4KB) this is perhaps ok for testing expat and figuring out how things work, but it it rather dangerous in the production environment. Data may not be fully understandable due to fread fragmentation and improperly formatted due to numerous sources(formats) of data contained within (i.e. end of line delimited CDATA).

while ($data = fread($fp, 4096)) {
if (!xml_parse($xml_parser, $data, feof($fp))) {

Sometimes to save time one may want to load it all up into a one big variable and leave all the worries to expat. I think anything under 500 KB is ok (as long as nobody knows about it). Some may argue that larger variables are acceptable or even necessary because of the magic that take place while parsing using xml_parse. Our XML parser(expat) works and can be successfully implemented only when we know what type of XML data we are dealing with, it's average size and structure of general layout and data contained within tags. For example if the tags are followed by a line delimiter like a new line we can read it with fgets in and with minimal effort make sure that no data will be sent to the function that does not end with a end tag. But this require a fair knowledge of the file's preference for storing XML data and tags (and a bit of code between reading data and xml_parse'ing it).
software at serv-a-com dot com
22-Jan-2003 10:08
use:
while ($data = str_replace("\n","",fread($fp, 4096))){

instead of:
while ($data = fread($fp, 4096)) {
It will save you a headache.

and in response to (simen at bleed dot no 11-Jan-2003 04:27) "If the 4096 byte buffer fills up..."
Please take better care of your data don't just shove it in to the xml_parse() check and make sure that the tags are not sliced the middle, use a temporary variable between fread and xml_parse.
simen at bleed dot no
11-Jan-2003 11:27
I was experiencing really wierd behaviour loading a large XML document (91k) since the buffer of 4096, when reading the file actually doesn't take into consideration the following:

<node>this is my value</node>

If the 4096 byte buffer fills up at "my", you will get a split string into your xml_set_character_data_handler().

The only solution I've found so far is to read the whole document into a variable and then parse.
sfaulkner at hoovers dot com
04-Nov-2002 08:29
Building on... This allows you to return the value of an element using an XPath reference.  This code would of course need error handling added :-)

 function GetElementByName ($xml, $start, $end) {
   $startpos = strpos($xml, $start);
   if ($startpos === false) {
     return false;
   }
   $endpos = strpos($xml, $end);
   $endpos = $endpos+strlen($end);   
   $endpos = $endpos-$startpos;
   $endpos = $endpos - strlen($end);
   $tag = substr ($xml, $startpos, $endpos);
   $tag = substr ($tag, strlen($start));
   return $tag;
 }
 
 function XPathValue($XPath,$XML) {
   $XPathArray = explode("/",$XPath);
   $node = $XML;
   while (list($key,$value) = each($XPathArray)) {
     $node = GetElementByName($node, "<$value>", "</$value>");
   }
  
   return $node;
 }
 
  print XPathValue("Response/Shipment/TotalCharges/Value",$xml);
guy at bhaktiandvedanta dot com
27-Sep-2002 07:01
For a simple XML parser you can use this function. It doesn't require any extensions to run.

<?
// Extracts content from XML tag

function GetElementByName ($xml, $start, $end) {

    global $pos;
    $startpos = strpos($xml, $start);
    if ($startpos === false) {
        return false;
    }
    $endpos = strpos($xml, $end);
    $endpos = $endpos+strlen($end);   
    $pos = $endpos;
    $endpos = $endpos-$startpos;
    $endpos = $endpos - strlen($end);
    $tag = substr ($xml, $startpos, $endpos);
    $tag = substr ($tag, strlen($start));

    return $tag;

}

// Open and read xml file. You can replace this with your xml data.

$file = "data.xml";
$pos = 0;
$Nodes = array();

if (!($fp = fopen($file, "r"))) {
    die("could not open XML input");
}
while ($getline = fread($fp, 4096)) {
    $data = $data . $getline;
}

$count = 0;
$pos = 0;

// Goes throw XML file and creates an array of all <XML_TAG> tags.
while ($node = GetElementByName($data, "<XML_TAG>", "</XML_TAG>")) {
    $Nodes[$count] = $node;
    $count++;
    $data = substr($data, $pos);
}

// Gets infomation from tag siblings.
for ($i=0; $i<$count; $i++) {
$code = GetElementByName($Nodes[$i], "<Code>", "</Code>");
$desc = GetElementByName($Nodes[$i], "<Description>", "</Description>");
$price = GetElementByName($Nodes[$i], "<BasePrice>", "</BasePrice>");
}
?>

Hope this helps! :)
Guy Laor
dmarsh dot NO dot SPAM dot PLEASE at spscc dot ctc dot edu
18-Sep-2002 07:27
Some reference code I am working on as "XML Library" of which I am folding it info an object. Notice the use of the DEFINE:

Mainly Example 1 and parts of 2 & 3 re-written as an object:
--- MyXMLWalk.lib.php ---
<?php

if (!defined("PHPXMLWalk")) {
define("PHPXMLWalk",TRUE);

class
XMLWalk {
 var
$p; //short for xml parser;
 
var $e; //short for element stack/array

 
function prl($x,$i=0) {
   
ob_start();
   
print_r($x);
   
$buf=ob_get_contents();
   
ob_end_clean();
    return
join("\n".str_repeat(" ",$i),split("\n",$buf));
  }

 function
XMLWalk() {
 
$this->p = xml_parser_create();
 
$this->e = array();
 
xml_parser_set_option($this->p, XML_OPTION_CASE_FOLDING, true);
 
xml_set_element_handler($this->p, array(&$this, "startElement"), array(&$this, "endElement"));
 
xml_set_character_data_handler($this->p, array(&$this, "dataElement"));
 
register_shutdown_function(array(&$this, "free")); // make a destructor
 
}

  function
startElement($parser, $name, $attrs) {
    if (
count($attrs)>=1) {
     
$x = $this->prl($attrs, $this->e[$parser]+6);
    } else {
     
$x = "";
    }

    print
str_repeat(" ",$this->e[$parser]+0). "$name $x\n";
   
$this->e[$parser]++;
   
$this->e[$parser]++;
  }

  function
dataElement($parser, $data) {
    print
str_repeat(" ",$this->e[$parser]+0). htmlspecialchars($data, ENT_QUOTES) ."\n";
  }

  function
endElement($parser, $name) {
   
$this->e[$parser]--;
   
$this->e[$parser]--;
  }
  function
parse($data, $fp) {
    if (!
xml_parse($this->p, $data, feof($fp))) {
        die(
sprintf("XML error: %s at line %d",
                   
xml_error_string(xml_get_error_code($this->p)),
                   
xml_get_current_line_number($this->p)));
    }
  }

  function
free() {
   
xml_parser_free($this->p);
  }

}
// end of class

} // end of define

?>

--- end of file ---

Calling code:
<?php

...

require(
"MyXMLWalk.lib.php");

$file = "x.xml";

$xme = new XMLWalk;

if (!(
$fp = fopen($file, "r"))) {
    die(
"could not open XML input");
}

while (
$data = fread($fp, 4096)) {
 
$xme->parse($data, $fp);
}

...
?>
jon at gettys dot org
14-Aug-2002 08:59
[Editor's note: see also xml_parse_into_struct().]

Very simple routine to convert an XML file into a PHP structure. $obj->xml contains the resulting PHP structure. I would be interested if someone could suggest a cleaner method than the evals I am using.

<?
$filename = 'sample.xml';
$obj->tree = '$obj->xml';
$obj->xml = '';

function startElement($parser, $name, $attrs) {
    global $obj;
   
    // If var already defined, make array
    eval('$test=isset('.$obj->tree.'->'.$name.');');
    if ($test) {
      eval('$tmp='.$obj->tree.'->'.$name.';');
      eval('$arr=is_array('.$obj->tree.'->'.$name.');');
      if (!$arr) {
        eval('unset('.$obj->tree.'->'.$name.');');
        eval($obj->tree.'->'.$name.'[0]=$tmp;');
        $cnt = 1;
      }
      else {
        eval('$cnt=count('.$obj->tree.'->'.$name.');');
      }
     
      $obj->tree .= '->'.$name."[$cnt]";
    }
    else {
      $obj->tree .= '->'.$name;
    }
    if (count($attrs)) {
        eval($obj->tree.'->attr=$attrs;');
    }
}

function endElement($parser, $name) {
    global $obj;
    // Strip off last ->
    for($a=strlen($obj->tree);$a>0;$a--) {
        if (substr($obj->tree, $a, 2) == '->') {
            $obj->tree = substr($obj->tree, 0, $a);
            break;
        }
    }
}

function characterData($parser, $data) {
    global $obj;

    eval($obj->tree.'->data=\''.$data.'\';');
}

$xml_parser = xml_parser_create();
xml_set_element_handler($xml_parser, "startElement", "endElement");
xml_set_character_data_handler($xml_parser, "characterData");
if (!($fp = fopen($filename, "r"))) {
    die("could not open XML input");
}

while ($data = fread($fp, 4096)) {
    if (!xml_parse($xml_parser, $data, feof($fp))) {
        die(sprintf("XML error: %s at line %d",
                    xml_error_string(xml_get_error_code($xml_parser)),
                    xml_get_current_line_number($xml_parser)));
    }
}
xml_parser_free($xml_parser);
print_r($obj->xml);
return 0;

?>
danielc at analysisandsolutions dot com
15-Apr-2002 09:23
I put up a good, simple, real world example of how to parse XML documents. While the sample grabs stock quotes off of the web, you can tweak it to do whatever you need.

http://www.analysisandsolutions.com/code/phpxml.htm
jason at N0SPAM dot projectexpanse dot com
22-Mar-2002 09:16
In reference to the note made by sam@cwa.co.nz about parsing entities:

I could be wrong, but since it is possible to define your own entities within an XML DTD, the cdata handler function parses these individually to allow for your own implementation of those entities within your cdata handler.
jason at NOSPAM_projectexpanse_NOSPAM dot com
27-Feb-2002 12:11
For newbies wanting a good tutorial on how to actually get started and where to go from this listing of functions, then visit:
http://www.wirelessdevnet.com/channels/wap/features/xmlcast_php.html

It shows an excellent example of how to read the XML data into a class file so you can actually process it, not just display it all pretty-like, like many tutorials on PHP/XML seem to be doing.
hans dot schneider at bbdo-interone dot de
24-Jan-2002 04:43
I had to TRIM the data when I passed one large String containig a wellformed XML-File to xml_parse. The String was read by CURL, which aparently put a BLANK at the end of the String. This BLANK produced a "XML not wellformed"-Error in xml_parse!
sam at cwa dot co dot nz
28-Sep-2000 02:39
I've discovered some unusual behaviour in this API when ampersand entities are parsed in cdata; for some reason the parser breaks up the section around the entities, and calls the handler repeated times for each of the sections. If you don't allow for this oddity and you are trying to put the cdata into a variable, only the last part will be stored.

You can get around this with a line like:

$foo .= $cdata;

If the handler is called several times from the same tag, it will append them, rather than rewriting the variable each time. If the entire cdata section is returned, it doesn't matter.

May happen for other entities, but I haven't investigated.

Took me a while to figure out what was happening; hope this saves someone else the trouble.
Daniel dot Rendall at btinternet dot com
07-Jul-1999 05:21
When using the XML parser, make sure you're not using the magic quotes option (e.g. use set_magic_quotes_runtime(0) if it's not the compiled default), otherwise you'll get 'not well-formed' errors when dealing with tags with attributes set in them.

utf8_decode> <XML External Entity Example
Last updated: Fri, 06 Nov 2009
 
 
show source | credits | sitemap | contact | advertising | mirror sites