PHP Manualen
forrige |  | næste

# CXVIII. SDO XML Data Access Service Functions

# Introduktion

Advarsel
Denne udvidelse er EKSPERIMENTABEL. Virkemåden af denne udvidelse -- inklusiv navnene på des funktioner og alt andet dokumenteret om udvidelsen -- ændres muligvis uden advarsel, i en fremtidig version af PHP. Brug af denne udvidelse er på ejet ansvar.

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 the section on SDO .

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 XML DAS currently supports reading/writing XML to/from a file or an http URL (for example, to support RSS feeds).

# Systemkrav

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 SDO installation instructions for steps on how to do this.

# Installation

The XML Data Access Service is packaged and installed as part of the SDO extension . There are additional installations steps required.

# Limitations

The SDO 2.0 specification 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:

XML Simple Types

1. Simple Type with abstract="true" - no PHP support for SDO abstract types.

2. Simple Type with sdoJava:instanceClass - no PHP equivalent provided.

3. Simple Type with sdoJava:extendedInstanceClass - no PHP equivalent provided.

4. Simple Type with list of itemType.

5. Simple Type with union.

XML Complex Types

1. Complex Type with abstract="true" - no PHP support for SDO abstract types.

2. Complex Type with sdo:aliasName - no PHP support for SDO Type aliases.

3. Complex Type with open content - no PHP support for SDO open types.

4. Complex Type with open attribute - no PHP support for SDO open types.

XSD Attribute

1. Attribute with sdo:aliasName - no PHP support for SDO property aliases.

2. Attribute with default value - no PHP support for SDO property defaults.

3. Attribute with fixed value - no PHP support for SDO read-only properties or default values.

4. Attribute reference.

5. Attribute with sdo:string - no support for sdo:string="true".

6. Attribute referencing a DataObject with sdo:propertyType - no support for sdo:propertyType="...".

7. Attribute with bi-directional property to a DataObject with sdo:oppositeProperty and sdo:propertyType - no PHP support for SDO opposite.

XSD Elements

1. Element with sdo:aliasName - no PHP support for SDO property aliases.

2. Element reference.

3. Element with nillable.

4. Element with substitution group.

XSD Elements with Simple Type

1. Element of SimpleType with default - no PHP support for SDO defaults

2. Element of SimpleType with fixed value - - no PHP support for SDO read-only properties or default values.

3. Element of SimpleType with sdo:string - no support for sdo:string="true".

4. Element referencing a DataObject with sdo:propertyType - no support for sdo:propertyType="..."

5. Element with bi-directional reference to a DataObject with sdo:oppositeProperty and sdo:propertyType - no PHP support for SDO opposite.

# Eksempler

The following examples are based on the letter example described in the SDO documentation . The examples assume the XML Schema for the letter is contained in a the file `letter.xsd` and the letter instance is in the file `letter.xml` .

Eksempel 1. Working with the SDO_DAS_XML Class

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.

`<?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");
}
?>`

Eksempel 2. Working with the SDO_DAS_XML Class

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(( company.xsd )) as defined in SDO samples section.

`<?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);
?>`

Eksempel 3. Working with the SDO_DAS_XML Class

This example shows you how to create the DataObject and use the Sequence API ( For more information on Sequence API ) to construct a letter containing unstructured text.

`<?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");
}
?>`

Eksempel 4. Working with the SDO_DAS_XML_Document Class

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.

`<?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");
}
?>`

# Foruddefinerede Klasser

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.

## SDO_DAS_XML

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.

### Metoder

- create This is the only static method available in SDO_DAS_XML class. Used to construct SDO_XML_DAS object.

- createDataObject Can be used to construct the DataObject of a given type.

- loadFromFile Loads the xml instance document from a file. This file can be at local file system or it can be on a remote host.

- loadFromString same as the above method. loads the xml instance which is available as string.

- saveDataObjectToFile save SDO_DataObject to a file.

- saveDataObjectToString save SDO_DataObject to a xml file.

- saveDocumentToFile save SDO_DAS_XML_Document object as a xml file.

- saveDocumentToString save SDO_DAS_XML_Document object as a xml string.

## SDO_DAS_XML_Document

This class can be used to get/set XML Declarations such as encoding, schema location etc.

### Metoder

- getEncoding gets the encoding string.

- getNoNamespaceSchemaLocation gets the no namespace schema location.

- getRootDataObject gets the root DataObject.

- getRootElementName gets the root DataObject's name.

- getRootElementURI gets the root DataObject's URI.

- getSchemaLocation gets schema location.

- getXMLDeclaration gets whether xml declaration is set ot not.

- getXMLVersion gets the xml version.

- setEncoding sets the encoding string with the given value.

- setNoNamespaceSchemaLocation sets the no namespace schema location with the given value.

- setSchemaLocation sets the schema location with the given value.

- setXMLDeclaraion to set/unset the xml declaration.

- setXMLVersion sets the xml version with the given value.

## SDO_DAS_XML_ParserException

Is a subclass of SDO_Exception . Thrown for any parser errors while loading the xsd/xml file.

forrige | hjem | næste
runkit_superglobals | op | SDO_DAS_XML_Document::getEncoding