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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-createDocument">
<refnamediv>
<refname>SDO_DAS_XML::createDocument</refname>
<refpurpose>
Creates an XML Document object from scratch, without the need to load a document from a file or string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DAS_XML_Document</type><methodname>SDO_DAS_XML::createDocument</methodname>
<methodparam choice="opt"><type>string</type><parameter>document_element_name</parameter></methodparam>
</methodsynopsis>
<methodsynopsis>
<type>SDO_DAS_XML_Document</type><methodname>SDO_DAS_XML::createDocument</methodname>
<methodparam><type>string</type><parameter>document_element_namespace_URI</parameter></methodparam>
<methodparam><type>string</type><parameter>document_element_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Creates an XML Document object. This will contain just one empty root element
on which none of the properties will have been set.
The purpose of this call is to allow an application to create
an XML document from scratch without the need to load a
document from a file or string. The document that is created
will be as if a document had been loaded that contained just a single
empty document element with no attributes set or elements within it.
</para>
<para>
<function>createDocument</function>
may need to be told what the document element is.
This will not be necessary in simple cases.
When there is no ambiguity then no parameter need be passed to the
method.
However it is possible to load more than one schema file into the same XML DAS
and in this case there may be more than one possible document element defined:
furthermore it is even possible that there are two possible document elements that
differ only in the namespace.
To cope with these cases it is possible to specify either the document element
name, or both the document element name and namespace to the method.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>document_element_name</parameter>
</term>
<listitem>
<para>
The name of the document element. Only needed if there
is more than one possibility.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>document_element_namespace_URI</parameter>
</term>
<listitem>
<para>
The namespace part of the document element name. Only needed if there is more
than one possible document element with the same name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an SDO_XML_DAS_Document object on success.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>SDO_UnsupportedOperationException</parameter>
</term>
<listitem>
<para>
Thrown if an element name or element name and namespace URI is passed,
but not found in the underlying model.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here
<entry>Description of change
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>SDO_DAS_XML::createDataObject</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function></function></member>
<member>Or <link linkend="somethingelse">something else</link></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:"../../../../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
-->
|
