dom: Add stubs generated from php-src stubs

language-snippets.ent

@@ -1587,6 +1587,38 @@ it is inserted with (e.g.) <function xmlns="http://docbook.org/ns/docbook">DOMNo
   of the <link linkend="libxml.constants">libxml option constants</link>.
 </para>'>
 
+<!ENTITY dom.errors.hierarchy.parent '<varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><constant>DOM_HIERARCHY_REQUEST_ERR</constant></term>
+  <listitem>
+  <para>
+    Raised if the parent is of a type that does not allow children of the
+    type of one of the passed <parameter>nodes</parameter>, or if the node to
+    put in is one of this node&#39;s ancestors or this node itself.
+  </para>
+ </listitem>
+</varlistentry>'>
+
+<!ENTITY dom.errors.hierarchy.self '<varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><constant>DOM_HIERARCHY_REQUEST_ERR</constant></term>
+  <listitem>
+  <para>
+    Raised if this node is of a type that does not allow children of the
+    type of one of the passed <parameter>nodes</parameter>, or if the node to
+    put in is one of this node&#39;s ancestors or this node itself.
+  </para>
+ </listitem>
+</varlistentry>'>
+
+<!ENTITY dom.errors.wrong_document '<varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>
+  <listitem>
+  <para>
+    Raised if one of the passed <parameter>nodes</parameter> was created from a different
+    document than the one that created this node.
+  </para>
+ </listitem>
+</varlistentry>'>
+
 <!-- FileSystem entities -->
 <!ENTITY fs.emits.warning.on.failure '<para xmlns="http://docbook.org/ns/docbook">
 Upon failure, an <constant>E_WARNING</constant> is emitted.

reference/dom/domcharacterdata/after.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="domcharacterdata.after" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refnamediv>
+  <refname>DOMCharacterData::after</refname>
+  <refpurpose>Adds nodes after the character data</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="DOMCharacterData">
+   <modifier>public</modifier> <type>void</type><methodname>DOMCharacterData::after</methodname>
+   <methodparam rep="repeat"><type class="union"><type>DOMNode</type><type>string</type></type><parameter>nodes</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Adds the passed <parameter>nodes</parameter> after the element.
+  </para>
+ </refsect1>
+
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.after')/db:refsect1[@role='parameters'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.after')/db:refsect1[@role='returnvalues'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.after')/db:refsect1[@role='errors'])" />
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="domcharacterdata.after.example.basic">
+   <title><methodname>DOMCharacterData::after</methodname> example</title>
+   <para>
+    Adds nodes after the character data.
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$doc = new DOMDocument;
+$doc->loadXML("<container><![CDATA[hello]]]]><![CDATA[></container>");
+$cdata = $doc->documentElement->firstChild;
+
+$cdata->after("beautiful", $doc->createElement("world"));
+
+echo $doc->saveXML();
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+<?xml version="1.0"?>
+<container><![CDATA[hello]]]]><![CDATA[>beautiful<world/></container>
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><methodname>DOMChildNode::after</methodname></member>
+   <member><methodname>DOMCharacterData::before</methodname></member>
+  </simplelist>
+ </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
+-->

reference/dom/domcharacterdata/before.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="domcharacterdata.before" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refnamediv>
+  <refname>DOMCharacterData::before</refname>
+  <refpurpose>Adds nodes before the node</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="DOMCharacterData">
+   <modifier>public</modifier> <type>void</type><methodname>DOMCharacterData::before</methodname>
+   <methodparam rep="repeat"><type class="union"><type>DOMNode</type><type>string</type></type><parameter>nodes</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Adds the passed <parameter>nodes</parameter> before the node.
+  </para>
+ </refsect1>
+
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.before')/db:refsect1[@role='parameters'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.before')/db:refsect1[@role='returnvalues'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.before')/db:refsect1[@role='errors'])" />
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="domcharacterdata.before.example.basic">
+   <title><methodname>DOMCharacterData::before</methodname> example</title>
+   <para>
+    Adds nodes before the character data.
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$doc = new DOMDocument;
+$doc->loadXML("<container><![CDATA[world]]]]><![CDATA[></container>");
+$cdata = $doc->documentElement->firstChild;
+
+$cdata->before("hello", $doc->createElement("beautiful"));
+
+echo $doc->saveXML();
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+<?xml version="1.0"?>
+<container>hello<beautiful/><![CDATA[world]]]]><![CDATA[></container>
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><methodname>DOMChildNode::before</methodname></member>
+   <member><methodname>DOMCharacterData::after</methodname></member>
+  </simplelist>
+ </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
+-->

reference/dom/domcharacterdata/remove.xml

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="domcharacterdata.remove" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refnamediv>
+  <refname>DOMCharacterData::remove</refname>
+  <refpurpose>Removes the character data</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="DOMCharacterData">
+   <modifier>public</modifier> <type>void</type><methodname>DOMCharacterData::remove</methodname>
+   <void/>
+  </methodsynopsis>
+  <para>
+   Removes the character data.
+  </para>
+ </refsect1>
+
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.remove')/db:refsect1[@role='parameters'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.remove')/db:refsect1[@role='returnvalues'])" />
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="domcharacterdata.remove.example.basic">
+   <title><methodname>DOMCharacterData::remove</methodname> example</title>
+   <para>
+    Removes the character data.
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$doc = new DOMDocument;
+$doc->loadXML("<container><![CDATA[hello]]]]><![CDATA[><world/></container>");
+$cdata = $doc->documentElement->firstChild;
+
+$cdata->remove();
+
+echo $doc->saveXML();
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+<?xml version="1.0"?>
+<container><world/></container>
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><methodname>DOMChildNode::remove</methodname></member>
+   <member><methodname>DOMCharacterData::after</methodname></member>
+   <member><methodname>DOMCharacterData::before</methodname></member>
+   <member><methodname>DOMCharacterData::replaceWith</methodname></member>
+   <member><methodname>DOMNode::removeChild</methodname></member>
+  </simplelist>
+ </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
+-->

reference/dom/domcharacterdata/replacewith.xml

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xml:id="domcharacterdata.replacewith" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <refnamediv>
+  <refname>DOMCharacterData::replaceWith</refname>
+  <refpurpose>Replaces the character data with new nodes</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis role="DOMCharacterData">
+   <modifier>public</modifier> <type>void</type><methodname>DOMCharacterData::replaceWith</methodname>
+   <methodparam rep="repeat"><type class="union"><type>DOMNode</type><type>string</type></type><parameter>nodes</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Replaces the character data with new <parameter>nodes</parameter>.
+  </para>
+ </refsect1>
+
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.replacewith')/db:refsect1[@role='parameters'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.replacewith')/db:refsect1[@role='returnvalues'])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('domchildnode.replacewith')/db:refsect1[@role='errors'])" />
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="domcharacterdata.replacewith.example.basic">
+   <title><methodname>DOMCharacterData::replaceWith</methodname> example</title>
+   <para>
+    Replaces the character data with new nodes.
+   </para>
+   <programlisting role="php">
+<![CDATA[
+<?php
+$doc = new DOMDocument;
+$doc->loadXML("<container><![CDATA[hello]]]]><![CDATA[></container>");
+$cdata = $doc->documentElement->firstChild;
+
+$cdata->replaceWith("beautiful", $doc->createElement("world"));
+
+echo $doc->saveXML();
+?>
+]]>
+   </programlisting>
+   &example.outputs;
+   <screen>
+<![CDATA[
+<?xml version="1.0"?>
+<container>beautiful<world/></container>
+]]>
+   </screen>
+  </example>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><methodname>DOMChildNode::replaceWith</methodname></member>
+   <member><methodname>DOMCharacterData::after</methodname></member>
+   <member><methodname>DOMCharacterData::before</methodname></member>
+   <member><methodname>DOMCharacterData::remove</methodname></member>
+  </simplelist>
+ </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
+-->

reference/dom/domchildnode/after.xml

@@ -25,6 +25,7 @@
      <listitem>
       <para>
        Nodes to be added after the node.
+       Strings are automatically converted to text nodes.
       </para>
      </listitem>
     </varlistentry>
@@ -39,6 +40,14 @@
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <variablelist>
+   &dom.errors.hierarchy.parent;
+   &dom.errors.wrong_document;
+  </variablelist>
+ </refsect1>
+
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>