php-doc-en/reference/dom/domnode/insertbefore.xml
2021-01-02 16:32:41 +01:00

129 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domnode.insertbefore" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMNode::insertBefore</refname>
<refpurpose>
Adds a new child before a reference node
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>DOMNode::insertBefore</methodname>
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>DOMNode</type><type>null</type></type><parameter>child</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
This function inserts a new node right before the reference node.
If you plan to do further modifications on the appended child you must use
the returned node.
</para>
<para>
When using an existing node it will be moved.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>node</parameter></term>
<listitem>
<para>
The new node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>child</parameter></term>
<listitem>
<para>
The reference node. If not supplied, <parameter>node</parameter> is
appended to the children.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The inserted node.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_NO_MODIFICATION_ALLOWED_ERR</constant></term>
<listitem>
<para>
Raised if this node is readonly or if the previous parent of the node
being inserted is readonly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<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 the <parameter>node</parameter> node, or if the node to
append is one of this node's ancestors or this node itself.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>
<listitem>
<para>
Raised if <parameter>node</parameter> was created from a different
document than the one that created this node.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>DOM_NOT_FOUND</constant></term>
<listitem>
<para>
Raised if <parameter>child</parameter> is not a child of this node.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMNode::appendChild</methodname></member>
</simplelist>
</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
-->