<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
  <refentry xml:id="function.domdocument-xinclude" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
   <refnamediv>
    <refname>DomDocument->xinclude</refname>
    <refpurpose>
     Substitutes XIncludes in a DomDocument Object
    </refpurpose>
   </refnamediv>
   <refsect1>
    &reftitle.description;
      <methodsynopsis>
      <type>int</type><methodname>DomDocument->xinclude</methodname>
        <void/>
     </methodsynopsis>
    <para>
     This function substitutes <link
     xlink:href="&url.xinclude.spec;">XIncludes</link> in a DomDocument object.
    </para>
    <para>
     <example>
      <title>Substituting Xincludes</title>
      <programlisting role="php">
<![CDATA[
<?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();

?>                 
]]>
      </programlisting>
      &example.outputs;
      <screen role="xml">
<![CDATA[
<?xml version="1.0"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
  <child>test</child>
</root>
]]>
      </screen>
      <para>
       If <filename>include.xml</filename> doesn't exist, you'll see:
      </para>
      <screen role="xml">
<![CDATA[
<?xml version="1.0"?>
<root xmlns:xi="http://www.w3.org/2001/XInclude">
  <error>xinclude:dom.xml not found</error>
</root>
]]>
      </screen>
     </example>
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->