From 662aaa33aa822af727d33425f6f82cf0e240cc52 Mon Sep 17 00:00:00 2001 From: Matthew Peters Date: Thu, 21 Jul 2005 10:14:43 +0000 Subject: [PATCH] WS only. Shorten all lines to 78 chars or less. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@191129 c90b9560-bf6c-de11-be94-00142212c4b1 --- ...-Document-getNoNamespaceSchemaLocation.xml | 6 +- ...SDO-DAS-XML-Document-getXMLDeclaration.xml | 5 +- ...SDO-DAS-XML-Document-setXMLDeclaration.xml | 5 +- .../functions/SDO-DAS-XML-create.xml | 5 +- .../SDO-DAS-XML-createDataObject.xml | 6 +- .../functions/SDO-DAS-XML-loadFromFile.xml | 17 +- .../functions/SDO-DAS-XML-loadFromString.xml | 12 +- reference/sdo_das_xml/reference.xml | 262 +++++++++++++----- 8 files changed, 226 insertions(+), 92 deletions(-) diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getNoNamespaceSchemaLocation.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getNoNamespaceSchemaLocation.xml index d1207abc1a..b2399e7ea9 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getNoNamespaceSchemaLocation.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getNoNamespaceSchemaLocation.xml @@ -1,5 +1,5 @@ - + @@ -12,7 +12,9 @@ &reftitle.description; string - SDO_DAS_XML_Document::getNoNamespaceSchemaLocation + + SDO_DAS_XML_Document::getNoNamespaceSchemaLocation + diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getXMLDeclaration.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getXMLDeclaration.xml index 2d1c51c84c..a0f70d5fea 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getXMLDeclaration.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-getXMLDeclaration.xml @@ -1,5 +1,5 @@ - + @@ -30,7 +30,8 @@ &reftitle.returnvalues; - Returns whether the xml declaration is set or not. TRUE If it is set and FALSE if it is not. + Returns whether the xml declaration is set or not. + TRUE If it is set and FALSE if it is not. diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setXMLDeclaration.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setXMLDeclaration.xml index 3bdf98e1e5..0027827ea3 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setXMLDeclaration.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-Document-setXMLDeclaration.xml @@ -1,5 +1,5 @@ - + @@ -21,7 +21,8 @@ &warn.experimental.func; - Sets the given given boolean value for xml declaration. Pass TRUE to set it and FLASE to not to unset it. + Sets the given given boolean value for xml declaration. + Pass TRUE to set it and FLASE to not to unset it. diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-create.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-create.xml index d5fe21cb91..21f6b14e07 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-create.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-create.xml @@ -1,5 +1,5 @@ - + @@ -21,7 +21,8 @@ &warn.experimental.func; - This is the only static method of SDO_DAS_XML class. used to instantiate SDO_DAS_XML object. + This is the only static method of SDO_DAS_XML class. + Used to instantiate SDO_DAS_XML object. diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-createDataObject.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-createDataObject.xml index 46dbad0b90..e4634ab48d 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-createDataObject.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-createDataObject.xml @@ -1,5 +1,5 @@ - + @@ -25,7 +25,9 @@ &warn.experimental.func; - 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. + 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. diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromFile.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromFile.xml index a92c30dcc4..288e10563a 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromFile.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromFile.xml @@ -1,5 +1,5 @@ - + @@ -21,7 +21,11 @@ &warn.experimental.func; - 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. + 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. @@ -35,7 +39,8 @@ - Path to Instance document. This can be a path to a local file or it can be a URL. + Path to Instance document. + This can be a path to a local file or it can be a URL. @@ -45,7 +50,8 @@ &reftitle.returnvalues; - Returns SDO_DAS_XML_Document object on Success or throws exception as described. + Returns SDO_DAS_XML_Document object on Success or throws + exception as described. @@ -69,7 +75,8 @@ - Thrown if the a property within a type is not defined in the underlying model. + Thrown if the a property within a type is not defined + in the underlying model. diff --git a/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromString.xml b/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromString.xml index 819cf2143d..c45b822e6f 100644 --- a/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromString.xml +++ b/reference/sdo_das_xml/functions/SDO-DAS-XML-loadFromString.xml @@ -1,5 +1,5 @@ - + @@ -21,7 +21,9 @@ &warn.experimental.func; - 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. + 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. @@ -45,7 +47,8 @@ &reftitle.returnvalues; - Returns SDO_DAS_XML_Document object on Success or throws exception as described. + Returns SDO_DAS_XML_Document object on Success + or throws exception as described. @@ -69,7 +72,8 @@ - Thrown if the a property within a type is not defined in the underlying model. + Thrown if the a property within a type is not defined + in the underlying model. diff --git a/reference/sdo_das_xml/reference.xml b/reference/sdo_das_xml/reference.xml index c7552aed7d..a3d93efc84 100644 --- a/reference/sdo_das_xml/reference.xml +++ b/reference/sdo_das_xml/reference.xml @@ -1,5 +1,5 @@ - + SDO XML Data Access Service Functions @@ -13,30 +13,40 @@ &warn.experimental; - 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 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 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). + The XML DAS currently supports reading/writing XML + to/from a file or an http URL (for example, to support RSS feeds).
&reftitle.required; - 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 SDO installation instructions for steps on how to do this. - +
@@ -49,29 +59,38 @@
+
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: + 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 - Simple Type with abstract="true" - no PHP support for SDO abstract types. + Simple Type with abstract="true" + - no PHP support for SDO abstract types. - Simple Type with sdoJava:instanceClass - no PHP equivalent provided. + Simple Type with sdoJava:instanceClass + - no PHP equivalent provided. - Simple Type with sdoJava:extendedInstanceClass - no PHP equivalent provided. + Simple Type with sdoJava:extendedInstanceClass + - no PHP equivalent provided. @@ -90,22 +109,26 @@ XML Complex Types - Complex Type with abstract="true" - no PHP support for SDO abstract types. + Complex Type with abstract="true" + - no PHP support for SDO abstract types. - Complex Type with sdo:aliasName - no PHP support for SDO Type aliases. + Complex Type with sdo:aliasName + - no PHP support for SDO Type aliases. - Complex Type with open content - no PHP support for SDO open types. + Complex Type with open content + - no PHP support for SDO open types. - Complex Type with open attribute - no PHP support for SDO open types. + Complex Type with open attribute + - no PHP support for SDO open types. @@ -114,17 +137,20 @@ XSD Attribute - Attribute with sdo:aliasName - no PHP support for SDO property aliases. + Attribute with sdo:aliasName + - no PHP support for SDO property aliases. - Attribute with default value - no PHP support for SDO property defaults. + Attribute with default value + - no PHP support for SDO property defaults. - 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. @@ -134,17 +160,21 @@ - Attribute with sdo:string - no support for sdo:string="true". + Attribute with sdo:string + - no support for sdo:string="true". - Attribute referencing a DataObject with sdo:propertyType - no support for sdo:propertyType="...". + Attribute referencing a DataObject with + sdo:propertyType - no support for sdo:propertyType="...". - 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. @@ -153,7 +183,8 @@ XSD Elements - Element with sdo:aliasName - no PHP support for SDO property aliases. + Element with sdo:aliasName + - no PHP support for SDO property aliases. @@ -177,27 +208,33 @@ XSD Elements with Simple Type - Element of SimpleType with default - no PHP support for SDO defaults + Element of SimpleType with default + - no PHP support for SDO defaults - 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. - Element of SimpleType with sdo:string - no support for sdo:string="true". + Element of SimpleType with sdo:string + - no support for sdo:string="true". - Element referencing a DataObject with sdo:propertyType - no support for sdo:propertyType="..." + Element referencing a DataObject with + sdo:propertyType - no support for sdo:propertyType="..." - 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. @@ -212,24 +249,37 @@ described in the SDO documentation . - 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 letter.xsd and the letter instance is in the file letter.xml - . + . 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. + 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. - 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(( + 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. -createDataObject("companyNS", "CompanyType"); @@ -281,12 +335,15 @@ var_dump($do); 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 + 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. - 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. + 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. - &reftitle.classes; - 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. + 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.
@@ -357,56 +422,78 @@ try { 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. + 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.
&reftitle.methods; create - This is the only static method available in SDO_DAS_XML class. Used to construct SDO_XML_DAS object. + This is the only static method available in SDO_DAS_XML class. + Used to construct SDO_XML_DAS object. - createDataObject + + 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. + + 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. + + loadFromString + + same as the above method. + Loads the xml instance which is available as string. - saveDataObjectToFile + + saveDataObjectToFile + save SDO_DataObject to a file. - saveDataObjectToString + + saveDataObjectToString + save SDO_DataObject to a xml file. - saveDocumentToFile + + saveDocumentToFile + save SDO_DAS_XML_Document object as a xml file. - saveDocumentToString + + saveDocumentToString + save SDO_DAS_XML_Document object as a xml string. @@ -421,94 +508,123 @@ try { SDO_DAS_XML_Document - This class can be used to get/set XML Declarations such as encoding, schema location etc. + This class can be used to get/set XML Declarations such as encoding, + schema location etc. -
&reftitle.methods; +
+ &reftitle.methods; - getEncoding + + getEncoding + gets the encoding string. - getNoNamespaceSchemaLocation + + getNoNamespaceSchemaLocation + gets the no namespace schema location. - getRootDataObject + + getRootDataObject + gets the root DataObject. - getRootElementName + + getRootElementName + gets the root DataObject's name. - getRootElementURI + + getRootElementURI + gets the root DataObject's URI. - getSchemaLocation + + getSchemaLocation + gets schema location. - getXMLDeclaration + + getXMLDeclaration + gets whether xml declaration is set ot not. - getXMLVersion + + getXMLVersion + gets the xml version. - setEncoding + + setEncoding + sets the encoding string with the given value. - setNoNamespaceSchemaLocation + + setNoNamespaceSchemaLocation + sets the no namespace schema location with the given value. - setSchemaLocation + + setSchemaLocation + sets the schema location with the given value. - setXMLDeclaraion + + setXMLDeclaraion + to set/unset the xml declaration. + - setXMLVersion + + setXMLVersion + sets the xml version with the given value.