PHP 5.6.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 4 notes

up
0
peter at softcoded dot com
3 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
4 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
www dot spam at whoah dot net
10 years ago
Tips for anyone trying to use nested <xi:include /> blocks:

- Multiple calls to DOMDocument::xinclude() are required to parse each level of include blocks, you can either call xinclude() a fixed amount of times (enough to cover your needs), or you can check for leftover <xi:include /> blocks after each call to DOMDocument::xinclude() to see if you need to call it again.

- If you are going to use an <xi:include /> block in an included file, you must define the "xi" namespace in the included file where another include block exists, the namespace definition will not carry through from the first xml file

eg.

==========
a.xml (xi definition needed)
----------
<?xml version="1.0"?>
<a xmlns:xi="http://www.w3.org/2001/XInclude">
    <xi:include href="includes/b.xml" />
</a>
==========

==========
b.xml (xi definition needed)
----------
<?xml version="1.0"?>
<b xmlns:xi="http://www.w3.org/2001/XInclude">
    <xi:include href="c.xml" />
</b>
==========

==========
c.xml (xi definition not needed)
----------
<?xml version="1.0"?>
<c>whatever</c>
==========

- Futher to my example above, if you are including an xml file that has another include inside it, the href "base" url will be taken from the 2nd file. In the above example, "c.xml" is actually in the same directory as "b.xml", whereas "a.xml" is in the directory above, but because b is calling c, the "base" directory is seen as "includes/"

Another tip not related to nested xincludes, but simply xinclude stuff in general:

I wanted to turn this...
<a>
    <b />
    <c />
    <d />
    <e />
</a>

...into this...
<a>
    <xi:include file="bcde.xml" />
</a>

...but then bcde.xml would have looked like this...
<b />
<c />
<d />
<e />

...which is not valid xml and was causing an error. So just remember that included files need to be valid and may still only have one root element.

These are from my experiences with PHP5.0.1, I'm not a DOMXML expert at all. Enjoy!
up
0
amm at remasys dot com
10 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