reference/xsl/xsltprocessor/transformtodoc.xml
960d50e1dafc7e385fdf1d2d5d2152fc564fb905
...
...
@@ -3,20 +3,17 @@
3
3
<refentry xml:id="xsltprocessor.transformtodoc" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>XSLTProcessor::transformToDoc</refname>
6
-
<refpurpose>Transform to a DOMDocument</refpurpose>
6
+
<refpurpose>Transform to a document</refpurpose>
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
-
<classsynopsis>
11
-
<ooclass><classname>XSLTProcessor</classname></ooclass>
12
-
<methodsynopsis>
13
-
<type>DOMDocument</type>
14
-
<methodname>transformToDoc</methodname>
15
-
<methodparam><type>DOMNode</type><parameter>doc</parameter></methodparam>
16
-
</methodsynopsis>
17
-
</classsynopsis>
10
+
<methodsynopsis role="XSLTProcessor">
11
+
<modifier>public</modifier> <type class="union"><type>object</type><type>false</type></type><methodname>XSLTProcessor::transformToDoc</methodname>
12
+
<methodparam><type>object</type><parameter>document</parameter></methodparam>
13
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>returnClass</parameter><initializer>&null;</initializer></methodparam>
14
+
</methodsynopsis>
18
15
<para>
19
-
Transforms the source node to a <classname>DOMDocument</classname> applying
16
+
Transforms the source node to a document (e.g. <classname>DOMDocument</classname>) applying
20
17
the stylesheet given by the
21
18
<function>XSLTProcessor::importStylesheet</function> method.
22
19
</para>
...
...
@@ -26,10 +23,22 @@
26
23
<para>
27
24
<variablelist>
28
25
<varlistentry>
29
-
<term><parameter>doc</parameter></term>
26
+
<term><parameter>document</parameter></term>
30
27
<listitem>
31
28
<para>
32
-
The node to be transformed.
29
+
The <classname>DOMDocument</classname> or <classname>SimpleXMLElement</classname> or libxml-compatible
30
+
object to be transformed.
31
+
</para>
32
+
</listitem>
33
+
</varlistentry>
34
+
<varlistentry>
35
+
<term><parameter>returnClass</parameter></term>
36
+
<listitem>
37
+
<para>
38
+
This optional parameter may be used so that
39
+
<methodname>XSLTProcessor::transformToDoc</methodname>
40
+
will return an object of the specified class.
41
+
That class should either extend or be the same class as <parameter>document</parameter>'s class.
33
42
</para>
34
43
</listitem>
35
44
</varlistentry>
...
...
@@ -39,7 +48,7 @@
39
48
<refsect1 role="returnvalues">
40
49
&reftitle.returnvalues;
41
50
<para>
42
-
The resulting <classname>DOMDocument</classname> or &false; on error.
51
+
The resulting document or &false; on error.
43
52
</para>
44
53
</refsect1>
45
54
<refsect1 role="examples">
...
...
@@ -86,7 +95,6 @@ Hey! Welcome to Nicolas Eliaszewicz's sweet CD collection!
86
95
</para>
87
96
</refsect1>
88
97
</refentry>
89
-

90
98
<!-- Keep this comment at the end of the file
91
99
Local variables:
92
100
mode: sgml
93
101