-
Notifications
You must be signed in to change notification settings - Fork 725
/
registernodeclass.xml
261 lines (237 loc) · 6.6 KB
/
registernodeclass.xml
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="domdocument.registernodeclass" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>DOMDocument::registerNodeClass</refname>
<refpurpose>Register extended class used to create base node type</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="DOMDocument">
<modifier>public</modifier> <type>bool</type><methodname>DOMDocument::registerNodeClass</methodname>
<methodparam><type>string</type><parameter>baseClass</parameter></methodparam>
<methodparam><type class="union"><type>string</type><type>null</type></type><parameter>extendedClass</parameter></methodparam>
</methodsynopsis>
<para>
This method allows you to register your own extended DOM class to be used
afterward by the PHP DOM extension.
</para>
<para>
This method is not part of the DOM standard.
</para>
<caution>
<simpara>
The constructor of the objects of the registered node classes is not called.
</simpara>
</caution>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>baseClass</parameter></term>
<listitem>
<para>
The DOM class that you want to extend. You can find a list of these
classes in the <link linkend="book.dom">chapter introduction</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>extendedClass</parameter></term>
<listitem>
<para>
Your extended class name. If &null; is provided, any previously
registered class extending <parameter>baseClass</parameter> will
be removed.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Adding a new method to DOMElement to ease our code</title>
<programlisting role="php">
<![CDATA[
<?php
class myElement extends DOMElement {
function appendElement($name) {
return $this->appendChild(new myElement($name));
}
}
class myDocument extends DOMDocument {
function setRoot($name) {
return $this->appendChild(new myElement($name));
}
}
$doc = new myDocument();
$doc->registerNodeClass('DOMElement', 'myElement');
// From now on, adding an element to another costs only one method call !
$root = $doc->setRoot('root');
$child = $root->appendElement('child');
$child->setAttribute('foo', 'bar');
echo $doc->saveXML();
?>
]]>
</programlisting>
&example.outputs;
<screen role="xml">
<![CDATA[
<?xml version="1.0"?>
<root><child foo="bar"/></root>
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Retrieving elements as custom class</title>
<programlisting role="php">
<![CDATA[
<?php
class myElement extends DOMElement {
public function __toString() {
return $this->nodeValue;
}
}
$doc = new DOMDocument;
$doc->loadXML("<root><element><child>text in child</child></element></root>");
$doc->registerNodeClass("DOMElement", "myElement");
$element = $doc->getElementsByTagName("child")->item(0);
var_dump(get_class($element));
// And take advantage of the __toString method..
echo $element;
?>
]]>
</programlisting>
&example.outputs;
<screen role="xml">
<![CDATA[
string(9) "myElement"
text in child
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Retrieving owner document</title>
<para>
When instantiating a custom <classname>DOMDocument</classname> the
<varname>ownerDocument</varname> property will refer to the instantiated
class. However, if all references to that class are removed, it
will be destroyed and new <classname>DOMDocument</classname> will be
created instead. For that reason you might use
<function>DOMDocument::registerNodeClass</function> with
<classname>DOMDocument</classname>
</para>
<programlisting role="php">
<![CDATA[
<?php
class MyDOMDocument extends DOMDocument {
}
class MyOtherDOMDocument extends DOMDocument {
}
// Create MyDOMDocument with some XML
$doc = new MyDOMDocument;
$doc->loadXML("<root><element><child>text in child</child></element></root>");
$child = $doc->getElementsByTagName("child")->item(0);
// The current owner of the node is MyDOMDocument
var_dump(get_class($child->ownerDocument));
// MyDOMDocument is destroyed
unset($doc);
// And new DOMDocument instance is created
var_dump(get_class($child->ownerDocument));
// Import a node from MyDOMDocument
$newdoc = new MyOtherDOMDocument;
$child = $newdoc->importNode($child);
// Register custom DOMDocument
$newdoc->registerNodeClass("DOMDocument", "MyOtherDOMDocument");
var_dump(get_class($child->ownerDocument));
unset($doc);
// New MyOtherDOMDocument is created
var_dump(get_class($child->ownerDocument));
?>
]]>
</programlisting>
&example.outputs;
<screen role="xml">
<![CDATA[
string(13) "MyDOMDocument"
string(11) "DOMDocument"
string(18) "MyOtherDOMDocument"
string(18) "MyOtherDOMDocument"
]]>
</screen>
</example>
</para>
<para>
<example xml:id="domdocument.registernodeclass.example.transient">
<title>Custom objects are transient</title>
<caution>
<simpara>
Objects of the registered node classes are transient, i.e. they are
destroyed when they are no longer referenced from PHP code, and recreated
when being retrieved again. That implies that custom property values will be
lost after recreation.
</simpara>
</caution>
<programlisting role="php">
<![CDATA[
<?php
class MyDOMElement extends DOMElement
{
public $myProp = 'default value';
}
$doc = new DOMDocument();
$doc->registerNodeClass('DOMElement', 'MyDOMElement');
$node = $doc->createElement('a');
$node->myProp = 'modified value';
$doc->appendChild($node);
echo $doc->childNodes[0]->myProp, PHP_EOL;
unset($node);
echo $doc->childNodes[0]->myProp, PHP_EOL;
?>]]>
</programlisting>
&example.outputs;
<screen role="xml">
<![CDATA[
modified value
default value
]]>
</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
-->