mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-03-24 08:52:18 +01:00
d2939d4611
PHP 7.0 requires at least libxml2 2.6.11. So any note about an older version is simply irrelevant. Use an entity to use consistent, more useful wording. This patch also gets rid of some personification.
139 lines
3.5 KiB
XML
139 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="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 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis role="DOMDocument">
|
|
<modifier>public</modifier> <type class="union"><type>int</type><type>false</type></type><methodname>DOMDocument::xinclude</methodname>
|
|
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This method substitutes <link xlink:href="&url.xinclude.spec;">XIncludes</link> in a DOMDocument object.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Due to libxml2 automatically resolving entities, this method will produce
|
|
unexpected results if the included XML file have an attached DTD.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
&dom.parameter.options;
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the number of XIncludes in the document, -1 if some processing failed,
|
|
or &false; if there were no substitutions.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>DOMDocument::xinclude() example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$xml = <<<EOD
|
|
<?xml version="1.0" ?>
|
|
<chapter xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<title>Books of the other guy..</title>
|
|
<para>
|
|
<xi:include href="book.xml">
|
|
<xi:fallback>
|
|
<error>xinclude: book.xml not found</error>
|
|
</xi:fallback>
|
|
</xi:include>
|
|
</para>
|
|
</chapter>
|
|
EOD;
|
|
|
|
$dom = new DOMDocument;
|
|
|
|
// let's have a nice output
|
|
$dom->preserveWhiteSpace = false;
|
|
$dom->formatOutput = true;
|
|
|
|
// load the XML string defined above
|
|
$dom->loadXML($xml);
|
|
|
|
// substitute xincludes
|
|
$dom->xinclude();
|
|
|
|
echo $dom->saveXML();
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs.similar;
|
|
<screen role="xml">
|
|
<![CDATA[
|
|
<?xml version="1.0"?>
|
|
<chapter xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
<title>Books of the other guy..</title>
|
|
<para>
|
|
<row xml:base="/home/didou/book.xml">
|
|
<entry>The Grapes of Wrath</entry>
|
|
<entry>John Steinbeck</entry>
|
|
<entry>en</entry>
|
|
<entry>0140186409</entry>
|
|
</row>
|
|
<row xml:base="/home/didou/book.xml">
|
|
<entry>The Pearl</entry>
|
|
<entry>John Steinbeck</entry>
|
|
<entry>en</entry>
|
|
<entry>014017737X</entry>
|
|
</row>
|
|
<row xml:base="/home/didou/book.xml">
|
|
<entry>Samarcande</entry>
|
|
<entry>Amine Maalouf</entry>
|
|
<entry>fr</entry>
|
|
<entry>2253051209</entry>
|
|
</row>
|
|
</para>
|
|
</chapter>
|
|
]]>
|
|
</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
|
|
-->
|