1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domdocument.createelement" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMDocument::createElement</refname>
<refpurpose>Create new element node</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMDocument">
<modifier>public</modifier> <type class="union"><type>DOMElement</type><type>false</type></type><methodname>DOMDocument::createElement</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>value</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
<para>
This function creates a new instance of class
<classname>DOMElement</classname>. &dom.node.inserted;
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
The tag name of the element.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
The value of the element. By default, an empty element will be created.
The value can also be set later with <link linkend="domnode.props.nodevalue">DOMElement::$nodeValue</link>.
</para>
<para>
The value is used verbatim except that the < and > entity
references will escaped. Note that & has to be manually escaped;
otherwise it is regarded as starting an entity reference. Also " won't be
escaped.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new instance of class <classname>DOMElement</classname> or &false;
if an error occurred.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_INVALID_CHARACTER_ERR</constant></term>
<listitem>
<para>
Raised if <parameter>localName</parameter> contains an invalid character.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Creating a new element and inserting it as root</title>
<programlisting role="php">
<![CDATA[
<?php
$dom = new DOMDocument('1.0', 'utf-8');
$element = $dom->createElement('test', 'This is the root element!');
// We insert the new element as root (child of the document)
$dom->appendChild($element);
echo $dom->saveXML();
?>
]]>
</programlisting>
&example.outputs;
<screen role="xml">
<![CDATA[
<?xml version="1.0" encoding="utf-8"?>
<test>This is the root element!</test>
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Passing text containing an unescaped & as <parameter>value</parameter></title>
<programlisting role="php">
<![CDATA[
<?php
$dom = new DOMDocument('1.0', 'utf-8');
$element = $dom->createElement('foo', 'me & you');
$dom->appendChild($element);
echo $dom->saveXML();
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
Warning: DOMDocument::createElement(): unterminated entity reference you in /in/BjTCg on line 4
<?xml version="1.0" encoding="utf-8"?>
<foo/>
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
The <parameter>value</parameter> will <emphasis>not</emphasis> be escaped.
Use <methodname>DOMDocument::createTextNode</methodname> to create a
text node with <emphasis>escaping support</emphasis>.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DOMNode::appendChild</methodname></member>
<member><methodname>DOMDocument::createAttribute</methodname></member>
<member><methodname>DOMDocument::createAttributeNS</methodname></member>
<member><methodname>DOMDocument::createCDATASection</methodname></member>
<member><methodname>DOMDocument::createComment</methodname></member>
<member><methodname>DOMDocument::createDocumentFragment</methodname></member>
<member><methodname>DOMDocument::createElementNS</methodname></member>
<member><methodname>DOMDocument::createEntityReference</methodname></member>
<member><methodname>DOMDocument::createProcessingInstruction</methodname></member>
<member><methodname>DOMDocument::createTextNode</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
-->
|
