sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 08:58:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Initial SDO_XML_DAS Documentation drop

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@190995 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Anantoju Veera Srinivas 2005-07-19 11:16:59 +00:00
parent d6e9447789
commit 94e34d2ad7
22 changed files with 3696 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getEncoding.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getEncoding">
<refnamediv>
<refname>SDO_DAS_XML_Document::getEncoding</refname>
<refpurpose>
Returns encoding string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML_Document::getEncoding</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns the encoding string for the SDO_DAS_XML_Document object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the encoding string.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getEncoding</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
-->

136
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getNoNamespaceSchemaLocation.xml Normal file
View file

@ -0,0 +1,136 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getNoNamespaceSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::getNoNamespaceSchemaLocation</refname>
<refpurpose>
Returns no namespace schema location.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML_Document::getNoNamespaceSchemaLocation</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns the no namespace schema location.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns no namespace schema location.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getNoNamespaceSchemaLocation</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
-->

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getRoorDataObject.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getRoorDataObject">
<refnamediv>
<refname>SDO_DAS_XML_Document::getRoorDataObject</refname>
<refpurpose>
Returns the root SDO_DataObject.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DataObject</type><methodname>SDO_DAS_XML_Document::getRoorDataObject</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns the root SDO_DataObject.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the root SDO_DataObject.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getRoorDataObject</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
-->

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getRootElementName.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getRootElementName">
<refnamediv>
<refname>SDO_DAS_XML_Document::getRootElementName</refname>
<refpurpose>
Returns root element's name.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML_Document::getRootElementName</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns root element's name.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns root element's name.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getRootElementName</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
-->

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getRootElementURI.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getRootElementURI">
<refnamediv>
<refname>SDO_DAS_XML_Document::getRootElementURI</refname>
<refpurpose>
Returns root element's URI string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML_Document::getRootElementURI</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns root element's URI string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns root element's URI string.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getRootElementURI</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
-->

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getSchemaLocation.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::getSchemaLocation</refname>
<refpurpose>
Returns schema location.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML_Document::getSchemaLocation</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns schema location.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns schema location.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getSchemaLocation</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
-->

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getXMLDeclaration.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getXMLDeclaration">
<refnamediv>
<refname>SDO_DAS_XML_Document::getXMLDeclaration</refname>
<refpurpose>
Returns whether the xml declaration is set or not.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>boolean</type><methodname>SDO_DAS_XML_Document::getXMLDeclaration</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns whether the xml declaration is set or not.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns whether the xml declaration is set or not. TRUE If it is set and FALSE if it is not.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getXMLDeclaration</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
-->

137
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getXMLVersion.xml Normal file
View file

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-getXMLVersion">
<refnamediv>
<refname>SDO_DAS_XML_Document::getXMLVersion</refname>
<refpurpose>
Returns xml declaration string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML_Document::getXMLVersion</methodname>
<void/>
</methodsynopsis>
&warn.experimental.func;
<para>
Returns xml declaration string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns xml declaration string.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::getXMLVersion</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
-->

147
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setEncoding.xml Normal file
View file

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setEncoding">
<refnamediv>
<refname>SDO_DAS_XML_Document::setEncoding</refname>
<refpurpose>
Sets the given string as encoding.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML_Document::setEncoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as encoding.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Encoding string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::setEncoding</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
-->

147
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setNoNamespaceSchemaLocation.xml Normal file
View file

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setNoNamespaceSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::setNoNamespaceSchemaLocation</refname>
<refpurpose>
Sets the given string as no namespace schema location.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML_Document::setNoNamespaceSchemaLocation</methodname>
<methodparam><type>string</type><parameter>nnschemaLocation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as no namespace schema location.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>nnschemaLocation</parameter></term>
<listitem>
<para>
no namespace schema location.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::setNoNamespaceSchemaLocation</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
-->

147
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setSchemaLocation.xml Normal file
View file

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setSchemaLocation">
<refnamediv>
<refname>SDO_DAS_XML_Document::setSchemaLocation</refname>
<refpurpose>
Sets the given string as schema location.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML_Document::setSchemaLocation</methodname>
<methodparam><type>string</type><parameter>schemaLocation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as schema location.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>schemaLocation</parameter></term>
<listitem>
<para>
schema location.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::setSchemaLocation</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
-->

147
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setXMLDeclaration.xml Normal file
View file

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setXMLDeclaration">
<refnamediv>
<refname>SDO_DAS_XML_Document::setXMLDeclaration</refname>
<refpurpose>
Sets the xml declaration.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML_Document::setXMLDeclaration</methodname>
<methodparam><type>bool</type><parameter>xmlDeclatation</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given given boolean value for xml declaration. Pass TRUE to set it and FLASE to not to unset it.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlDeclatation</parameter></term>
<listitem>
<para>
boolean value to set the XML declaration.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::setXMLDeclaration</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
-->

147
reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setXMLVersion.xml Normal file
View file

@ -0,0 +1,147 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-Document-setXMLVersion">
<refnamediv>
<refname>SDO_DAS_XML_Document::setXMLVersion</refname>
<refpurpose>
Sets the given string as xml version.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML_Document::setXMLVersion</methodname>
<methodparam><type>string</type><parameter>xmlVersion</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Sets the given string as xml version.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xmlVersion</parameter></term>
<listitem>
<para>
xml version string.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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_Document::setXMLVersion</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
-->

162
reference/sdo_das_xml/functions/SDO-DAS-XML-create.xml Normal file
View file

@ -0,0 +1,162 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-create">
<refnamediv>
<refname>SDO_DAS_XML::create</refname>
<refpurpose>
To create SDO_DAS_XML object for a given schema file.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DAS_XML</type><methodname>SDO_DAS_XML::create</methodname>
<methodparam><type>string</type><parameter>xsd_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
This is the only static method of SDO_DAS_XML class. used to instantiate SDO_DAS_XML object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xsd_file</parameter></term>
<listitem>
<para>
Path to XSD Schema file.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns SDO_DAS_XML object on success otherwise throws an exception as described below.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
<variablelist>
<varlistentry>
<term><parameter>SDO_TypeNotFoundException</parameter></term>
<listitem>
<para>
Thrown if 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 symantical problems while parsing the given XSD File.
</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::create</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
-->

162
reference/sdo_das_xml/functions/SDO-DAS-XML-createDataObject.xml Normal file
View file

@ -0,0 +1,162 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-createDataObject">
<refnamediv>
<refname>SDO_DAS_XML::createDataObject</refname>
<refpurpose>
Creates SDO_DataObject for a given namespace URI and type name.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DataObject</type><methodname>SDO_DAS_XML::createDataObject</methodname>
<methodparam><type>string</type><parameter>namespace_uri</parameter></methodparam>
<methodparam><type>string</type><parameter>type_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Creates SDO_DataObject for a given namespace URI and type name. The type should be defined in the underlying model otherwise SDO_TypeNotFoundException will be thrown.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>namespace_uri</parameter></term>
<listitem>
<para>
Namespace URI of the type name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type_name</parameter></term>
<listitem>
<para>
Type Name.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns SDO_DataObject on success.
</para>
</refsect1>
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
<variablelist>
<varlistentry>
<term><parameter>SDO_TypeNotFoundException</parameter></term>
<listitem>
<para>
Thrown if a type is not defined 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
-->

169
reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromFile.xml Normal file
View file

@ -0,0 +1,169 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-loadFromFile">
<refnamediv>
<refname>SDO_DAS_XML::loadFromFile</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::loadFromFile</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="exceptions">
&reftitle.exceptions;
<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 the 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 symantical problems while parsing the given XSD File.
</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
-->

170
reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromString.xml Normal file
View file

@ -0,0 +1,170 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-loadFromString">
<refnamediv>
<refname>SDO_DAS_XML::loadFromString</refname>
<refpurpose>
Returns SDO_DAS_XML_Document for a given xml instance string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>SDO_DAS_XML_Document</type><methodname>SDO_DAS_XML::loadFromString</methodname>
<methodparam><type>string</type><parameter>xml_string</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Constructs the tree of SDO_DataObjects' from the given xml instance string. 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_string</parameter></term>
<listitem>
<para>
xml string.
</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="exceptions">
&reftitle.exceptions;
<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 the 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 symantical problems while parsing the given XSD File.
</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::loadFromString</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
-->

166
reference/sdo_das_xml/functions/SDO-DAS-XML-saveDataObjectToFile.xml Normal file
View file

@ -0,0 +1,166 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDataObjectToFile">
<refnamediv>
<refname>SDO_DAS_XML::saveDataObjectToFile</refname>
<refpurpose>
Saves the SDO_DataObject object to File.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML::saveDataObjectToFile</methodname>
<methodparam><type>SDO_DataObject</type><parameter>do</parameter></methodparam>
<methodparam><type>string</type><parameter>root_uri</parameter></methodparam>
<methodparam><type>string</type><parameter>root_name</parameter></methodparam>
<methodparam><type>string</type><parameter>xml_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Saves the SDO_DataObject object as an XML File.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>do</parameter></term>
<listitem>
<para>
DataObject, which needs to be saves as an XML File.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>root_uri</parameter></term>
<listitem>
<para>
URI string for the root DataObject.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>root_name</parameter></term>
<listitem>
<para>
Type name of the root DataObject.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
None.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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::saveDataObjectToFile</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
-->

165
reference/sdo_das_xml/functions/SDO-DAS-XML-saveDataObjectToString.xml Normal file
View file

@ -0,0 +1,165 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDataObjectToString">
<refnamediv>
<refname>SDO_DAS_XML::saveDataObjectToString</refname>
<refpurpose>
Saves the SDO_DataObject object to string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML::saveDataObjectToString</methodname>
<methodparam><type>SDO_DataObject</type><parameter>do</parameter></methodparam>
<methodparam><type>string</type><parameter>root_uri</parameter></methodparam>
<methodparam><type>string</type><parameter>root_name</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Saves the SDO_DataObject object as an XML string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>do</parameter></term>
<listitem>
<para>
DataObject, which needs to be saves as an XML File.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>root_uri</parameter></term>
<listitem>
<para>
URI string for the root DataObject.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>root_name</parameter></term>
<listitem>
<para>
Type name of the root DataObject.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
xml string
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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::saveDataObjectToString</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
-->

156
reference/sdo_das_xml/functions/SDO-DAS-XML-saveDocumentToFile.xml Normal file
View file

@ -0,0 +1,156 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDocumentToFile">
<refnamediv>
<refname>SDO_DAS_XML::saveDocumentToFile</refname>
<refpurpose>
Saves the SDO_DAS_XML_Document object to a file.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>SDO_DAS_XML::saveDocumentToFile</methodname>
<methodparam><type>SDO_XMLDocument</type><parameter>xdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>xml_file</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Saves the SDO_DAS_XML_Document object to a file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xdoc</parameter></term>
<listitem>
<para>
SDO_DAS_XML_Document object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>xml_file</parameter></term>
<listitem>
<para>
xml file.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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::saveDocumentToFile</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
-->

148
reference/sdo_das_xml/functions/SDO-DAS-XML-saveDocumentToString.xml Normal file
View file

@ -0,0 +1,148 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<refentry id="function.SDO-DAS-XML-saveDocumentToString">
<refnamediv>
<refname>SDO_DAS_XML::saveDocumentToString</refname>
<refpurpose>
Saves the SDO_DAS_XML_Document object to a string.
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>SDO_DAS_XML::saveDocumentToString</methodname>
<methodparam><type>SDO_XMLDocument</type><parameter>xdoc</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Saves the SDO_DAS_XML_Document object to string.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>xdoc</parameter></term>
<listitem>
<para>
SDO_DAS_XML_Document object.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
xml string.
</para>
</refsect1>
<!-- Use when EXCEPTIONS exist
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
When does this function throw exceptions?
</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::saveDocumentToString</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
-->

568
reference/sdo_das_xml/reference.xml Normal file
View file

@ -0,0 +1,568 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
<reference id="ref.sdo-das-xml">
<title>SDO XML Data Access Service Functions</title>
<titleabbrev>XML DAS</titleabbrev>
<partintro>
<section id="sdo-das-xml.intro">
&reftitle.intro;
<para>
<!-- This warns that the extension is experimental -->
&warn.experimental;
</para>
<para>
In order to use the XML Data Access Service for Service Data Objects, you will need to understand some of the concepts behind SDO: the data graph, the data object, XPath and property expressions, and so on.
If you are not familiar with these ideas, you might want to look first at
<link linkend='ref.sdo'>the section on SDO</link>
.
</para>
<para>
The job of the XML DAS is to move data between the application and an XML data source.
In order to do this it needs to be told the XML schema the XML should follow.
This model information is used to ensure conformance of XML being written out, and also to ensure that
modifications made to an SDO originating from XML follow the model described by the XML schema.
</para>
<para>
The XML DAS currently supports reading/writing XML to/from a file or an http URL (for example, to support RSS feeds).
</para>
</section>
<section id="sdo-das-xml.requirements">
&reftitle.required;
<para>
The SDO XML Data Access Service requires PHP 5.1 or higher. It is packaged with the SDO extension and requires SDO to have been installed.
See the
<link linkend="sdo.installation">SDO installation instructions</link>
for steps on how to do this.
</para>
</section>
<section id="sdo-das-xml.installation">
&reftitle.install;
<para>
The XML Data Access Service is packaged and installed as part of the <link linkend='ref.sdo'>SDO extension</link>.
There are additional installations steps required.
</para>
</section>
<section id='sdo-das-xml.limitations'>
<title>Limitations</title>
<para>
The <ulink url='http://www-128.ibm.com/developerworks/java/library/j-commonj-sdowmt/'>SDO 2.0 specification</ulink> defines the mapping between XML types and SDO types. With Java SDO, this mapping is implemented by the XMLHelper. With SDO for PHP, this mapping is implemented by the XML Data Access Services. The XML DAS implements the mapping described in the SDO 2.0 specification with the following restrictions:
</para>
<procedure id='sdo-das-xml.limitations.simpletypes'>
<title>XML Simple Types</title>
<step>
<para>
Simple Type with abstract="true" - no PHP support for SDO abstract types.
</para>
</step>
<step>
<para>
Simple Type with sdoJava:instanceClass - no PHP equivalent provided.
</para>
</step>
<step>
<para>
Simple Type with sdoJava:extendedInstanceClass - no PHP equivalent provided.
</para>
</step>
<step>
<para>
Simple Type with list of itemType.
</para>
</step>
<step>
<para>
Simple Type with union.
</para>
</step>
</procedure>
<procedure id='sdo-das-xml.limitations.complextypes'>
<title>XML Complex Types</title>
<step>
<para>
Complex Type with abstract="true" - no PHP support for SDO abstract types.
</para>
</step>
<step>
<para>
Complex Type with sdo:aliasName - no PHP support for SDO Type aliases.
</para>
</step>
<step>
<para>
Complex Type with open content - no PHP support for SDO open types.
</para>
</step>
<step>
<para>
Complex Type with open attribute - no PHP support for SDO open types.
</para>
</step>
</procedure>
<procedure id='sdo-das-xml.limitations.attribute'>
<title>XSD Attribute</title>
<step>
<para>
Attribute with sdo:aliasName - no PHP support for SDO property aliases.
</para>
</step>
<step>
<para>
Attribute with default value - no PHP support for SDO property defaults.
</para>
</step>
<step>
<para>
Attribute with fixed value - no PHP support for SDO read-only properties or default values.
</para>
</step>
<step>
<para>
Attribute reference.
</para>
</step>
<step>
<para>
Attribute with sdo:string - no support for sdo:string="true".
</para>
</step>
<step>
<para>
Attribute referencing a DataObject with sdo:propertyType - no support for sdo:propertyType="...".
</para>
</step>
<step>
<para>
Attribute with bi-directional property to a DataObject with sdo:oppositeProperty and sdo:propertyType - no PHP support for SDO opposite.
</para>
</step>
</procedure>
<procedure id='sdo-das-xml.limitations.elements'>
<title>XSD Elements</title>
<step>
<para>
Element with sdo:aliasName - no PHP support for SDO property aliases.
</para>
</step>
<step>
<para>
Element reference.
</para>
</step>
<step>
<para>
Element with nillable.
</para>
</step>
<step>
<para>
Element with substitution group.
</para>
</step>
</procedure>
<procedure id='sdo-das-xml.limitations.elementsimpletype'>
<title>XSD Elements with Simple Type</title>
<step>
<para>
Element of SimpleType with default - no PHP support for SDO defaults
</para>
</step>
<step>
<para>
Element of SimpleType with fixed value - - no PHP support for SDO read-only properties or default values.
</para>
</step>
<step>
<para>
Element of SimpleType with sdo:string - no support for sdo:string="true".
</para>
</step>
<step>
<para>
Element referencing a DataObject with sdo:propertyType - no support for sdo:propertyType="..."
</para>
</step>
<step>
<para>
Element with bi-directional reference to a DataObject with sdo:oppositeProperty and sdo:propertyType - no PHP support for SDO opposite.
</para>
</step>
</procedure>
</section>
<section id='sdo-das-xml.examples'>
&reftitle.examples;
<para>
The following examples are based on the
<link linkend="sdo.sample.sequence">letter example</link>
described in the
<link linkend="ref.sdo">SDO documentation</link>
.
The examples assume the XML Schema for the letter is contained in a the file
<filename>letter.xsd</filename>
and the letter instance is in the file
<filename>letter.xml</filename>
. </para>
<example>
<title>Working with the SDO_DAS_XML Class</title>
<para>
The following example shows how to create a SDO_DAS_XML Object and use it to load an instance document.
The SDO_XML_DAS object can be created by passing the xsd file to the SDO_DAS_XML::create method, which is a static method of SDO_DAS_XML Class. This schema file(XSD Document) can be either file available on the local file system or it can be an URL.
Once we have created the SDO_XML_DAS Object, we can use the same to load the instance document using loadFromFile method. loadFromString method can be used if want load xml instance document which is available as string.
On successful loading of the instance document, you will be returned with an object of type SDO_DAS_XML_Document. Use the getRootDataObject method of SDO_DAS_XML_Document class to get the root DataObject.
This example also tries to modify the properties of the root DataObject and then write the changed contents back to file system.
</para>
<programlisting role="php" id="sdo-xml-das.examples.loadfromfile">
<![CDATA[
<?php
try {
$xmldas = SDO_DAS_XML::create("letter.xsd");
$xdoc = $xmldas->loadFromFile("letter.xml");
$do = $xdoc->getRootDataObject();
$do->date = "September 03, 2004";
$do->firstName = "Anantoju";
$do->lastName = "Madhu";
$xmldas->saveDocumentToFile($xdoc, "letter-out.xml");
} catch (SDO_TypeNotFoundException $e) {
print("Type is not defined in the xsd file");
} catch (SDO_DAS_XML_ParserException $e) {
print("Problem while parsing");
}
?>
]]>
</programlisting>
</example>
<example>
<title>Working with the SDO_DAS_XML Class</title>
<para>
The above example shown, how to use the SDO_XML_DAS object to load an existing instance document and change the DataObject(property values) and write the changes back to file system.
This example shows, how to create the DataObjects dynamically and save them as a xml string. Please note that this example uses a company schema((<link linkend="sdo.examples">company.xsd</link>)) as defined in SDO samples section.
</para>
<programlisting role="php" id="sdo-xml-das.examples.createDataObject">
<![CDATA[
<?php
$xmldas = SDO_DAS_XML::create("company.xsd");
$do = $xmldas->createDataObject("companyNS", "CompanyType");
$do->name = "Acme Inc";
$dept1 = $do->createDataObject("departments");
$dept1->name = "sales";
$emp1 = $dept1->createDataObject("employees");
$emp1->name = "Fred";
$emp1->manager = FALSE;
$dept2 = $do->createDataObject("departments");
$emp2 = $dept2->createDataObject("employees");
$emp2->name = "Neil";
$emp2->manager = TRUE;
print($xmldas->saveDataObjectToString($do, "companyNS", "CompanyType"));
var_dump($do);
?>
]]>
</programlisting>
</example>
<example>
<title>Working with the SDO_DAS_XML Class</title>
<para>
This example shows you how to create the DataObject and use the Sequence API (<link linkend="sdo.sample.sequence">For more information on Sequence API</link>) to construct a letter containing unstructured text.
</para>
<programlisting role="php" id="sdo-xml-das.examples.getSequence">
<![CDATA[
<?php
try {
$xmldas = SDO_DAS_XML::create("letter.xsd");
try {
$do = $xmldas->createDataObject("http://letterSchema", "FormLetter");
$seq = $do->getSequence();
$seq->insert("April 09, 2005", NULL, 'date');
$seq->insert("Acme Inc. ", NULL, NULL);
$seq->insert("United Kingdom. ");
$seq->insert("Dear", NULL, NULL);
$seq->insert("Tarun", NULL, "firstName");
$seq->insert("Nayaraaa", NULL, "lastName");
$do->lastName = "Nayar";
$seq->insert("Please note that your order number ");
$seq->insert(12345);
$seq->insert(" has been dispatched today. Thanks for your business with us.");
$type = $do->getType();
print($xmldas->saveDataObjectToString($do, $type[0], $type[1]));
} catch (SDO_Exception $e) {
print($e);
}
} catch (SDO_TypeNotFoundException $e) {
print("Type is not defined in the xsd file");
} catch (SDO_DAS_XML_ParserException $e) {
print("Problem while parsing");
}?>
]]>
</programlisting>
</example>
<example>
<title>Working with the SDO_DAS_XML_Document Class</title>
<para>
This example shows you how to use the SDO_DAS_XML_Document class. SDO_DAS_XML_Document class is provided to get/set XML declarations such as version, schema location, encoding etc.
</para>
<programlisting role="php" id="sdo-xml-das.examples.sdo_das_xml_document">
<![CDATA[
<?php
try {
$xmldas = SDO_DAS_XML::create("letter.xsd");
$xdoc = $xmldas->loadFromFile("letter.xml");
print("Encoding is set to : " . $xdoc->getEncoding());
print("XML Version : " . $xdoc->getXMLVersion();
$xdoc->setXMLVersion("1.1");
print($xmldas->saveDocumentToString($xdoc));
} catch (SDO_TypeNotFoundException $e) {
print("Type is not defined in the xsd file");
} catch (SDO_DAS_XML_ParserException $e) {
print("Problem while parsing");
}
?>
]]>
</programlisting>
</example>
</section>
<!-- class definition section -->
<section id='sdo-das-xml.classes'>
&reftitle.classes;
<para>
The XML DAS provides three classes. The SDO_DAS_XML which is the main class used to fetch the data from the XML source and also can used to write the data back.
The next one is SDO_DAS_XML_Document class, which is basically useful to get/set the XML declarations such as encoding, version etc. And the last class is SDO_DAS_XML_ParserException which will be thrown for any parser exceptions while loading xsd/xml file.
</para>
<section id='sdo-das-xml.class.sdo_das_xml'>
<title>
<classname>SDO_DAS_XML</classname>
</title>
<para>
This is the main class of XML DAS, which is used fetch the data from the xml source and also used to write the data back. Other than the methods to load and save xml files, it also has a method called createDataObject which can be used to create an empty DataObject of a given type.
</para>
<section id='sdo-das-xml.class.SDO_DAS_XML.methods'> &reftitle.methods;
<itemizedlist>
<listitem>
<para>
<link linkend='function.SDO-DAS-XML-create'>create</link>
This is the only static method available in SDO_DAS_XML class. Used to construct SDO_XML_DAS object.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-createDataObject'>createDataObject</link>
Can be used to construct the DataObject of a given type.
</para>
</listitem>
<listitem>
<para>
<link linkend='function.SDO-DAS-XML-loadFromFile'>loadFromFile</link>
Loads the xml instance document from a file. This file can be at local file system or it can be on a remote host.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-loadFromString'>loadFromString</link>
same as the above method. loads the xml instance which is available as string.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-saveDataObjectToFile'>saveDataObjectToFile</link>
save SDO_DataObject to a file.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-saveDataObjectToString'>saveDataObjectToString</link>
save SDO_DataObject to as a xml file.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-saveDocumentToFile'>saveDocumentToFile</link>
save SDO_DAS_XML_Document object as a xml file.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-saveDocumentToString'>saveDocumentToString</link>
save SDO_DAS_XML_Document object as a xml string.
</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id='sdo-das-xml.class.sdo_das_xml_document'>
<title>
<classname>SDO_DAS_XML_Document</classname>
</title>
<para>
This class can be used to get/set XML Declarations such as encoding, schema location etc.
</para>
<section id='sdo-das-xml.class.SDO_DAS_XML_Document.methods'> &reftitle.methods;
<itemizedlist>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getEncoding'>getEncoding</link>
gets the encoding string.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getNoNamespaceSchemaLocation'>getNoNamespaceSchemaLocation</link>
gets the no namespace schema location.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getRoorDataObject'>getRootDataObject</link>
gets the root DataObject.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getRootElementName'>getRootElementName</link>
gets the root DataObject's name.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getRootElementURI'>getRootElementURI</link>
gets the root DataObject's URI.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getSchemaLocation'>getSchemaLocation</link>
gets schema location.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getXMLDeclaration'>getXMLDeclaration</link>
gets whether xml declaration is set ot not.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-getXMLVersion'>getXMLVersion</link>
gets the xml version.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-setEncoding'>setEncoding</link>
sets the encoding string with the given value.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-setNoNamespaceSchemaLocation'>setNoNamespaceSchemaLocation</link>
sets the no namespace schema location with the given value.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-setSchemaLocation'>setSchemaLocation</link>
sets the schema location with the given value.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-setXMLDeclaration'>setXMLDeclaraion</link>
to set/unset the xml declaration.
</para>
</listitem>
<listitem>
<para>
<link
linkend='function.SDO-DAS-XML-Document-setXMLVersion'>setXMLVersion</link>
sets the xml version with the given value.
</para>
</listitem>
</itemizedlist>
</section>
</section>
<section id='sdo-das-xml.class.sdo_das_xml_parserexception'>
<title>
<classname>SDO_DAS_XML_ParserException</classname>
</title>
<para>
Is a subclass of <classname>SDO_Exception</classname>
Thrown, for any parser errors while loading the xsd/xml file.
</para>
</section>
</section>
</partintro>
&reference.sdo-das-xml.functions;
</reference>
<!-- 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
-->