domxml_version

[edit] Last updated: Fri, 18 May 2012

domxml_open_mem

(PHP 4 >= 4.2.0)

domxml_open_mem — Creates a DOM object of an XML document

Description

DomDocument domxml_open_mem ( string $str [, int $mode [, array &$error ]] )

The function parses the XML document in the given string.

Parameters

str

The contents of the XML file.

mode

This optional parameter can be used to change the behavior of this function.

You can use one of the following constants for it: DOMXML_LOAD_PARSING (default), DOMXML_LOAD_VALIDATING or DOMXML_LOAD_RECOVERING. You can add to it also DOMXML_LOAD_DONT_KEEP_BLANKS, DOMXML_LOAD_SUBSTITUTE_ENTITIES and DOMXML_LOAD_COMPLETE_ATTRS by bitwise or.

error

If used, it will contain the error messages. error must be passed in by reference.

Return Values

Returns a DomDocument instance of the given XML contents.

Changelog

Version	Description
4.3.0	The `mode` and `error` parameters were added.

Examples

Example #1 Opening an XML document in a string


<?php
include("example.inc");

if (!$dom = domxml_open_mem($xmlstr)) {
  echo "Error while parsing the document\n";
  exit;
}

$root = $dom->document_element();
?>


It's always nice to see just where in the XML the error is so I've enhanced the error message example above to this:



// Read and parse dynamic PHP/XML document.

ob_start();

require($_REQUEST['page'].'.php');

$xml = ob_get_contents();

ob_end_clean();

$xmldoc = domxml_open_mem("<?xml version='1.0'  encoding='ISO-8859-1'?>".$xml, DOMXML_LOAD_PARSING, $error);

// Show error.

if(!$xmldoc) {

    // Assign each line to array.

    $arXML = explode("\n", $xml);



    echo "<pre>";

            

    foreach ($error as $errorline) {

        echo $errorline['errormessage'].

        "Node: ".$errorline['nodename']."\n".

        "Line: ".$errorline['line']."\n".

        "Column: ".$errorline['col']."\n";



        // Locate actual line number.

        $arErrorMessage = explode(' line ', $errorline['errormessage']);

        $arErrorMessage = explode(' ', $arErrorMessage[1]);

        $errorLineNumber = $arErrorMessage[0];

        

        // Show +/- 10 lines around error.

        $minErrorLineNumber = max(0, $errorLineNumber-10);

        $maxErrorLineNumber = min(sizeof($arXML), $errorLineNumber+10);

        echo "XML snip (linies: ".$minErrorLineNumber." to ".$maxErrorLineNumber."):\n";

        for($n = $minErrorLineNumber; $n < $maxErrorLineNumber; $n++)

            if($n == $errorLineNumber)

                echo "<B>".htmlentities($arXML[$n])."</B>\n";

            else 

                echo htmlentities($arXML[$n])."\n";

        echo "\n\n";

    }



    echo "</pre>";

}



This will actually render +/- 10 lines around the actual error. Hope others will find this usefull aswell.

Lian Yuen Chi <yuenqi at hotmail dot com> 08-Oct-2004 07:40


Regarding the 'magic_quotes_runtime = On' issue in XML parsing, I will suggest using the method below, for those who do not want to turn off the setting in the configuration file.



<?php



$original-magic-quotes-runtime-value = get_magic_quotes_runtime();



set_magic_quotes_runtime(0);



your-xml-parsing-codes();



set_magic_quotes_runtime($original-magic-quotes-runtime-value);



?>

heiko[dot]weber[at]softwareag[dot]com 19-Aug-2004 02:28


Careful, this function will not work with XML documents which are in UTF-16 or UTF-32 encoding and include a BOM at the beginning, so your code will need a special handling for these encodings.

Carl Wurtz 13-Jul-2004 01:01


A recursive function that parses XML into objects:





<?php





    $xmlstg = '<?xml version="1.0"?';


    $xmlstg .= '><candy><anatomically_shaped><head_to_bite_off>chocolate bunnies</head_to_bite_off><headless>gummi worms</headless></anatomically_shaped></candy>';


        


    


    $dom = domxml_open_mem($xmlstg);


    $root = $dom->document_element();


    $root->name = '$candy';


    function parse_node($node) {


        global $candy;


        if ($node->has_child_nodes()) {


            foreach($node->child_nodes() as $n) {


                if ($n->node_name() == '#text') {


                    eval("$node->name=\"" . $n->node_value() . "\";");


                }


                else {


                    $n->name = $node->name . '->' . $n->node_name();


                    parse_node($n);


                }


            }


        }


    }





    parse_node($root);


    echo $candy->anatomically_shaped->head_to_bite_off;


// echos "chocolate bunnies"





?>

voituk [on] asg [dot] kiev [dot] ua 07-Jul-2004 05:48


There is some interesting feature with "magic_quotes_runtime" ini directive and "domxml_open_mem" function.

If we have "magic_quotes_runtime=on" in out php.ini file, this code generates many warning



$xml_str = file_get_contents($xml_file));

$Document = domxml_open_mem($xml_str));



if "magic_quotes_runtime=off" all is good.

ej at campbell *dot* name 30-Nov-2003 07:54


The DOM XML parser does not automatically free memory when a DomDocument goes out of scope.



If you're using the DOM parser to parse several XML files as part of a long running script, you must free the DomDocument manually or a memory leak will occur.



To free a DOM document allocated by domxml_open_mem, do the following:



$doc = domxml_open_mem("$contents");



$doc->free();

chris at schaake dot nu 01-Nov-2003 10:20


Finally figured out the error handling. The sample below will give a nice error message. Should also work for domxml_open_file.



<?

# Small sample xml file with 2 errors

#     1. root tag not closed

#    2. Missing ; in &amp;

$xml = "<root>&amp";



$xmldoc = @domxml_open_mem($xml,DOMXML_LOAD_PARSING,$error);



echo "<pre>";    # Just for nice layout

foreach ($error as $errorline) {    # Loop through all errors

    echo $errorline['errormessage'];

    echo " Node   : " . $errorline['nodename'] . "\n";

    echo " Line   : " . $errorline['line'] . "\n";

    echo " Column : " . $errorline['col'] . "\n\n";

}



?>

jon at hiveminds dot net 16-Oct-2003 10:10


You can also create a new DomDocument instance by calling its constructor:



<?php

  $doc = new DomDocument($xml);

?>



where $xml is any string of well-formed XML.

add a note