<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>SDO DAS XML Functions</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sdo-das-xml.examples.html">Examples</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sdo-das-xml.addtypes.html">SDO_DAS_XML::addTypes</a></div>
<div class="up"><a href="book.sdo-das-xml.html">SDO DAS XML</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ref.sdo-das-xml" class="reference">
<h1 class="title">SDO DAS XML Functions</h1>
<div class="partintro">
<div class="section" id="sdo-das-xml.classes">
<h2 class="title">Predefined Classes</h2>
<p class="para">
The XML DAS provides two main classes.
The first is SDO_DAS_XML which is the main class used to fetch the
data from the XML source and used to write the data back.
The second is the SDO_DAS_XML_Document class,
which represents the data in the XML document.
</p>
<p class="para">
There are also some exception classes which can be thrown
if errors are found when looking for or parsing the xsd or
xml files.
</p>
<div class="section" id="class.sdo-das-xml">
<h2 class="title">
<strong class="classname">SDO_DAS_XML</strong>
</h2>
<p class="para">
This is the main class of the 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,
</p>
<div class="section">
<h2 class="title">Methods</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.create.html" class="link">create</a>
This is a static method available in the SDO_DAS_XML class.
Used to construct an SDO_DAS_XML object.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.addtypes.html" class="link">addTypes</a>
Works in much the same way as <span class="function"><strong>create()</strong></span> but used
to add the contents of a second or subsequent schema file to
an XML DAS that has already been created.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.createdataobject.html" class="link">createDataObject</a>
Can be used to construct an SDO data object of a given type.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.createdocument.html" class="link">createDocument</a>
Can be used to construct an XML Document object from scratch.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.loadfile.html" class="link">loadFile</a>
Loads the xml instance document from a file.
This file can be at local file system or it can be on a remote host.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.loadstring.html" class="link">loadString</a>
same as the above method.
Loads the xml instance which is available as string.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.savefile.html" class="link">saveFile</a>
save SDO_DAS_XML_Document object as a xml file.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml.savestring.html" class="link">saveString</a>
save SDO_DAS_XML_Document object as a xml string.
</p>
</li>
</ul>
</div>
</div>
<div class="section" id="class.sdo-das-xml-document">
<h2 class="title">
<strong class="classname">SDO_DAS_XML_Document</strong>
</h2>
<p class="para">
This class can be used to get to the name and namespace of the document element,
and to get to the root data object of the document.
Lastly, it can also be used to set the XML version and encoding
of a document on output.
</p>
<div class="section">
<h2 class="title">Methods</h2>
<ul class="itemizedlist">
<li class="listitem">
<p class="para">
<a href="sdo-das-xml-document.getrootdataobject.html" class="link">getRootDataObject</a>
gets the root DataObject.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml-document.getrootelementname.html" class="link">getRootElementName</a>
gets the root DataObject's name.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml-document.getrootelementuri.html" class="link">getRootElementURI</a>
gets the root DataObject's URI.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml-document.setencoding.html" class="link">setEncoding</a>
sets the encoding string with the given value.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml-document.setxmldeclaration.html" class="link">setXMLDeclaraion</a>
to set/unset the xml declaration.
</p>
</li>
<li class="listitem">
<p class="para">
<a href="sdo-das-xml-document.setxmlversion.html" class="link">setXMLVersion</a>
sets the xml version with the given value.
</p>
</li>
</ul>
</div>
</div>
<div class="section" id="class.sdo-das-xml-parserexception">
<h2 class="title">
<strong class="classname">SDO_DAS_XML_ParserException</strong>
</h2>
<p class="para">
Is a subclass of
<strong class="classname">SDO_Exception</strong>.
Thrown for any parser errors while loading the xsd/xml file.
</p>
</div>
<div class="section" id="class.sdo-das-xml-fileexception">
<h2 class="title">
<strong class="classname">SDO_DAS_XML_FileException</strong>
</h2>
<p class="para">
Is a subclass of
<strong class="classname">SDO_Exception</strong>.
Thrown by any of the methods that load data from a file, when the file
cannot be found.
</p>
</div>
</div>
<div class="section" id="sdo-das-xml.limitations">
<h2 class="title">Limitations compared with SDO 2.0 specification</h2>
<p class="para">
The
<a href="http://www.ibm.com/developerworks/webservices/library/specification/ws-sdo/" class="link external">» SDO 2.0 specification</a>
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 Service.
The XML DAS implements the mapping described in the
SDO 2.0 specification with some restrictions.
A detailed list is of the limitations is:
</p>
<div class="procedure">
<strong class="title">XML Simple Types</strong>
<ol type="1"><li>
<p class="para">
Simple Type with sdoJava:instanceClass
- no PHP equivalent provided.
</p>
</li>
<li>
<p class="para">
Simple Type with sdoJava:extendedInstanceClass
- no PHP equivalent provided.
</p>
</li>
<li>
<p class="para">
Simple Type with list of itemType.
</p>
</li>
<li>
<p class="para">
Simple Type with union.
</p>
</li>
</ol></div>
<div class="procedure">
<strong class="title">XML Complex Types</strong>
<ol type="1"><li>
<p class="para">
Complex Type with sdo:aliasName
- no PHP support for SDO Type aliases.
</p>
</li>
</ol></div>
<div class="procedure">
<strong class="title">XSD Attribute</strong>
<ol type="1"><li>
<p class="para">
Attribute with sdo:aliasName
- no PHP support for SDO property aliases.
</p>
</li>
<li>
<p class="para">
Attribute with default value
- no PHP support for SDO property defaults.
</p>
</li>
<li>
<p class="para">
Attribute with fixed value
- no PHP support for SDO read-only properties or default values.
</p>
</li>
<li>
<p class="para">
Attribute referencing a DataObject with
sdo:propertyType - no support for sdo:propertyType="...".
</p>
</li>
<li>
<p class="para">
Attribute with bi-directional property to a DataObject with
sdo:oppositeProperty and sdo:propertyType
- no PHP support for SDO opposite.
</p>
</li>
</ol></div>
<div class="procedure">
<strong class="title">XSD Elements</strong>
<ol type="1"><li>
<p class="para">
Element with sdo:aliasName
- no PHP support for SDO property aliases.
</p>
</li>
<li>
<p class="para">
Element with substitution group.
</p>
</li>
</ol></div>
<div class="procedure">
<strong class="title">XSD Elements with Simple Type</strong>
<ol type="1"><li>
<p class="para">
Element of SimpleType with default
- no PHP support for SDO defaults
</p>
</li>
<li>
<p class="para">
Element of SimpleType with fixed value
- no PHP support for SDO read-only properties or default values.
</p>
</li>
<li>
<p class="para">
Element of SimpleType with sdo:string
- no support for sdo:string="true".
</p>
</li>
<li>
<p class="para">
Element referencing a DataObject with
sdo:propertyType - no support for sdo:propertyType="..."
</p>
</li>
<li>
<p class="para">
Element with bi-directional reference to a DataObject with
sdo:oppositeProperty and sdo:propertyType
- no PHP support for SDO opposite.
</p>
</li>
</ol></div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="sdo-das-xml.addtypes.html">SDO_DAS_XML::addTypes</a> — To load a second or subsequent schema file to a SDO_DAS_XML object</li><li><a href="sdo-das-xml.create.html">SDO_DAS_XML::create</a> — To create SDO_DAS_XML object for a given schema file</li><li><a href="sdo-das-xml.createdataobject.html">SDO_DAS_XML::createDataObject</a> — Creates SDO_DataObject for a given namespace URI and type name</li><li><a href="sdo-das-xml.createdocument.html">SDO_DAS_XML::createDocument</a> — Creates an XML Document object from scratch, without the need to load a document from a file or string.</li><li><a href="sdo-das-xml.loadfile.html">SDO_DAS_XML::loadFile</a> — Returns SDO_DAS_XML_Document object for a given path to xml instance document</li><li><a href="sdo-das-xml.loadstring.html">SDO_DAS_XML::loadString</a> — Returns SDO_DAS_XML_Document for a given xml instance string</li><li><a href="sdo-das-xml.savefile.html">SDO_DAS_XML::saveFile</a> — Saves the SDO_DAS_XML_Document object to a file</li><li><a href="sdo-das-xml.savestring.html">SDO_DAS_XML::saveString</a> — Saves the SDO_DAS_XML_Document object to a string</li><li><a href="sdo-das-xml-document.getrootdataobject.html">SDO_DAS_XML_Document::getRootDataObject</a> — Returns the root SDO_DataObject</li><li><a href="sdo-das-xml-document.getrootelementname.html">SDO_DAS_XML_Document::getRootElementName</a> — Returns root element's name</li><li><a href="sdo-das-xml-document.getrootelementuri.html">SDO_DAS_XML_Document::getRootElementURI</a> — Returns root element's URI string</li><li><a href="sdo-das-xml-document.setencoding.html">SDO_DAS_XML_Document::setEncoding</a> — Sets the given string as encoding</li><li><a href="sdo-das-xml-document.setxmldeclaration.html">SDO_DAS_XML_Document::setXMLDeclaration</a> — Sets the xml declaration</li><li><a href="sdo-das-xml-document.setxmlversion.html">SDO_DAS_XML_Document::setXMLVersion</a> — Sets the given string as xml version</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="sdo-das-xml.examples.html">Examples</a></div>
<div class="next" style="text-align: right; float: right;"><a href="sdo-das-xml.addtypes.html">SDO_DAS_XML::addTypes</a></div>
<div class="up"><a href="book.sdo-das-xml.html">SDO DAS XML</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
