reference/dom/domnode/appendchild.xml
bc83b0a2f223a5ca9daaf22bd82215791bccde31
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xml:id='domnode.appendchild' xmlns="http://docbook.org/ns/docbook">
3
+
<refentry xml:id="domnode.appendchild" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>DOMNode::appendChild</refname>
6
6
<refpurpose>
...
...
@@ -9,9 +9,9 @@
9
9
</refnamediv>
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
-
<methodsynopsis>
13
-
<modifier>public</modifier> <type>DOMNode</type><methodname>DOMNode::appendChild</methodname>
14
-
<methodparam><type>DOMNode</type><parameter>newnode</parameter></methodparam>
12
+
<methodsynopsis role="DOMNode">
13
+
<modifier>public</modifier> <type class="union"><type>DOMNode</type><type>false</type></type><methodname>DOMNode::appendChild</methodname>
14
+
<methodparam><type>DOMNode</type><parameter>node</parameter></methodparam>
15
15
</methodsynopsis>
16
16
<para>
17
17
This function appends a child to an existing list of children or creates
...
...
@@ -20,13 +20,16 @@
20
20
<methodname>DOMDocument::createTextNode</methodname> etc. or simply by using
21
21
any other node.
22
22
</para>
23
+
<para>
24
+
When using an existing node it will be moved.
25
+
</para>
23
26
</refsect1>
24
27
<refsect1 role="parameters">
25
28
&reftitle.parameters;
26
29
<para>
27
30
<variablelist>
28
31
<varlistentry>
29
-
<term><parameter>newnode</parameter></term>
32
+
<term><parameter>node</parameter></term>
30
33
<listitem>
31
34
<para>
32
35
The appended child.
...
...
@@ -39,7 +42,7 @@
39
42
<refsect1 role="returnvalues">
40
43
&reftitle.returnvalues;
41
44
<para>
42
-
The node added.
45
+
The node added or &false; on error.
43
46
</para>
44
47
</refsect1>
45
48
<refsect1 role="errors">
...
...
@@ -60,7 +63,7 @@
60
63
<listitem>
61
64
<para>
62
65
Raised if this node is of a type that does not allow children of the
63
-
type of the <parameter>newnode</parameter> node, or if the node to
66
+
type of the <parameter>node</parameter> node, or if the node to
64
67
append is one of this node's ancestors or this node itself.
65
68
</para>
66
69
</listitem>
...
...
@@ -69,7 +72,7 @@
69
72
<term><constant>DOM_WRONG_DOCUMENT_ERR</constant></term>
70
73
<listitem>
71
74
<para>
72
-
Raised if <parameter>newnode</parameter> was created from a different
75
+
Raised if <parameter>node</parameter> was created from a different
73
76
document than the one that created this node.
74
77
</para>
75
78
</listitem>
...
...
@@ -77,6 +80,7 @@
77
80
</variablelist>
78
81
</para>
79
82
</refsect1>
83
+
80
84
<refsect1 role="examples">
81
85
&reftitle.examples;
82
86
<para>
...
...
@@ -98,11 +102,35 @@ echo $doc->saveXML();
98
102
</programlisting>
99
103
</example>
100
104
</para>
105
+
106
+
<para>
107
+
<example>
108
+
<title>Nested children</title>
109
+
<programlisting role="php">
110
+
<![CDATA[
111
+
<?php
112
+

113
+
$doc = new DOMDocument;
114
+

115
+
$headNode = $doc->createElement("head");
116
+
$doc->appendChild($headNode);
117
+

118
+
$titleNode = $doc->createElement("title");
119
+
$headNode->appendChild($titleNode);
120
+

121
+
echo $doc->saveXML();
122
+
?>
123
+
]]>
124
+
</programlisting>
125
+
</example>
126
+
</para>
101
127
</refsect1>
128
+
102
129
<refsect1 role="seealso">
103
130
&reftitle.seealso;
104
131
<para>
105
132
<simplelist>
133
+
<member><methodname>DOMChildNode::after</methodname></member>
106
134
<member><methodname>DOMNode::insertBefore</methodname></member>
107
135
<member><methodname>DOMNode::removeChild</methodname></member>
108
136
<member><methodname>DOMNode::replaceChild</methodname></member>
...
...
@@ -110,7 +138,6 @@ echo $doc->saveXML();
110
138
</para>
111
139
</refsect1>
112
140
</refentry>
113
-

114
141
<!-- Keep this comment at the end of the file
115
142
Local variables:
116
143
mode: sgml
117
144