PHP 7.1.0 Released

DomDocument->xinclude

(PHP 5)

DomDocument->xinclude Substitutes XIncludes in a DomDocument Object

Description

int DomDocument->xinclude ( void )

This function substitutes » XIncludes in a DomDocument object.

Example #1 Substituting Xincludes

<?php

// include.xml contains :
// <child>test</child> 

$xml '<?xml version="1.0"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
  <xi:include href="include.xml">
    <xi:fallback>
      <error>xinclude: include.xml not found</error>
    </xi:fallback>
  </xi:include>
</root>'
;

$domxml domxml_open_mem($xml);
$domxml->xinclude();

echo 
$domxml->dump_mem();

?>

The above example will output:

<?xml version="1.0"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
  <child>test</child>
</root>

If include.xml doesn't exist, you'll see:

<?xml version="1.0"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
  <error>xinclude:dom.xml not found</error>
</root>

add a note add a note

User Contributed Notes 3 notes

up
0
peter at softcoded dot com
5 years ago
The xinclude method is defined as: int DomDocument->xinclude ( void ). However you can pass options to this method. If your xincluded file contains entities, these entities will not be resolved simply by setting the substituteEntities property of the DomDocument to "true". You must pass in options to the xinclude function. For example:

<?php
$doc
= new DOMDocument();
//doc has entities, substitute them
$doc->substituteEntities = true;
$source = "/path/to/file.xml";
$doc->load($source);
//do this to resolve entities in an xincluded file
$options = LIBXML_NOENT;
$doc->xinclude($options);
...
?>
up
0
collin at paperclipped dot com
6 years ago
I had to do things a bit differently to use xincludes (also following the example above only included a part of the XML):

<?php
$xml
= '<?xml version="1.0" encoding="utf-8"?>
<site xmlns:xi="http://www.w3.org/2001/XInclude">
    <xi:include href="home.xml#xpointer(/site/*)">
        <xi:fallback>
            <error>Error: home.xml not found or invalid!</error>
        </xi:fallback>
    </xi:include>
    <xi:include href="services.xml#xpointer(/site/*)">
        <xi:fallback>
            <error>Error: services.xml not found or invalid!</error>
        </xi:fallback>
    </xi:include>
    <xi:include href="about.xml#xpointer(/site/*)">
        <xi:fallback>
            <error>Error: about.xml not found or invalid!</error>
        </xi:fallback>
    </xi:include>
    <xi:include href="contact.xml#xpointer(/site/*)">
        <xi:fallback>
            <error>Error: contact.xml not found or invalid!</error>
        </xi:fallback>
    </xi:include>
</site>'
;

$xmlDoc = new DOMDocument();
$xmlDoc->loadXML($xml);
$xmlDoc->xinclude();

echo
$xmlDoc->saveXML();
?>
up
0
amm at remasys dot com
12 years ago
xml Include using xpointer to include specific part of another xml doc

Main xml file (or string):
<?xml version="1.0" encoding="utf-8"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
   <optional>
      <xi:include href="include.xml#xpointer(/parts/*)" parse="xml">
         <xi:fallback>
            <error>Error.</error>
         </xi:fallback>
      </xi:include>
   </optional>
   <blah>blah</blah>
   <blah>blah</blah>
</root>

Include.xml file (or string:
<?xml version="1.0" encoding="utf-8"?>
<parts>
   <part>part one</part>
   <part>part two</part>
   <part>part three</part>
</parts>

href="include.xml#xpointer(/parts/*)"
will include all <part> tags but NOT <parts>

href="include.xml#xpointer(/parts/part[1])"
will include <part>part one</part>

simple but very usefull.
To Top