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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-loadFile">
<refnamediv>
<refname>SDO_DAS_XML::loadFile</refname>
<refpurpose>
Returns SDO_DAS_XML_Document object for a given path to xml instance document
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_XMLDocument</type><methodname>SDO_DAS_XML::loadFile</methodname>
<methodparam><type>string</type><parameter>xml_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Constructs the tree of SDO_DataObjects from the given address
to xml instance document.
Returns SDO_DAS_XML_Document Object.
Use SDO_DAS_XML_Document::getRootDataObject
method to get root data object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>xml_file</parameter>
</term>
<listitem>
<para>
Path to Instance document.
This can be a path to a local file or it can be a URL.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns SDO_DAS_XML_Document object on Success or throws
exception as described.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>SDO_TypeNotFoundException</parameter>
</term>
<listitem>
<para>
Thrown if a type is not defined by the underlying model.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>SDO_PropertyNotFoundException</parameter>
</term>
<listitem>
<para>
Thrown if a property within a type is not defined
in the underlying model.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>SDO_DAS_XML_ParserException</parameter>
</term>
<listitem>
<para>
Thrown for any problems while parsing the given XSD File.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>SDO_DAS_XML_FileException</parameter>
</term>
<listitem>
<para>
Thrown if the specified file cannot be found.
</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::loadFromFile</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
-->
|
