|
|
|
|
@ -1,5 +1,5 @@
|
|
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
|
|
|
<!-- $Revision: 1.3 $ -->
|
|
|
|
|
<!-- $Revision: 1.4 $ -->
|
|
|
|
|
<!-- 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>
|
|
|
|
|
@ -13,30 +13,40 @@
|
|
|
|
|
&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.
|
|
|
|
|
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.
|
|
|
|
|
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).
|
|
|
|
|
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.
|
|
|
|
|
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>
|
|
|
|
|
</para>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section id="sdo-das-xml.installation">
|
|
|
|
|
@ -49,29 +59,38 @@
|
|
|
|
|
</para>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id='sdo-das-xml.limitations'>
|
|
|
|
|
<title>Limitations</title>
|
|
|
|
|
<para>
|
|
|
|
|
The
|
|
|
|
|
<ulink url='&url.ibm.sdo;'>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:
|
|
|
|
|
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.
|
|
|
|
|
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.
|
|
|
|
|
Simple Type with sdoJava:instanceClass
|
|
|
|
|
- no PHP equivalent provided.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
<step>
|
|
|
|
|
<para>
|
|
|
|
|
Simple Type with sdoJava:extendedInstanceClass - no PHP equivalent provided.
|
|
|
|
|
Simple Type with sdoJava:extendedInstanceClass
|
|
|
|
|
- no PHP equivalent provided.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
<step>
|
|
|
|
|
@ -90,22 +109,26 @@
|
|
|
|
|
<title>XML Complex Types</title>
|
|
|
|
|
<step>
|
|
|
|
|
<para>
|
|
|
|
|
Complex Type with abstract="true" - no PHP support for SDO abstract types.
|
|
|
|
|
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.
|
|
|
|
|
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.
|
|
|
|
|
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.
|
|
|
|
|
Complex Type with open attribute
|
|
|
|
|
- no PHP support for SDO open types.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
</procedure>
|
|
|
|
|
@ -114,17 +137,20 @@
|
|
|
|
|
<title>XSD Attribute</title>
|
|
|
|
|
<step>
|
|
|
|
|
<para>
|
|
|
|
|
Attribute with sdo:aliasName - no PHP support for SDO property aliases.
|
|
|
|
|
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.
|
|
|
|
|
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.
|
|
|
|
|
Attribute with fixed value
|
|
|
|
|
- no PHP support for SDO read-only properties or default values.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
<step>
|
|
|
|
|
@ -134,17 +160,21 @@
|
|
|
|
|
</step>
|
|
|
|
|
<step>
|
|
|
|
|
<para>
|
|
|
|
|
Attribute with sdo:string - no support for sdo:string="true".
|
|
|
|
|
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="...".
|
|
|
|
|
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.
|
|
|
|
|
Attribute with bi-directional property to a DataObject with
|
|
|
|
|
sdo:oppositeProperty and sdo:propertyType
|
|
|
|
|
- no PHP support for SDO opposite.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
</procedure>
|
|
|
|
|
@ -153,7 +183,8 @@
|
|
|
|
|
<title>XSD Elements</title>
|
|
|
|
|
<step>
|
|
|
|
|
<para>
|
|
|
|
|
Element with sdo:aliasName - no PHP support for SDO property aliases.
|
|
|
|
|
Element with sdo:aliasName
|
|
|
|
|
- no PHP support for SDO property aliases.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
<step>
|
|
|
|
|
@ -177,27 +208,33 @@
|
|
|
|
|
<title>XSD Elements with Simple Type</title>
|
|
|
|
|
<step>
|
|
|
|
|
<para>
|
|
|
|
|
Element of SimpleType with default - no PHP support for SDO defaults
|
|
|
|
|
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.
|
|
|
|
|
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".
|
|
|
|
|
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="..."
|
|
|
|
|
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.
|
|
|
|
|
Element with bi-directional reference to a DataObject with
|
|
|
|
|
sdo:oppositeProperty and sdo:propertyType
|
|
|
|
|
- no PHP support for SDO opposite.
|
|
|
|
|
</para>
|
|
|
|
|
</step>
|
|
|
|
|
</procedure>
|
|
|
|
|
@ -212,24 +249,37 @@
|
|
|
|
|
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
|
|
|
|
|
The examples assume the XML Schema for the letter is contained in a 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.
|
|
|
|
|
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">
|
|
|
|
|
<
Matthew Peters