cvs: phpdoc /en/reference/sdo reference.xml /en/reference/sdo/functions SDO-DAS-ChangeSummary-getChangeType.xml
SDO-DAS-ChangeSummary-getChangedDataObjects.xml SDO-DAS-ChangeSummary-getOldContainer.xml SDO-DAS-ChangeSummary-getOldValues.xml
SDO-DAS-DataFactory-addPropertyToType.xml SDO-DAS-DataFactory-addType.xml SDO-DAS-DataFactory-getDataFactory.xml
SDO-DAS-DataObject-getChangeSummary.xml SDO-DAS-Setting-getListIndex.xml SDO-DAS-Setting-getPropertyIndex.xml SDO-DAS-Setting-getPropertyName.xml
SDO-DAS-Setting-getValue.xml SDO-DAS-Setting-isSet.xml SDO-DataFactory-create.xml SDO-DataObject-clear.xml SDO-DataObject-createDataObject.xml
SDO-DataObject-getContainer.xml SDO-DataObject-getContainmentPropertyName.xml SDO-DataObject-getSequence.xml SDO-DataObject-getType.xml
SDO-List-insert.xml SDO-Sequence-getPropertyIndex.xml SDO-Sequence-getPropertyName.xml SDO-Sequence-insert.xml SDO-Sequence-move.xml

mfp Thu Jul 21 05:27:12 2005 EDT Modified files: /phpdoc/en/reference/sdo/functions SDO-Sequence-getPropertyIndex.xml SDO-DataObject-getContainmentPropertyName.xml SDO-Sequence-move.xml SDO-DAS-ChangeSummary-getOldContainer.xml SDO-DataObject-clear.xml SDO-DAS-DataFactory-addType.xml SDO-DAS-Setting-getValue.xml SDO-DAS-ChangeSummary-getChangeType.xml SDO-DAS-Setting-getPropertyIndex.xml SDO-DAS-Setting-getListIndex.xml SDO-DAS-ChangeSummary-getChangedDataObjects.xml SDO-DataObject-getContainer.xml SDO-DAS-Setting-isSet.xml SDO-DataObject-createDataObject.xml SDO-Sequence-getPropertyName.xml SDO-Sequence-insert.xml SDO-DAS-ChangeSummary-getOldValues.xml SDO-DataObject-getSequence.xml SDO-List-insert.xml SDO-DAS-DataFactory-getDataFactory.xml SDO-DataObject-getType.xml SDO-DataFactory-create.xml SDO-DAS-DataObject-getChangeSummary.xml SDO-DAS-Setting-getPropertyName.xml SDO-DAS-DataFactory-addPropertyToType.xml /phpdoc/en/reference/sdo reference.xml Log: WS only. Shorten all lines to 78 chars or less.

http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-Sequence-getPropertyIndex"> <refnamediv> @@ -23,7 +23,8 @@ <para> Return the property index for the specified sequence index. - If the sequence item is unstructured text rather than a data object property, then a value of -1 is returned. + If the sequence item is unstructured text rather than a + data object property, then a value of -1 is returned. </para> </refsect1> @@ -37,7 +38,8 @@ </term> <listitem> <para> - The sequence index for which we wish to determine the associated data object property index. + The sequence index for which we wish to determine + the associated data object property index. </para> </listitem> </varlistentry> @@ -47,7 +49,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The corresponding property index. A value of -1 means the element does not belong to a property and must therefore be unstructured text. + The corresponding property index. A value of -1 means the element + does not belong to a property and must therefore be unstructured text. </para> </refsect1> @@ -61,7 +64,8 @@ </term> <listitem> <para> - Thrown if the sequence index is less than zero or greater than the size of the sequence. + Thrown if the sequence index is less than zero or greater than the + size of the sequence. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getContainmentPropertyName"> <refnamediv> @@ -19,7 +19,8 @@ &warn.experimental.func; <para> - Get the property name used to refer to this data object by its containing data object. + Get the property name used to refer to this data object + by its containing data object. </para> </refsect1> @@ -32,7 +33,10 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the name of the container's property which references this SDO_DataObject, or returns NULL if this is a root SDO_DataObject (i.e. it has no container). + Returns the name of the container's property which references + this SDO_DataObject, + or returns NULL if this is a root SDO_DataObject + (i.e. it has no container). </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-Sequence-move"> <refnamediv> @@ -26,7 +26,8 @@ &warn.experimental.func; <para> - Modify the position of the item in the sequence, without altering the value of the property in the SDO_DataObject. + Modify the position of the item in the sequence, + without altering the value of the property in the SDO_DataObject. </para> </refsect1> @@ -40,7 +41,9 @@ </term> <listitem> <para> - The destination sequence index. If this index is less than zero or greater than the size of the sequence then the value is appended. + The destination sequence index. + If this index is less than zero or greater than the + size of the sequence then the value is appended. </para> </listitem> </varlistentry> @@ -75,7 +78,8 @@ </term> <listitem> <para> - Thrown if the fromIndex sequence index is less than zero or greater than the size of the sequence. + Thrown if the fromIndex sequence index is less than zero + or greater than the size of the sequence. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldContainer"> <refnamediv> @@ -37,7 +37,8 @@ </term> <listitem> <para> - The SDO_DataObject which has been deleted and whose container we wish to identify. + The SDO_DataObject which has been deleted and whose + container we wish to identify. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DataObject-clear"> <refnamediv> @@ -19,7 +19,8 @@ &warn.experimental.func; <para> - Clear an SDO_DataObject's properties. Read-only properties are unaffected. + Clear an SDO_DataObject's properties. + Read-only properties are unaffected. Subsequent calls to isset() for the data object will return &false;. </para> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DAS-DataFactory-addType"> <refnamediv> @@ -26,8 +26,10 @@ &warn.experimental.func; <para> - Add a new type to the SDO_DAS_DataFactory, defined by its namespace and type name. - The type becomes part of the model of data objects that the data factory can create. + Add a new type to the SDO_DAS_DataFactory, + defined by its namespace and type name. + The type becomes part of the model of data objects + that the data factory can create. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-Setting-getValue"> <refnamediv> @@ -20,9 +20,12 @@ <para> Returns the old value for the changed property. - This can be used by a Data Access Service when writing updates to a data source. - The DAS uses the old value to detect conflicts by comparing it with the current value in the data source. - If they do not match, then the data source has been updated since the data object was originally populated, and therefore + This can be used by a Data Access Service when + writing updates to a data source. + The DAS uses the old value to detect conflicts by comparing + it with the current value in the data source. + If they do not match, then the data source has been updated + since the data object was originally populated, and therefore writing any new updates risks compromising the integrity of the data. </para> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DAS-ChangeSummary-getChangeType"> <refnamediv> @@ -46,7 +46,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The type of change which has been made. The change type is expressed as an enumeration and will be one of the following four values: + The type of change which has been made. The change type is expressed as an + enumeration and will be one of the following four values: <itemizedlist> <listitem> <para> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-Setting-getPropertyIndex"> <refnamediv> @@ -19,7 +19,8 @@ &warn.experimental.func; <para> - Returns the property index for the changed property. This index identifies the property which was modified in data object. + Returns the property index for the changed property. + This index identifies the property which was modified in data object. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DAS-Setting-getListIndex"> <refnamediv> @@ -19,8 +19,12 @@ &warn.experimental.func; <para> - Get the list index for a modification made to an element of a many-valued property. For example, if we modified the third element of a many-valued property - we could obtain an SDO_DAS_Setting from the change summary corresponding to that modification. + Get the list index for a modification made to an element of a + many-valued property. + For example, if we modified the third element of a + many-valued property + we could obtain an SDO_DAS_Setting from the + change summary corresponding to that modification. A call to <function>getListIndex</function> on that setting would return the value 2 (lists are indexed from zero). @@ -36,7 +40,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The list index for the element of the many-valued property which has been changed. + The list index for the element of the many-valued property which + has been changed. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getChangedDataObjects"> <refnamediv> @@ -20,7 +20,8 @@ <para> Get an SDO_List of the SDO_DataObjects which have been changed. - These data objects can then be used to identify the types of change made to each, along with the old values. + These data objects can then be used to identify the types + of change made to each, along with the old values. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getContainer"> <refnamediv> @@ -22,7 +22,6 @@ Get the data object which contains this data object. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -33,8 +32,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the SDO_DataObject which contains this SDO_DataObject, or returns NULL - if this is a root SDO_DataObject (i.e. it has no container). + Returns the SDO_DataObject which contains this SDO_DataObject, + or returns NULL if this is a root SDO_DataObject + (i.e. it has no container). </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DAS-Setting-isSet"> <refnamediv> @@ -20,7 +20,8 @@ <para> Test whether a property was set prior to being modified. - If it was set prior to being modified then the SDO_DAS_Setting will also contain the old value. + If it was set prior to being modified then the SDO_DAS_Setting + will also contain the old value. </para> </refsect1> @@ -33,7 +34,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns &true; if the property was set prior to being modified, otherwise returns &false;. + Returns &true; if the property was set prior to being modified, + otherwise returns &false;. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DataObject-createDataObject"> <refnamediv> @@ -22,8 +22,10 @@ &warn.experimental.func; <para> - Create a child SDO_DataObject of the default type for the property identified. - The data object is automatically inserted into the tree and a reference to it is returned. + Create a child SDO_DataObject of the default type for the + property identified. + The data object is automatically inserted into the tree + and a reference to it is returned. </para> @@ -38,7 +40,8 @@ </term> <listitem> <para> - Identifies the property for the data object type to be created. Can be either a property name (string), + Identifies the property for the data object type to be created. + Can be either a property name (string), or property index (int). </para> </listitem> @@ -63,7 +66,8 @@ </term> <listitem> <para> - Thrown if the identifier does not correspond to a property of the data object. + Thrown if the identifier does not correspond to a + property of the data object. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-Sequence-getPropertyName"> <refnamediv> @@ -23,7 +23,8 @@ <para> Return the property name for the specified sequence index. - If the sequence item is unstructured text rather than a data object property, then a value of NULL is returned. + If the sequence item is unstructured text rather than a + data object property, then a value of NULL is returned. </para> @@ -38,7 +39,8 @@ </term> <listitem> <para> - The sequence index for which we wish to determine the associated data object property name. + The sequence index for which we wish to determine the associated + data object property name. </para> </listitem> </varlistentry> @@ -48,7 +50,9 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The corresponding property name. A value of NULL means the element does not belong to a property and must therefore be unstructured text. + The corresponding property name. + A value of NULL means the element does not belong to a property + and must therefore be unstructured text. </para> </refsect1> @@ -62,7 +66,8 @@ </term> <listitem> <para> - Thrown if the sequence index is less than zero or greater than the size of the sequence. + Thrown if the sequence index is less than zero or greater than the + size of the sequence. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-Sequence-insert"> <refnamediv> @@ -30,7 +30,8 @@ &warn.experimental.func; <para> - Insert a new element at a specified position in the sequence. All subsequent sequence items are moved up. + Insert a new element at a specified position in the sequence. + All subsequent sequence items are moved up. </para> </refsect1> @@ -44,7 +45,8 @@ </term> <listitem> <para> - The new value to be inserted. This can be either a primitive or an SDO_DataObject. + The new value to be inserted. + This can be either a primitive or an SDO_DataObject. </para> </listitem> </varlistentry> @@ -54,7 +56,9 @@ </term> <listitem> <para> - The position at which to insert the new element. Default is NULL, which results in the new value being appended to the sequence. + The position at which to insert the new element. + Default is NULL, which results in the new value being + appended to the sequence. </para> </listitem> </varlistentry> @@ -64,7 +68,10 @@ </term> <listitem> <para> - Either a property index or property name, used to identify a property in the sequence's corresponding SDO_DataObject. A value of NULL signifies unstructured text. + Either a property index or property name, + used to identify a property in the sequence's + corresponding SDO_DataObject. + A value of NULL signifies unstructured text. </para> </listitem> </varlistentry> @@ -89,7 +96,8 @@ </term> <listitem> <para> - Thrown if the sequence index is less than zero or greater than the size of the sequence. + Thrown if the sequence index is less than + zero or greater than the size of the sequence. </para> </listitem> </varlistentry> @@ -99,7 +107,8 @@ </term> <listitem> <para> - Thrown if the type of the new value cannot be juggled to match the type for the specified data object property. + Thrown if the type of the new value cannot be juggled + to match the type for the specified data object property. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldValues"> <refnamediv> @@ -23,7 +23,8 @@ <para> Get a list of the old values for a given changed SDO_DataObject. - Returns a list of SDO_DAS_Settings describing the old values for the changed properties of the SDO_DataObject. + Returns a list of SDO_DAS_Settings describing the old values for + the changed properties of the SDO_DataObject. </para> @@ -48,7 +49,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - A list of SDO_DAS_Settings describing the old values for the changed properties of the SDO_DataObject + A list of SDO_DAS_Settings describing the old values for the + changed properties of the SDO_DataObject </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getSequence"> <refnamediv> @@ -19,9 +19,10 @@ &warn.experimental.func; <para> - Return the SDO_Sequence for this SDO_DataObject. Accessing the SDO_DataObject - through the SDO_Sequence interface acts on the same SDO_DataObject instance - data, but preserves ordering across properties. + Return the SDO_Sequence for this SDO_DataObject. + Accessing the SDO_DataObject through the SDO_Sequence interface + acts on the same SDO_DataObject instance data, + but preserves ordering across properties. </para> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-List-insert.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-List-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-List-insert.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-List-insert"> <refnamediv> @@ -26,7 +26,8 @@ &warn.experimental.func; <para> - Insert a new element at a specified position in the list. All subsequent list items are moved up. + Insert a new element at a specified position in the list. + All subsequent list items are moved up. </para> </refsect1> @@ -40,7 +41,8 @@ </term> <listitem> <para> - The new value to be inserted. This can be either a primitive or an SDO_DataObject. + The new value to be inserted. + This can be either a primitive or an SDO_DataObject. </para> </listitem> </varlistentry> @@ -50,7 +52,8 @@ </term> <listitem> <para> - The position at which to insert the new element. If this argument is not specified then the new value will be appended. + The position at which to insert the new element. + If this argument is not specified then the new value will be appended. </para> </listitem> </varlistentry> @@ -74,7 +77,8 @@ </term> <listitem> <para> - Thrown if the list index is less than zero or greater than the size of the list. + Thrown if the list index is less than zero or greater + than the size of the list. </para> </listitem> </varlistentry> @@ -84,7 +88,9 @@ </term> <listitem> <para> - Thrown if the type of the new value does not match the type for the list (e.g. the type of the many-valued property that the list represents). + Thrown if the type of the new value does not match the type + for the list + (e.g. the type of the many-valued property that the list represents). </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataFactory-getDataFactory"> <refnamediv> @@ -20,11 +20,13 @@ &warn.experimental.func; <para> - Static method to get an instance of an SDO_DAS_DataFactory. This instance is initially only - configured with the basic SDO types. A Data Access Service is responsible for populating - the data factory model and then allowing PHP applications to create SDOs based on the model - through the SDO_DataFactory interface. - PHP applications should always obtain a data factory from a configured Data Access Service, not through this interface. + Static method to get an instance of an SDO_DAS_DataFactory. + This instance is initially only configured with the basic SDO types. + A Data Access Service is responsible for populating + the data factory model and then allowing PHP applications + to create SDOs based on the model through the SDO_DataFactory interface. + PHP applications should always obtain a data factory from a + configured Data Access Service, not through this interface. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DataObject-getType"> <refnamediv> @@ -34,7 +34,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - An array containing the namespace URI string and the type name string for the data object. + An array containing the namespace URI string and the type name + string for the data object. </para> </refsect1> @@ -79,14 +80,15 @@ <example> <title>A <function>SDO_DataObject::getType</function> -example</title> + example + </title> <para> -For example, if the SDO_DataObject were of type 'CompanyType' from -the namespace 'CompanyNS', then getType() would return the equivalent to -array('CompanyNS', 'CompanyType'): + For example, if the SDO_DataObject were of type 'CompanyType' from + the namespace 'CompanyNS', then getType() would return the equivalent to + array('CompanyNS', 'CompanyType'): </para> <programlisting role="php"> - <![CDATA[ +<![CDATA[ <?php $do_type = $company_do->getType(); echo "Namespace: $do_type[0], Type Name: $do_type[1]"; @@ -95,7 +97,7 @@ </programlisting> &example.outputs; <screen> - <![CDATA[ +<![CDATA[ Namespace: CompanyNS, Type Name: CompanyType ]]> </screen> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataFactory-create"> <refnamediv> @@ -26,7 +26,8 @@ &warn.experimental.func; <para> - Create a new SDO_DataObject given the data object's namespace URI and type name. + Create a new SDO_DataObject given the data object's + namespace URI and type name. </para> </refsect1> @@ -74,7 +75,8 @@ </term> <listitem> <para> - Thrown if the namespaceURI and typeName do not correspond to a type known to this data factory. + Thrown if the namespaceURI and typeName do not + correspond to a type known to this data factory. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataObject-getChangeSummary"> <refnamediv> @@ -19,7 +19,8 @@ &warn.experimental.func; <para> - Get the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, or NULL if it does not have one. + Get the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, + or NULL if it does not have one. </para> </refsect1> @@ -32,7 +33,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, or NULL if it does not have one. + Returns the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, + or NULL if it does not have one. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.2 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml Thu Jul 21 05:27:07 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-Setting-getPropertyName"> <refnamediv> @@ -19,7 +19,8 @@ &warn.experimental.func; <para> - Returns the property name for the changed property. This name identifies the property which was modified in data object. + Returns the property name for the changed property. + This name identifies the property which was modified in data object. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.3 Wed Jul 20 10:01:03 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml Thu Jul 21 05:27:07 2005 @@ -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. --> <refentry id="function.SDO-DAS-DataFactory-addPropertyToType"> <refnamediv> @@ -118,7 +118,8 @@ <listitem> <para> A flag to say whether the property is many-valued. - A value of 'true' adds the property as a many-valued property (default is 'false') + A value of 'true' adds the property as a many-valued property + (default is 'false') </para> </listitem> </varlistentry> @@ -129,7 +130,8 @@ <listitem> <para> A flag to say whether the property is read-only. - A value of 'true' means the property value cannot be modified through the SDO application APIs (default is 'false') + A value of 'true' means the property value cannot be modified + through the SDO application APIs (default is 'false') </para> </listitem> </varlistentry> @@ -141,8 +143,10 @@ <para> A flag to say whether the property is contained by the parent. A value of 'true' means the property is contained by the parent. - A value of 'false' results in a non-containment reference (default is 'true'). - This flag is only interpreted when adding properties which are data object types, otherwise it is ignored. + A value of 'false' results in a non-containment reference + (default is 'true'). + This flag is only interpreted when adding properties which + are data object types, otherwise it is ignored. </para> </listitem> </varlistentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/reference.xml?r1=1.3&r2=1.4&ty=u Index: phpdoc/en/reference/sdo/reference.xml diff -u phpdoc/en/reference/sdo/reference.xml:1.3 phpdoc/en/reference/sdo/reference.xml:1.4 --- phpdoc/en/reference/sdo/reference.xml:1.3 Wed Jul 20 06:21:32 2005 +++ phpdoc/en/reference/sdo/reference.xml Thu Jul 21 05:27:10 2005 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <reference id="ref.sdo"> <title>SDO Functions</title> @@ -19,30 +19,35 @@ hetergeneous data sources, such as relational databases and XML. </para> <para> - SDOs are based on the concept of disconnected data graphs. A data - graph is a tree structure of data objects, navigable via their containment - references. A containment reference is an aggregation relationship. For - example, a Company data object might consists of a number of Department - data objects and therefore the Company would have a containment - reference to the Departments. A data graph also allows non-containment - references. These are references between data objects within the same - tree. For example, one Employee data object might reference another + SDOs are based on the concept of disconnected data graphs. + A data graph is a tree structure of data objects, navigable via their + containment references. + A containment reference is an aggregation relationship. + For example, a Company data object might consists of a number of + Department data objects and therefore the Company would have + a containment reference to the Departments. + A data graph also allows non-containment references. + These are references between data objects within the same tree. + For example, one Employee data object might reference another to identify a career mentor. </para> <para> The task of connecting an application to a data source is - performed by a Data Access Service (DAS). Applications use a DAS to retrieve - an SDO from a data source. The application can then manipulate the - SDO and use a DAS to write it back to the same, or an alternative, - data source. + performed by a Data Access Service (DAS). + Applications use a DAS to retrieve an SDO from a data source. + The application can then manipulate the SDO and use a DAS to write + it back to the same, or an alternative, data source. </para> <para> See the <link linkend="sdo.das.table">list of Data Access Services</link> for details on those currently available. In addition to the provided DASs, SDO also - provides interfaces to enable others to be implemented (see the section on - <link linkend="sdo.class.sdo-das-spis">SDO Data Access Services Interface</link> + provides interfaces to enable others to be implemented + (see the section on + <link linkend="sdo.class.sdo-das-spis"> + SDO Data Access Services Interface + </link> for more details). </para> <para> @@ -72,15 +77,19 @@ &reftitle.install; <warning> <para> - An automated installation process using PEAR will be supplied soon. - Meanwhile, you can build the extension manually using the steps below. + An automated installation process using PEAR will be + supplied soon. + Meanwhile, you can build the extension manually using the + steps below. </para> </warning> <procedure id='sdo.installation.linux.steps'> <title>Linux intallation steps</title> <para> - The following instructions describe how to install the SDO extension on Linux. Note, these - steps will also install the + The following instructions describe how to install the + SDO extension + on Linux. + Note, these steps will also install the <link linkend="ref.sdo-das-xml">XML Data Access Service</link> which is packaged as part of this extension. </para> @@ -99,7 +108,8 @@ </step> <step> <para> - The SDO and SDO_DAS_XML are implemented as a separate internal 'core' C++ libraries which must be built before building the main extension. + The SDO and SDO_DAS_XML are implemented as a separate internal 'core' + C++ libraries which must be built before building the main extension. This can be done by using the following steps: </para> <procedure id='sdo.installation.linux.substeps'> @@ -152,7 +162,8 @@ <para> Run <command>phpize</command> - , which will set up the environment to compile both SDO and the XML Data Access Service. + , which will set up the environment to compile both SDO and the + XML Data Access Service. </para> </step> <step> @@ -161,7 +172,8 @@ <command>./configure; make; make install</command> </para> <para> - Note, the compilation process checks for internal 'core' library which was installed in the previous build steps. + Note, the compilation process checks for internal 'core' library + which was installed in the previous build steps. </para> <para> Note, if you used @@ -206,7 +218,8 @@ </entry> <entry> An XML Data Access Service supporting reading/writing - SDOs as XML documents or via a Web URL to supporting things like RSS feeds. + SDOs as XML documents or via a Web URL to supporting things like + RSS feeds. </entry> </row> <row> @@ -214,8 +227,9 @@ <link linkend="ref.sdo.das.rel">SDO_DAS_Relational</link> </entry> <entry> - A PDO-based Data Access Service supporting reading/writing SDO to relational - data sources. Implements an optimistic concurrency policy for updates. + A PDO-based Data Access Service supporting reading/writing SDO + to relational data sources. + Implements an optimistic concurrency policy for updates. </entry> </row> </tbody> @@ -238,27 +252,33 @@ </step> <step> <para> - The class constants SDO_DAS_ChangeSummary::NONE, SDO_DAS_ChangeSummary::MODIFICATION, - SDO_DAS_ChangeSummary::ADDITION, SDO_DAS_ChangeSummary::DELETION are unavailable, + The class constants SDO_DAS_ChangeSummary::NONE, + SDO_DAS_ChangeSummary::MODIFICATION, + SDO_DAS_ChangeSummary::ADDITION, + SDO_DAS_ChangeSummary::DELETION are unavailable, because of an outstanding problem. </para> <para> - As a bypass, the global constants SDO_DAS_CHANGE_SUMMARY_NONE, - SDO_DAS_CHANGE_SUMMARY_MODIFICATION, SDO_DAS_CHANGE_SUMMARY_ADDITION, + As a bypass, the global constants + SDO_DAS_CHANGE_SUMMARY_NONE, + SDO_DAS_CHANGE_SUMMARY_MODIFICATION, + SDO_DAS_CHANGE_SUMMARY_ADDITION, SDO_DAS_CHANGE_SUMMARY_DELETION are provided. </para> </step> <step> <para> - You may see problems when serializing and unserializing graphs which include - non-containment references. We are working on these. + You may see problems when serializing and unserializing graphs + which include non-containment references. + We are working on these. </para> </step> </procedure> <procedure id='sdo.limitations.sdo'> <title>SDO Limitations</title> <para> - The following SDO 2.0 concepts are not supported in the current PHP implementation. + The following SDO 2.0 concepts are not supported in the current + PHP implementation. It is not necessarily the case that these will all be added over time. Their inclusion will depend on community requirements. </para> @@ -317,11 +337,14 @@ and instance information shown below, using the XML Data Access Service. </para> <para> - The schema describes a company data object. The company contains department data objects, and + The schema describes a company data object. + The company contains department data objects, and each department contains employee data objects. - Each data object has a number of primitive properties to describe things like name, serial number, etc. - Finally, the company data object also has a non-containment reference to one of the employee data - objects to identify them as the 'employeeOfTheMonth'. + Each data object has a number of primitive properties to describe things + like name, serial number, etc. + Finally, the company data object also has a non-containment reference + to one of the employee data objects to identify them as the + 'employeeOfTheMonth'. </para> <para> <programlisting role="xml"> @@ -359,10 +382,12 @@ </para> <para> - The instance document below describes a single company, called 'MegaCorp', - which contains a single department, called 'Advanced Technologies'. + The instance document below describes a single company, + called 'MegaCorp', which contains a single department, + called 'Advanced Technologies'. The Advanced Technologies department contains three employees. - The company employeeOfTheMonth is referencing the second employee, 'Jane Doe'. + The company employeeOfTheMonth is referencing the second employee, + 'Jane Doe'. </para> <para> @@ -394,8 +419,9 @@ <title>Access via Property names</title> <para> Data object properties can be accessed using the object property - access syntax. The following gets the list of departments (containing a - single department), and sets the company name to 'Acme'. + access syntax. The following gets the list of departments + (containing a single department), + and sets the company name to 'Acme'. </para> <programlisting role="php" id="sdo.examples.propname"> <![CDATA[ @@ -414,11 +440,14 @@ <para> Data object properties can be accessed via their property index using array syntax. The property index is the position at which the - property's definition appears in the model (in this case the xml schema). - We can see from the schema listing above that the departments element is the - first company property defined and the company name attribute is the second - company property (the SDO interface makes no distinction between XML attributes - and elements). The following gets the list of departments (containing a + property's definition appears in the model + (in this case the xml schema). + We can see from the schema listing above that the departments element + is the first company property defined and the company name attribute + is the second company property + (the SDO interface makes no distinction between XML attributes and + elements). + The following gets the list of departments (containing a single department), and sets the company name to 'Acme'. </para> <programlisting role="php" id="sdo.examples.propindex"> @@ -437,8 +466,8 @@ <title>Data Object Iteration</title> <para> We can iterate over the properties of a data object using foreach. - The following iterates over the company properties; name, departments and - employeeOfTheMonth. + The following iterates over the company properties; name, + departments and employeeOfTheMonth. </para> <programlisting role="php" id="sdo.examples.doiter"> <![CDATA[ @@ -529,8 +558,9 @@ <title>Simple XPath support</title> <para> We can access properties using XPath-like (an augmented - sub-set of XPath) expressions, the simplest form of which is the property - name. The following sets the company name and gets the employeeOfTheMonth. + sub-set of XPath) expressions, the simplest form of which is the + property name. + The following sets the company name and gets the employeeOfTheMonth. </para> <programlisting role="php" id="sdo.examples.simplexpath"> <![CDATA[ @@ -567,8 +597,9 @@ <title>XPath Navigation</title> <para> We can use XPath expressions to navigate the data object - instance structure. Two forms of indexing into many-valued properties are - supported. The first is the standard XPath array syntax with the indexing + instance structure. Two forms of indexing into many-valued + properties are supported. + The first is the standard XPath array syntax with the indexing starting at one, the second is an SDO extension to XPath with an index starting at zero. The following both get the second employee from the first department. @@ -606,9 +637,10 @@ <example> <title>Creating child data object</title> <para> - A data object can be a factory for its child data objects. A child - data object is automatically part of the data graph. The - following add a new employee to the 'Advanced Technologies' department. + A data object can be a factory for its child data objects. + A child data object is automatically part of the data graph. + The following add a new employee to the 'Advanced Technologies' + department. </para> <programlisting role="php" id="sdo.examples.create"> <![CDATA[ @@ -638,11 +670,12 @@ <para> The following removes the 'employeeOfTheMonth' from the company. If this were a containment reference then the - employee would be removed from the company (probably not a good idea to - sack your best employee each month!), but since this is a non-containment - reference, the employee being referenced will remain in the department in - the company, but will no longer be accessible via the employeeOfTheMonth - property. + employee would be removed from the company + (probably not a good idea to sack your best employee each month!), + but since this is a non-containment reference, + the employee being referenced will remain in the + department in the company, + but will no longer be accessible via the employeeOfTheMonth property. </para> <programlisting role="php" id="sdo.examples.unsetrefdo"> <![CDATA[ @@ -782,11 +815,12 @@ <para> To ensure sequence indices are maintained, sequenced data objects - should be manipulated through the SDO_Sequence interface. This allows - the data object's instance data to be manipulated in terms of the sequence - index as opposed to the property index (shown in the table above). The - following examples assume the letter instance has been loaded into a - data object referenced by the variable + should be manipulated through the SDO_Sequence interface. + This allows the data object's instance data to be manipulated + in terms of the sequence index as opposed to the property index + (shown in the table above). + The following examples assume the letter instance has been + loaded into a data object referenced by the variable <command>$letter</command> . <example> @@ -816,10 +850,11 @@ <example> <title>Get/set sequence values</title> <para> - We can get and set individual values (including unstructured text) - using the sequence index. The following sets the firstName to 'Snappy' - and gets the last sequence values (the unstructured text, 'Your premium is - past due.'). + We can get and set individual values + (including unstructured text) + using the sequence index. + The following sets the firstName to 'Snappy' and gets the last + sequence values (the unstructured text, 'Your premium is past due.'). </para> <programlisting role="php" id="sdo.examples.getsetseq"> <![CDATA[ @@ -883,7 +918,8 @@ <link linkend='function.SDO-Sequence-insert'> <function>SDO_Sequence::insert</function> </link> - method. The following examples assume that the 'firstName' and 'lastName' properties are initially unset. + method. The following examples assume that the 'firstName' and + 'lastName' properties are initially unset. </para> <programlisting role="php" id="sdo.examples.seqadd"> <![CDATA[ @@ -984,32 +1020,40 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DataObject-getType'>getType</link> - get the type of a data object + <link linkend='function.SDO-DataObject-getType'>getType</link> + - get the type of a data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DataObject-getSequence'>getSequnece</link> - get the sequence for the data object + <link linkend='function.SDO-DataObject-getSequence'>getSequnece</link> + - get the sequence for the data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DataObject-createDataObject'>createDataObject</link> - create a child data object + <link linkend='function.SDO-DataObject-createDataObject'>createDataObject</link> + - create a child data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DataObject-clear'>clear</link> - unset the properties of a data object + <link linkend='function.SDO-DataObject-clear'>clear</link> + - unset the properties of a data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DataObject-getContainer'>getContainer</link> - get the container (also known as 'parent') of this data object + <link linkend='function.SDO-DataObject-getContainer'>getContainer</link> + - get the container (also known as 'parent') of this data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DataObject-getContainmentPropertyName'>getContainmentPropertyName</link> - get the name by which the parent refers to this data object + <link linkend='function.SDO-DataObject-getContainmentPropertyName'> + getContainmentPropertyName + </link> + - get the name by which the parent refers to this data object </para> </listitem> </itemizedlist> @@ -1022,9 +1066,10 @@ </title> <para> The interface through which sequenced data objects can be accessed in - order to preserve ordering across a data object's properties and to allow - unstructured text. SDO_Sequence preserves contiguous indices and - therefore inserting or removing elements may results in other elements shifted up or + order to preserve ordering across a data object's properties and + to allow unstructured text. + SDO_Sequence preserves contiguous indices and therefore inserting + or removing elements may results in other elements shifted up or down. In addition to the methods below, SDO_Sequence extends the ArrayAccess, Iterator and Countable interface. </para> @@ -1033,22 +1078,30 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-Sequence-getPropertyIndex'>getPropertyIndex</link> - get the property index for a given sequence index + <link linkend='function.SDO-Sequence-getPropertyIndex'> + getPropertyIndex + </link> + - get the property index for a given sequence index </para> </listitem> <listitem> <para> - <link linkend='function.SDO-Sequence-getPropertyName'>getPropertyName</link> - get the property name for a given sequence index + <link linkend='function.SDO-Sequence-getPropertyName'> + getPropertyName + </link> + - get the property name for a given sequence index </para> </listitem> <listitem> <para> - <link linkend='function.SDO-Sequence-move'>move</link> - move an element from one property index to another + <link linkend='function.SDO-Sequence-move'>move</link> + - move an element from one property index to another </para> </listitem> <listitem> <para> - <link linkend='function.SDO-Sequence-insert'>insert</link> - insert a new value into the sequence + <link linkend='function.SDO-Sequence-insert'>insert</link> + - insert a new value into the sequence </para> </listitem> </itemizedlist> @@ -1071,7 +1124,8 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-List-insert'>insert</link> - insert a new value into the list + <link linkend='function.SDO-List-insert'>insert</link> + - insert a new value into the list </para> </listitem> </itemizedlist> @@ -1083,19 +1137,21 @@ <classname>SDO_DataFactory</classname> </title> <para> - The interface through which data objects can be created. A Data - Access Service is responsible for populating the model (i.e. configuring - the data factory with the type and structure information for the data - objects it can create.) for the factory and - can then optionally return an instance of, or implement, the - SDO_DataFactory interface. + The interface through which data objects can be created. + A Data Access Service is responsible for populating the model + (i.e. configuring the data factory with the type and structure + information for the data objects it can create.) + for the factory and can then optionally return an instance of, + or implement, + the SDO_DataFactory interface. </para> <section id='sdo.class.SDO-DataFactory.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DataFactory-create'>create</link> - create a new data object + <link linkend='function.SDO-DataFactory-create'>create</link> + - create a new data object </para> </listitem> </itemizedlist> @@ -1115,16 +1171,23 @@ <classname>SDO_DAS_DataObject</classname> </title> <para> - The interface through which a Data Access Service can access a data object's - <link linkend='sdo.class.sdodas-changesummary'>SDO_DAS_ChangeSummary.</link> - The change summary is used by the Data Access Service to check for conflicts - when applying changes back to a data source. + The interface through which a Data Access Service can access + a data object's + <link linkend='sdo.class.sdodas-changesummary'> + SDO_DAS_ChangeSummary + </link> + . + The change summary is used by the Data Access Service to check for + conflicts when applying changes back to a data source. </para> <section id='sdo.class.SDO_DAS_DataObject.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DAS-DataObject-getChangeSummary'>getChangeSummary</link> - get the change summary for a data object + <link linkend='function.SDO-DAS-DataObject-getChangeSummary'> + getChangeSummary + </link> + - get the change summary for a data object </para> </listitem> @@ -1147,7 +1210,8 @@ <para> If logging is no longer active then the change summary only hold changes made up to the point when - logging was deactivated. Reactivating logging clears the change summary. + logging was deactivated. + Reactivating logging clears the change summary. This is useful when a set of changes have been written out by a DAS and the data object is to be reused. </para> @@ -1156,37 +1220,58 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-beginLogging'>beginLogging</link> - begin logging changes made to a data object + <link linkend='function.SDO-DAS-ChangeSummary-beginLogging'> + beginLogging + </link> + - begin logging changes made to a data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-endLogging'>endLogging</link> - end logging changes made to a data object + <link linkend='function.SDO-DAS-ChangeSummary-endLogging'> + endLogging + </link> + - end logging changes made to a data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-isLogging'>isLogging</link> - test to see if change logging is on + <link linkend='function.SDO-DAS-ChangeSummary-isLogging'> + isLogging + </link> + - test to see if change logging is on </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-getChangedDataObjects'>getChangedDataObjects</link> - get a list of the data objects which have been changed + <link linkend='function.SDO-DAS-ChangeSummary-getChangedDataObjects'> + getChangedDataObjects + </link> + - get a list of the data objects which have been changed </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-getChangeType'>getChangeType</link> - get the type of change which has been made to a data object + <link linkend='function.SDO-DAS-ChangeSummary-getChangeType'> + getChangeType + </link> + - get the type of change which has been made to a data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-getOldValues'>getOldValues</link> - get a list of old values for a data object + <link linkend='function.SDO-DAS-ChangeSummary-getOldValues'> + getOldValues + </link> + - get a list of old values for a data object </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-ChangeSummary-getOldContainer'>getOldContainer</link> - get the old container data object for a deleted data object + <link linkend='function.SDO-DAS-ChangeSummary-getOldContainer'> + getOldContainer + </link> + - get the old container data object for a deleted data object </para> </listitem> </itemizedlist> @@ -1210,28 +1295,43 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DAS-Setting-getPropertyIndex'>getPropertyIndex</link> - get the property index for the changed property + <link linkend='function.SDO-DAS-Setting-getPropertyIndex'> + getPropertyIndex + </link> + - get the property index for the changed property </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-Setting-getPropertyName'>getPropertyName</link> - get the property name for the changed property + <link linkend='function.SDO-DAS-Setting-getPropertyName'> + getPropertyName + </link> + - get the property name for the changed property </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-Setting-getValue'>getValue</link> - get the old value for the changed property + <link linkend='function.SDO-DAS-Setting-getValue'> + getValue + </link> + - get the old value for the changed property </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-Setting-getListIndex'>getListIndex</link> - get the list index for the old value if it was part of - a many-valued property + <link linkend='function.SDO-DAS-Setting-getListIndex'> + getListIndex + </link> + - get the list index for the old value if it was part of a + many-valued property </para> </listitem> <listitem> <para> - <link linkend='function.SDO-DAS-Setting-isSet'>isSet</link> - test to see if the property was set prior to being modified + <link linkend='function.SDO-DAS-Setting-isSet'> + isSet + </link> + - test to see if the property was set prior to being modified </para> </listitem> </itemizedlist> @@ -1246,7 +1346,8 @@ The interface for constructing the model for an SDO_DataObject. The SDO_DAS_DataFactory is an abstract class providing a static method which returns a concrete data factory implementation. - The implementation is used by Data Access Services to create an SDO model from their model. + The implementation is used by Data Access Services to create an + SDO model from their model. For example, a Relational Data Access Service might create and populate an SDO_DAS_DataFactory model based on a schema for a relational database. </para> @@ -1255,21 +1356,30 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DAS-DataFactory-getDataFactory'>getDataFactory</link> - static methods for getting a concrete data factory instance + <link linkend='function.SDO-DAS-DataFactory-getDataFactory'> + getDataFactory + </link> + - static methods for getting a concrete data factory instance </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DAS-DataFactory-addType'>addType</link> - add a new type to the SDO model + <link linkend='function.SDO-DAS-DataFactory-addType'> + addType + </link> + - add a new type to the SDO model </para> </listitem> </itemizedlist> <itemizedlist> <listitem> <para> - <link linkend='function.SDO-DAS-DataFactory-addPropertyToType'>addPropertyToType</link> - add a new property to a type definition in the SDO model + <link linkend='function.SDO-DAS-DataFactory-addPropertyToType'> + addPropertyToType + </link> + - add a new property to a type definition in the SDO model </para> </listitem> </itemizedlist>