cvs: phpdoc /en/reference/sdo constants.xml functions.xml reference.xml /en/reference/sdo/functions SDO-DAS-ChangeSummary-beginLogging.xml
SDO-DAS-ChangeSummary-endLogging.xml SDO-DAS-ChangeSummary-getChangeType.xml SDO-DAS-ChangeSummary-getChangedDataObjects.xml
SDO-DAS-ChangeSummary-getOldContainer.xml SDO-DAS-ChangeSummary-getOldValues.xml SDO-DAS-ChangeSummary-isLogging.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

From:	Graham Charters	Date:	Mon, 18 Jul 2005 20:42:59 +0000
Subject:	cvs: phpdoc /en/reference/sdo constants.xml functions.xml reference.xml /en/reference/sdo/functions SDO-DAS-ChangeSummary-beginLogging.xml SDO-DAS-ChangeSummary-endLogging.xml SDO-DAS-ChangeSummary-getChangeType.xml SDO-DAS-ChangeSummary-getChangedDataObjects.xml SDO-DAS-ChangeSummary-getOldContainer.xml SDO-DAS-ChangeSummary-getOldValues.xml SDO-DAS-ChangeSummary-isLogging.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
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969369192@lists.php.net to get a copy of this message

gcc Mon Jul 18 16:42:59 2005 EDT Added files: /phpdoc/en/reference/sdo/functions SDO-Sequence-getPropertyIndex.xml SDO-DataObject-getContainmentPropertyName.xml SDO-DAS-ChangeSummary-endLogging.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-ChangeSummary-isLogging.xml SDO-DAS-Setting-getPropertyIndex.xml SDO-DAS-ChangeSummary-getChangedDataObjects.xml SDO-DAS-Setting-getListIndex.xml SDO-DataObject-getContainer.xml SDO-DAS-Setting-isSet.xml SDO-DataObject-createDataObject.xml SDO-Sequence-insert.xml SDO-Sequence-getPropertyName.xml SDO-DAS-ChangeSummary-getOldValues.xml SDO-DataObject-getSequence.xml SDO-List-insert.xml SDO-DAS-DataFactory-getDataFactory.xml SDO-DataObject-getType.xml SDO-DAS-ChangeSummary-beginLogging.xml SDO-DataFactory-create.xml SDO-DAS-DataObject-getChangeSummary.xml SDO-DAS-Setting-getPropertyName.xml SDO-DAS-DataFactory-addPropertyToType.xml /phpdoc/en/reference/sdo functions.xml constants.xml reference.xml Log: First drop of SDO core documentation.

http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-Sequence-getPropertyIndex"> <refnamediv> <refname>SDO_Sequence::getPropertyIndex</refname> <refpurpose> Return the property index for the specified sequence index. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>integer</type><methodname>SDO_Sequence::getPropertyIndex</methodname> <methodparam><type>integer</type><parameter>sequenceIndex</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>sequenceIndex</parameter></term> <listitem> <para> The sequence index for which we wish to determine the associated data object property index. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <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. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term><parameter>SDO_IndexOutOfBoundsException</parameter></term> <listitem> <para> Thrown if the sequence index is less than zero or greater than the size of the sequence. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataObject-getContainmentPropertyName"> <refnamediv> <refname>SDO_DataObject::getContainmentPropertyName</refname> <refpurpose> Get the container's property name. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type> <methodname>SDO_DataObject::getContainmentPropertyName</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Get the property name used to refer to this data object by its containing data object. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <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). </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-endLogging"> <refnamediv> <refname>SDO_DAS_ChangeSummary::endLogging</refname> <refpurpose> End change logging. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type> <methodname>SDO_DAS_ChangeSummary::endLogging</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> End logging changes made to an SDO_DataObject. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> None. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-Sequence-move"> <refnamediv> <refname>SDO_Sequence::move</refname> <refpurpose> Move an item to another sequence position. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type> <methodname>SDO_Sequence::move</methodname> <methodparam> <type>integer</type> <parameter>toIndex</parameter> </methodparam> <methodparam> <type>integer</type> <parameter>fromIndex</parameter> </methodparam> </methodsynopsis> &warn.experimental.func; <para> Modify the position of the item in the sequence, without altering the value of the property in the SDO_DataObject. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term> <parameter>toIndex</parameter> </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. </para> </listitem> </varlistentry> <varlistentry> <term> <parameter>fromIndex</parameter> </term> <listitem> <para> The source sequence index. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> None. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term> <parameter>SDO_IndexOutOfBoundsException</parameter> </term> <listitem> <para> Thrown if the fromIndex sequence index is less than zero or greater than the size of the sequence. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-getOldContainer"> <refnamediv> <refname>SDO_DAS_ChangeSummary::getOldContainer</refname> <refpurpose> Get the old container for a deleted SDO_DataObject. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_DataObject</type><methodname>SDO_DAS_ChangeSummary::getOldContainer</methodname> <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Get the old container (SDO_DataObject) for a deleted SDO_DataObject. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>dataObject</parameter></term> <listitem> <para> The SDO_DataObject which has been deleted and whose container we wish to identify. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The old containing data object of the deleted SDO_DataObject. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataObject-clear"> <refnamediv> <refname>SDO_DataObject::clear</refname> <refpurpose> Clear an SDO_DataObject's properties. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>SDO_DataObject::clear</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Clear an SDO_DataObject's properties. Read-only properties are unaffected.Subsequent calls to isset() for the data object will return false. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> No return values. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-DataFactory-addType"> <refnamediv> <refname>SDO_DAS_DataFactory::addType</refname> <refpurpose> Add a new type to a model. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>SDO_DAS_DataFactory::addType</methodname> <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam> <methodparam><type>string</type><parameter>typeName</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Add a new type to the SDO_DAS_DataFactory, defined by its namespace and typename. The type becomes part of the model of data objects that the data factory can create. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>namespaceURI</parameter></term> <listitem> <para> The namespace of the type. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>typeName</parameter></term> <listitem> <para> The name of the type. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> No values returned. </para> </refsect1>   <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_DAS_DataFactory::addType</function> example</title> <para> The following adds a new data object type of 'CompanyType'where that type belongs to the namespace 'CompanyNS'. </para> <programlisting role="php"> <![CDATA[ <?php $df->addType('CompanyNS', 'CompanyType'); ?> ]]> </programlisting> </example> </para> </refsect1>  </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-Setting-getValue"> <refnamediv> <refname>SDO_DAS_Setting::getValue</refname> <refpurpose> Get the old value for the changed property. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>mixed</type> <methodname>SDO_DAS_Setting::getValue</methodname> <void/> </methodsynopsis> &warn.experimental.func; <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 writing any new updates risks compromising the integrity of the data. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the old value of the changed property. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-getChangeType"> <refnamediv> <refname>SDO_DAS_ChangeSummary::getChangeType</refname> <refpurpose> Get the type of change made to an SDO_DataObject. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>integer</type><methodname>SDO_DAS_ChangeSummary::getChangeType</methodname> <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Get the type of change which has been made to the supplied SDO_DataObject. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>dataObject</parameter></term> <listitem> <para> The SDO_DataObject which has been changed. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <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: <itemizedlist> <listitem> <para> SDO_DAS_ChangeSummary::NONE </para> </listitem> <listitem> <para> SDO_DAS_ChangeSummary::MODIFICATION </para> </listitem> <listitem> <para> SDO_DAS_ChangeSummary::ADDITION </para> </listitem> <listitem> <para> SDO_DAS_ChangeSummary::DELETION </para> </listitem> </itemizedlist> </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-isLogging"> <refnamediv> <refname>SDO_DAS_ChangeSummary::isLogging</refname> <refpurpose> Test to see whether change logging is switched on. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>boolean</type><methodname>SDO_DAS_ChangeSummary::isLogging</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Test to see whether change logging is switched on.Returns true if logging is on, otherwise returns false. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns true if change logging is on, otherwise returns false. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-Setting-getPropertyIndex"> <refnamediv> <refname>SDO_DAS_Setting::getPropertyIndex</refname> <refpurpose> Get the property index for a changed property. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>int</type><methodname>SDO_DAS_Setting::getPropertyIndex</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Returns the property index for the changed property. This index identifies the property which was modified in data object. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The property index for a changed property. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-getChangedDataObjects"> <refnamediv> <refname>SDO_DAS_ChangeSummary::getChangedDataObjects</refname> <refpurpose> Get the changed data objects from a change summary. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_List</type><methodname>SDO_DAS_ChangeSummary::getChangedDataObjects</methodname> <void/> </methodsynopsis> &warn.experimental.func; <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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an SDO_List of SDO_DataObjects. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-Setting-getListIndex"> <refnamediv> <refname>SDO_DAS_Setting::getListIndex</refname> <refpurpose> Get the list index for a changed many-valued property. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>integer</type> <methodname>SDO_DAS_Setting::getListIndex</methodname> <void/> </methodsynopsis> &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. A call to <function>getListIndex</function> on that setting would return the value 2 (lists are indexed from zero). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The list index for the element of the many-valued property which has been changed. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataObject-getContainer"> <refnamediv> <refname>SDO_DataObject::getContainer</refname> <refpurpose> Get a data object's container. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_DataObject</type><methodname>SDO_DataObject::getContainer</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Get the data object which contains this data object. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <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). </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-Setting-isSet"> <refnamediv> <refname>SDO_DAS_Setting::isSet</refname> <refpurpose> Test whether a property was set prior to being modified. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>boolean</type><methodname>SDO_DAS_Setting::isSet</methodname> <void/> </methodsynopsis> &warn.experimental.func; <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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns true if the property was set prior to being modified, otherwise returns false. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataObject-createDataObject"> <refnamediv> <refname>SDO_DataObject::createDataObject</refname> <refpurpose> Create a child SDO_DataObject. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_DataObject</type><methodname>SDO_DataObject::createDataObject</methodname> <methodparam><type>mixed</type><parameter>identifier</parameter></methodparam> </methodsynopsis> &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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>identifier</parameter></term> <listitem> <para> Identifies the property for the data object type to be created. Can be either a property name (string), or property index (int). </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the newly created SDO_DataObject. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term> <parameter>SDO_PropertyNotFoundException</parameter> </term> <listitem> <para> Thrown if the identifier does not correspond to a property of the data object. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-Sequence-insert"> <refnamediv> <refname>SDO_Sequence::insert</refname> <refpurpose> Insert into a sequence. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>SDO_Sequence::insert</methodname> <methodparam><type>mixed</type><parameter>value</parameter></methodparam> <methodparam choice="opt"><type>integer</type><parameter>sequenceIndex</parameter></methodparam> <methodparam choice="opt"><type>mixed</type><parameter>propertyIdentifier</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Insert a new element at a specified position in the sequence. All subsequent sequence items are moved up. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>value</parameter></term> <listitem> <para> The new value to be inserted. This can be either a primitive or an SDO_DataObject. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>sequenceIndex</parameter></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. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>propertyIdentifier</parameter></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. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> None. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term><parameter>SDO_IndexOutOfBoundsException</parameter></term> <listitem> <para> Thrown if the sequence index is less than zero or greater than the size of the sequence. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>SDO_InvalidConversionException</parameter></term> <listitem> <para> Thrown if the type of the new value cannot be juggled to match the type for the specified data object property. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-Sequence-getPropertyName"> <refnamediv> <refname>SDO_Sequence::getPropertyName</refname> <refpurpose> Return the property name for the specified sequence index. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>SDO_Sequence::getPropertyName</methodname> <methodparam><type>integer</type><parameter>sequenceIndex</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>sequenceIndex</parameter></term> <listitem> <para> The sequence index for which we wish to determine the associated data object property name. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <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. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term><parameter>SDO_IndexOutOfBoundsException</parameter></term> <listitem> <para> Thrown if the sequence index is less than zero or greater than the size of the sequence. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-getOldValues"> <refnamediv> <refname>SDO_DAS_ChangeSummary::getOldValues</refname> <refpurpose> Get the old values for a given changed SDO_DataObject. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_List</type><methodname>SDO_DAS_ChangeSummary::getOldValues</methodname> <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>dataObject</parameter></term> <listitem> <para> The data object which has been changed. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> A list of SDO_DAS_Settings describing the old values for the changed properties of the SDO_DataObject </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataObject-getSequence"> <refnamediv> <refname>SDO_DataObject::getSequence</refname> <refpurpose> Get the sequence for a data object. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_Sequence</type><methodname>SDO_DataObject::getSequence</methodname> <void/> </methodsynopsis> &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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The SDO_Sequence for this SDO_DataObject, or returns NULL if the SDO_DataObject is not of a type which can have a sequence. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-List-insert.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-List-insert.xml +++ phpdoc/en/reference/sdo/functions/SDO-List-insert.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-List-insert"> <refnamediv> <refname>SDO_List::insert</refname> <refpurpose> Insert into a list. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type> <methodname>SDO_List::insert</methodname> <methodparam> <type>mixed</type> <parameter>value</parameter> </methodparam> <methodparam choice="opt"> <type>integer</type> <parameter>index</parameter> </methodparam> </methodsynopsis> &warn.experimental.func; <para> Insert a new element at a specified position in the list. All subsequent list items are moved up. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term> <parameter>value</parameter> </term> <listitem> <para> The new value to be inserted. This can be either a primitive or an SDO_DataObject. </para> </listitem> </varlistentry> <varlistentry> <term> <parameter>index</parameter> </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. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> None. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term><parameter>SDO_IndexOutOfBoundsException</parameter></term> <listitem> <para> Thrown if the list index is less than zero or greater than the size of the list. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>SDO_InvalidConversionException</parameter></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). </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-DataFactory-getDataFactory"> <refnamediv> <refname>SDO_DAS_DataFactory::getDataFactory</refname> <refpurpose> Get a data factory instance. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_DAS_DataFactory</type><methodname>SDO_DAS_DataFactory::getDataFactory</methodname> <void/> </methodsynopsis> &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. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns an SDO_DAS_DataFactory. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataObject-getType"> <refnamediv> <refname>SDO_DataObject::getType</refname> <refpurpose> Get the type of a data object. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>array</type><methodname>SDO_DataObject::getType</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Return an array containing the type information for an SDO_DataObject. The first element contains the namespace URI string and the secondcontains the type name string. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An array containing the namespace URI string and the type name string for the data object. </para> </refsect1>   <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_DataObject::getType</function> 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'): </para> <programlisting role="php"> <![CDATA[ <?php $do_type = $company_do->getType(); echo "Namespace: $do_type[0], Type Name: $do_type[1]"; ?> ]]> </programlisting> &example.outputs; <screen> <![CDATA[ Namespace: CompanyNS, Type Name: CompanyType ]]> </screen> </example> </para> </refsect1>  </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-ChangeSummary-beginLogging"> <refnamediv> <refname>SDO_DAS_ChangeSummary::beginLogging</refname> <refpurpose> Begin change logging. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type> <methodname>SDO_DAS_ChangeSummary::beginLogging</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Begin logging changes made to the SDO_DataObject. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> None. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DataFactory-create"> <refnamediv> <refname>SDO_DataFactory::create</refname> <refpurpose> Create an SDO_DataObject. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>SDO_DataFactory::create</methodname> <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam> <methodparam><type>string</type><parameter>typeName</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Create a new SDO_DataObject given the data object's namespace URI and type name. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>namespaceURI</parameter></term> <listitem> <para> The namespace of the type. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>typeName</parameter></term> <listitem> <para> The name of the type. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the newly created SDO_DataObject. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term> <parameter>SDO_TypeNotFoundException</parameter> </term> <listitem> <para> Thrown if the namespaceURI and typeName do not correspond to a type known to this data factory </para> </listitem> </varlistentry> </variablelist> </para> </refsect1>    </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-DataObject-getChangeSummary"> <refnamediv> <refname>SDO_DAS_DataObject::getChangeSummary</refname> <refpurpose> Get a data object's change summary. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_DAS_ChangeSummary</type><methodname>SDO_DAS_DataObject::getChangeSummary</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Get the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, or NULL if it does not have one. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the SDO_DAS_ChangeSummary for an SDO_DAS_DataObject, or NULL if it does not have one. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-Setting-getPropertyName"> <refnamediv> <refname>SDO_DAS_Setting::getPropertyName</refname> <refpurpose> Get the property name for a changed property. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>SDO_DAS_Setting::getPropertyName</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Returns the property name for the changed property. This name identifies the property which was modified in data object. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The property name for a changed property. </para> </refsect1>     </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml <?xml version="1.0" encoding="iso-8859-1"?>   <refentry id="function.SDO-DAS-DataFactory-addPropertyToType"> <refnamediv> <refname>SDO_DAS_DataFactory::addPropertyToType</refname> <refpurpose> Adds a property to a type. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>void</type><methodname>SDO_DAS_DataFactory::addPropertyToType</methodname> <methodparam><type>string</type><parameter>parentNamespaceURI</parameter></methodparam> <methodparam><type>string</type><parameter>parentTypeName</parameter></methodparam> <methodparam><type>string</type><parameter>propertyName</parameter></methodparam> <methodparam><type>string</type><parameter>propertyNamespaceURI</parameter></methodparam> <methodparam><type>string</type><parameter>propertyTypeName</parameter></methodparam> <methodparam choice="opt"><type>boolean</type><parameter>many</parameter></methodparam> <methodparam choice="opt"><type>boolean</type><parameter>readOnly</parameter></methodparam> <methodparam choice="opt"><type>boolean</type><parameter>containment</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Adds a property to a type. The type must already be known to the SDO_DAS_DataFactory (i.e. have been added using addType()). The property becomes a property of the type. This is how the graph model for the structure of an SDO_DataObject is built. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>parentNamespaceURI</parameter></term> <listitem> <para> The namespace URI for the parent type. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>parentTypeName</parameter></term> <listitem> <para> The type name for the parent type. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>propertyName</parameter></term> <listitem> <para> The name of by which the property will be known in the parent type. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>propertyNamespaceURI</parameter></term> <listitem> <para> The namespace URI for the type of the property. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>propertyTypeName</parameter></term> <listitem> <para> The type name for the type of the property </para> </listitem> </varlistentry> <varlistentry> <term><parameter>many</parameter></term> <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') </para> </listitem> </varlistentry> <varlistentry> <term><parameter>readOnly</parameter></term> <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') </para> </listitem> </varlistentry> <varlistentry> <term><parameter>containment</parameter></term> <listitem> <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. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> None. </para> </refsect1>   <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_DAS_DataFactory::addPropertyToType</function> example</title> <para> The following adds a 'name' property to a Person type. The person type is identified by its namespace, 'PersonNS', and type name, 'PersonType'. The type of the 'name' property is an SDO data type (primitive) with namespace 'commonj.sdo' and type name 'String'. </para> <programlisting role="php"> <![CDATA[ <?php $df->addPropertyToType('PersonNS', 'PersonType','name', 'commonj.sdo', 'String'); ?> ]]> </programlisting> </example> </para> </refsect1>  </refentry>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/functions.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/functions.xml +++ phpdoc/en/reference/sdo/functions.xml &reference.sdo.functions.SDO-DAS-ChangeSummary-beginLogging; &reference.sdo.functions.SDO-DAS-ChangeSummary-endLogging; &reference.sdo.functions.SDO-DAS-ChangeSummary-getChangeType; &reference.sdo.functions.SDO-DAS-ChangeSummary-getChangedDataObjects; &reference.sdo.functions.SDO-DAS-ChangeSummary-getOldContainer; &reference.sdo.functions.SDO-DAS-ChangeSummary-getOldValues; &reference.sdo.functions.SDO-DAS-ChangeSummary-isLogging; &reference.sdo.functions.SDO-DAS-DataFactory-addPropertyToType; &reference.sdo.functions.SDO-DAS-DataFactory-addType; &reference.sdo.functions.SDO-DAS-DataFactory-getDataFactory; &reference.sdo.functions.SDO-DAS-DataObject-getChangeSummary; &reference.sdo.functions.SDO-DAS-Setting-getListIndex; &reference.sdo.functions.SDO-DAS-Setting-getPropertyIndex; &reference.sdo.functions.SDO-DAS-Setting-getPropertyName; &reference.sdo.functions.SDO-DAS-Setting-getValue; &reference.sdo.functions.SDO-DAS-Setting-isSet; &reference.sdo.functions.SDO-DataFactory-create; &reference.sdo.functions.SDO-DataObject-clear; &reference.sdo.functions.SDO-DataObject-createDataObject; &reference.sdo.functions.SDO-DataObject-getContainer; &reference.sdo.functions.SDO-DataObject-getContainmentPropertyName; &reference.sdo.functions.SDO-DataObject-getSequence; &reference.sdo.functions.SDO-DataObject-getType; &reference.sdo.functions.SDO-List-insert; &reference.sdo.functions.SDO-Sequence-getPropertyIndex; &reference.sdo.functions.SDO-Sequence-getPropertyName; &reference.sdo.functions.SDO-Sequence-insert; &reference.sdo.functions.SDO-Sequence-move; http://cvs.php.net/co.php/phpdoc/en/reference/sdo/constants.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/constants.xml +++ phpdoc/en/reference/sdo/constants.xml <?xml version='1.0' encoding='iso-8859-1'?>   <section id="sdo.constants"> &reftitle.constants; &extension.constants; <variablelist> <varlistentry> <term> <constant>SDO_DAS_ChangeSummary::NONE=0</constant> (<type>integer</type>) </term> <listitem> <simpara> Represents a change type of 'none'. </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SDO_DAS_ChangeSummary::MODIFICATION=1</constant> (<type>integer</type>) </term> <listitem> <simpara> Represents a change type of 'modification'. </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SDO_DAS_ChangeSummary::ADDITION=2</constant> (<type>integer</type>) </term> <listitem> <simpara> Represents a change type of 'addition'. </simpara> </listitem> </varlistentry> <varlistentry> <term> <constant>SDO_DAS_ChangeSummary::DELETION=3</constant> (<type>integer</type>) </term> <listitem> <simpara> Represents a change type of 'deletion'. </simpara> </listitem> </varlistentry> </variablelist> </section>  http://cvs.php.net/co.php/phpdoc/en/reference/sdo/reference.xml?r=1.1&p=1 Index: phpdoc/en/reference/sdo/reference.xml +++ phpdoc/en/reference/sdo/reference.xml <?xml version='1.0' encoding='iso-8859-1'?>   <reference id="ref.sdo"> <title>SDO Functions</title> <titleabbrev>SDO</titleabbrev> <partintro> <section id="sdo.intro"> &reftitle.intro; <para>  &warn.experimental; </para> <para> Service Data Objects (SDOs) are designed to simplify working with heterogeneous data whilst also being tailored for service-oriented applications. Using SDO, developers can uniformly manipulate data for 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 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. </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> for more details). </para> <para> This extension is derived from concepts taken from the <ulink url='http://www-128.ibm.com/developerworks/java/library/j-commonj-sdowmt/'> Service Data Objects specification </ulink>.. </para> </section> <section id="sdo.requirements"> &reftitle.required; <para> The SDO extension requires PHP 5.1 or higher. </para> <para> SDO <link linkend="ref.sdo-das-xml">XML Data Access Service</link>, which is built as part of this extension, requires libxml2 (Tested with libxml2 2.6.19) which can be downloaded from <ulink url='http://xmlsoft.org/downloads.html'>http://xmlsoft.org/downloads.html</ulink>" </para> </section> <section id="sdo.installation"> &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. </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 <link linkend="ref.sdo-das-xml">XML Data Access Service</link> which is packaged as part of this extension. </para> <para> Note, if you built your PHP installation in a different location, using <filename>--prefix</filename>, then you will need to adjust the <command>./configure</command> steps below accordingly. </para> <step> <para> Download the SDO extension from the pecl/sdo directory on CVS. </para> </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. This can be done by using the following steps: </para> <procedure id='sdo.installation.linux.substeps'> <step> <para> Go to the core library directory: <command>cd sdo/sdolib</command> </para> </step> <step> <para> Run <command>./configure</command> </para> </step> <step> <para> The following step is required to ensure <command>g++</command>, and NOT <command>gcc</command> is used to build the the libraries. </para> <para> Open <filename>libtool</filename> created by the configure script and change the line which says <command>CC="gcc"</command> to <command>CC="g++"</command>. </para> </step> <step> <para> Run <command>make; make install</command> </para> </step> </procedure> </step> <step> <para> Change to the main extension directory: <command>cd ..</command> </para> </step> <step> <para> Run <command>phpize</command>, which will set up the environment to compile both SDO and the XML Data Access Service. </para> </step> <step> <para> Next run <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. </para> <para> Note, if you used <filename>--prefix</filename> for the internal 'core' library build, then you will need to add <filename>--with-sdolibs=...</filename> to the <command>./configure</command> to point to the destination where the libraries were built. </para> </step> <step> <para> Make sure that these modules are loaded by PHP, by adding <command>extension=sdo.so</command> and <command>extension=sdo_das_xml.so</command> to your <filename>php.ini</filename> file. </para> </step> </procedure> </section> <section id="sdo.das.table"> <title>Data Access Services</title> <para> The table below lists the currently provided SDO Data Access Services: <informaltable> <tgroup cols='2'> <thead> <row> <entry>DAS Name</entry> <entry>Description</entry> </row> </thead> <tbody> <row> <entry> <link linkend="ref.sdo-das-xml">SDO_DAS_XML</link> </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. </entry> </row> <row> <entry> <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. </entry> </row> </tbody> </tgroup> </informaltable> </para> </section> <section id='sdo.limitations'> <title>Limitations</title> <procedure id='sdo.limitations.implementation'> <title>Implementation Limitations</title> <para> The following are limitations in the current SDO implementation: </para> <step> <para> There is no support for multi-byte character sets. </para> </step> <step> <para> 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, 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. </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. It is not necessarily the case that these will all be added over time. Their inclusion will depend on community requirements. </para> <step> <para> Abstract types and type derivation. </para> </step> <step> <para> Open types. </para> </step> <step> <para> Bi-directional relationships. </para> </step> <step> <para> Type and property alias names. </para> </step> <step> <para> Default property values. </para> </step> <step> <para> Read-only properties. </para> </step> <step> <para> Model introspection. </para> </step> <step> <para> XMLHelper/XSDHelper (the XML DAS provide a lot of this functionality) </para> </step> <step> <para> TypeHelper (the SDO_DAS_DataFactory provides this functionality) </para> </step> </procedure> </section> <section id='sdo.examples'> &reftitle.examples; <para> The examples below assume an SDO created with the schema 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 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'. </para> <para> <programlisting role="xml"> <![CDATA[ <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:sdo="commonj.sdo" xmlns:sdoxml="commonj.sdo/xml" xmlns:company="companyNS" targetNamespace="companyNS"> <xsd:element name="company" type="company:CompanyType"/> <xsd:complexType name="CompanyType"> <xsd:sequence> <xsd:element name="departments" type="company:DepartmentType" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="employeeOfTheMonth" type="xsd:IDREF" sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType> <xsd:complexType name="DepartmentType"> <xsd:sequence> <xsd:element name="employees" type="company:EmployeeType" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="location" type="xsd:string"/> <xsd:attribute name="number" type="xsd:int"/> </xsd:complexType> <xsd:complexType name="EmployeeType"> <xsd:attribute name="name" type="xsd:string"/> <xsd:attribute name="SN" type="xsd:ID"/> <xsd:attribute name="manager" type="xsd:boolean"/> </xsd:complexType> </xsd:schema> ]]> </programlisting> </para> <para> The instance document below describes a single company, called 'MegaCorp', w hich contains a single department, called 'Advanced Technologies'. The Advanced Technologies department contains three employees. The company employeeOfTheMonth is referencing the second employee, 'Jane Doe'. </para> <para> <programlisting role="xml"> <![CDATA[ <?xml version="1.0" encoding="UTF-8" ?> <company xmlns="companyNS" name="MegaCorp" employeeOfTheMonth="#/departments.0/employees.1"> <departments name="Advanced Technologies" location="NY" number="123"> <employees name="John Jones" SN="E0001"/> <employees name="Jane Doe" SN="E0003"/> <employees name="Al Smith" SN="E0004" manager="true"/> </departments> </company> ]]> </programlisting> </para> </section> <section id="sdo.sample.getset"> <title>Setting and Getting Property Values</title> <para> The following examples assume <command>$company</command> is a data object created from the schema and instance document shown above. </para> <para> <example> <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'. </para> <programlisting role="php" id="sdo.examples.propname"> <![CDATA[ <?php $departments = $company->departments; $company->name = 'Acme'; ?> ]]> </programlisting> </example> </para> <para> <example> <title>Access via Property index</title> <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 single department), and sets the company name to 'Acme'. </para> <programlisting role="php" id="sdo.examples.propindex"> <![CDATA[ <?php $departments = $company[0]; $company[1] = 'Acme'; ?> ]]> </programlisting> </example> </para> <para> <example> <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. </para> <programlisting role="php" id="sdo.examples.doiter"> <![CDATA[ <?php foreach ($company as $name => $value) { ... } ?> ]]> </programlisting> <para> For the first iteration, $name will be 'name' and $value will be 'Acme'. For the second iteration, $name will be 'departments' and $value will be an SDO_List (because departments is a many-valued property (stated <command>maxOccurs="unbouded"</command> in the schema)) containing a single data object of type DepartmentType. For the third iteration, $name will be 'employeeOfTheMonth' and $value will be a data object of type EmployeeType. </para> </example> </para> <para> <example> <title>Many-valued Property Iteration</title> <para> Many-valued properties can also be iterated over using foreach. The following iterates over the company's departments. </para> <programlisting role="php" id="sdo.examples.mvpiter"> <![CDATA[ <?php foreach ($company->departments as $department) { ... } ?> ]]> </programlisting> <para> Each iteration will assign the next department in the list to the variable <command>$department</command>.. </para> </example> </para> <para> <example> <title> Many-valued Element Access </title> <para> We can access individual elements of many-valued properties using array syntax. The following accesses the first department in the company. </para> <programlisting role="php" id="sdo.examples.mvaccess"> <![CDATA[ <?php $ad_tech_dept = $company->departments[0]; ?> ]]> </programlisting> </example> </para> <para> <example> <title>Nested Property Access</title> <para> We can use nested property access to navigate the data object instance structure. The following gets and sets the name of the first department. </para> <programlisting role="php" id="sdo.examples.nestedprop"> <![CDATA[ <?php $dept_name = $company->departments[0]->name; $company->departments[0]->name = 'Emerging Technologies'; ?> ]]> </programlisting> </example> </para> <para> <example> <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. </para> <programlisting role="php" id="sdo.examples.simplexpath"> <![CDATA[ <?php $company['name'] = 'UltraCorp'; $eotm = $company['employeeOfTheMonth']; ?> ]]> </programlisting> </example> </para> <para> <example> <title>Simple XPath support</title> <para> We can use chained array access calls to navigate the data object instance structure. The following gets and sets the name of the first department. </para> <programlisting role="php" id="sdo.examples.chainarray"> <![CDATA[ <?php $dept_name = $company['departments'][0]['name']; $company['departments'][0]['name'] = 'Emerging Technologies'; ?> ]]> </programlisting> </example> </para> <para> <example> <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 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. </para> <programlisting role="php" id="sdo.examples.xpathnav"> <![CDATA[ <?php $jane_doe = $company["departments[1]/employees[2]"]; $jane_doe = $company["departments.0/employees.1"]; ?> ]]> </programlisting> </example> </para> <para> <example> <title>XPath Querying</title> <para> We can use XPath to query and identify parts of a data object based on instance data. The following retrieves the manager from the 'Advanced Technologies' department. </para> <programlisting role="php" id="sdo.examples.xpathquery"> <![CDATA[ <?php $ad_tech_mgr = $company["departments[name=\"Advanced Technologoies\"]/employees[manager=\"true\"]"]; ?> ]]> </programlisting> </example> </para> <para> <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. </para> <programlisting role="php" id="sdo.examples.create"> <![CDATA[ <?php $ad_tech_dept = $company["departments[name=\"Advanced Technologoies\"]"]; $new_hire = $ad_tech_dept->createDataObject('employees'); $new_hire->name = 'John Johnson'; $new_hire->SN = 'E0005'; $new_hire->manager = false; ?> ]]> </programlisting> </example> </para> <para> <example> <title>Unset referenced data object</title> <para> We can use the <function>isset</function> and <function>unset</function> functions to test and remove items from the data object. </para> <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. </para> <programlisting role="php" id="sdo.examples.unsetrefdo"> <![CDATA[ <?php if (isset($company->employeeOfTheMonth) { unset($company->employeeOfTheMonth); } ?> ]]> </programlisting> </example> </para> </section> <section id="sdo.sample.sequence"> <title>Working with Sequenced Data Objects</title> <para> Sequenced data objects are SDOs which can track property ordering across the properties of a data object. They can also contain unstructured text elements (text element which do not belong to any of the SDO's properties). Sequenced data objects are useful for working with XML documents which allow unstructured text (i.e. mixed=true) or if the elements can be interleaved ( <![CDATA[<A/><B/><A/>]]>). This can occur for example when the schema defines maxOccurs>1 on a element which is a complexType with a choice order indicator. </para> <para> The examples below assume an SDO created with the following schema and instance information, using the XML Data Access Service. </para> <para> The schema below describes the format of a letter. The letter can optionally contain three properties; date, firstName, and lastName. The schema states <command>mixed="true"</command> which means that unstructured text can be interspersed between the three properties. </para> <para> <programlisting role="xml"> <![CDATA[ <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:letter="http://letterSchema" targetNamespace="http://letterSchema"> <xsd:element name="letters" type="letter:FormLetter"/> <xsd:complexType name="FormLetter" mixed="true"> <xsd:sequence> <xsd:element name="date" minOccurs="0" type="xsd:string"/> <xsd:element name="firstName" minOccurs="0" type="xsd:string"/> <xsd:element name="lastName" minOccurs="0" type="xsd:string"/> </xsd:sequence> </xsd:complexType> </xsd:schema> ]]> </programlisting> </para> <para> The following is an instance letter document. It contains the three letter properties; date, firstName and lastName, and has unstructured text elements for the address and letter body. </para> <para> <programlisting role="xml"> <![CDATA[ <letter:letters xmlns:letter="http://letterSchema"> <date>March 1, 2005</date> Mutual of Omaha Wild Kingdom, USA Dear <firstName>Casy</firstName> <lastName>Crocodile</lastName> Please buy more shark repellent. Your premium is past due. </letter:letters> ]]> </programlisting> </para> <para> When loaded, the letter data object will have the sequence and property indices shown in the table below: <informaltable> <tgroup cols='3'> <thead> <row> <entry>Sequnece Index</entry> <entry>Property Index:Name</entry> <entry>Value</entry> </row> </thead> <tbody> <row> <entry>0</entry> <entry>0:date</entry> <entry>March 1, 2005</entry> </row> <row> <entry>1</entry> <entry>-</entry> <entry>Mutual of Omaha</entry> </row> <row> <entry>2</entry> <entry>-</entry> <entry>Wild Kingdom, USA</entry> </row> <row> <entry>3</entry> <entry>-</entry> <entry>Dear</entry> </row> <row> <entry>4</entry> <entry>1:firstName</entry> <entry>Casy</entry> </row> <row> <entry>5</entry> <entry>2:lastName</entry> <entry>Crocodile</entry> </row> <row> <entry>6</entry> <entry>-</entry> <entry>Please buy more shark repellent.</entry> </row> <row> <entry>7</entry> <entry>-</entry> <entry>Your premium is past due.</entry> </row> </tbody> </tgroup> </informaltable> </para> <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 <command>$letter</command>.... <example> <title>Getting the SDO_Sequence interface</title> <para> We obtain a data object's sequence using the <function>getSequence</function> method. The follow gets the sequence for the letter data object. </para> <programlisting role="php" id="sdo.examples.seqinterface"> <![CDATA[ <?php $letter_seq = $letter->getSequence(); ?> ]]> </programlisting> </example> </para> <para> All subsequent examples assume that the <command>$letter_seq</command> variable has been assigned the sequence for the letter data object. </para> <para> <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.'). </para> <programlisting role="php" id="sdo.examples.getsetseq"> <![CDATA[ <?php $letter_seq[4] = 'Snappy'; $text = $letter_seq[count($letter_seq) - 1]; ?> ]]> </programlisting> </example> </para> <para> <example> <title>Sequence iteration</title> <para> We can iterate through the individual sequence values using foreach. The following runs through the individual values in sequence order. </para> <programlisting role="php" id="sdo.examples.seqiter"> <![CDATA[ <?php foreach ($letter->getSequence() as $value) { ... } ?> ]]> </programlisting> </example> </para> <para> <example> <title>Sequence versus Data Object</title> <para> Setting values through the data object interface may result in the value not being part of the sequence. A value set through the data object will only be accessible through the sequence if the property was already part of the sequence. The following example sets the lastName through the data object and gets it through the sequence. This is fine because lastName already exists in the sequence. If it had not previously been set, then lastName would be set to 'Smith', but would not be part of the sequence. </para> <programlisting role="php" id="sdo.examples.seqvsdo"> <![CDATA[ <?php $letter[2] = 'Smith'; $last_name = $letter_seq[5]; ?> ]]> </programlisting> </example> </para> <para> <example> <title>Adding to a sequence</title> <para> We can add new values to a sequence using the <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. </para> <programlisting role="php" id="sdo.examples.seqadd"> <![CDATA[ <?php // Append a firstName value to the sequence // value: 'Smith' // sequence index: NULL (append) // propertyIdentifier: 1 (firtName property index) $letters_seq->insert('Smith', NULL, 1); // Append a lastName value to the sequence // value: 'Jones' // sequence index: NULL (append) // property identifier: 'lastName' (lastName property name) $letters_seq->insert('Jones', NULL, 'lastName'); // Append unstructured text // value: 'Cancel Subscription.' // sequence index: absent (append) // propertyIdentifier: absent (unstructured text) $letters_seq->insert('Cancel Subscription.'); // Insert new unstructured text. Subsequent sequence values // are shifted up. // value: 'Care of:' // sequence index: 1 (insert as second element) // propertyIdentifier: absent (unstructured text) $letters_seq->insert('Care of:', 1); ?> ]]> </programlisting> </example> </para> <para> <example> <title>Removing from a sequence</title> <para> We can use the <function>isset</function> and <function>unset</function> functions to test and remove items from the sequence (Note: <function>unset</function> currently leaves the values in the data object, but this behaviour is likely to change to also remove the data from the data object). Sequence behaves like a contiguous list and therefore removing from the middle results in entries at higher indices being shifted down. The following example tests to see if the first sequence element is set and unsets it if is. </para> <programlisting role="php" id="sdo.examples.seqremove"> <![CDATA[ <?php if (isset($letter_seq[0]) { unset($letter_seq[0]); } ?> ]]> </programlisting> </example> </para> </section>  <section id='sdo.classes'> &reftitle.classes; <para> SDO consists to two set of interfaces. The first set covers those interfaces for use by SDO client applications. These are identified by the package prefix 'SDO_'. The second set is those for use by Data Access Service implementations and are identified by the package prefix 'SDO_DAS_'. The majority of SDO users will not need to use or understand the 'SDO_DAS_' interfaces. </para> <section id='sdo.class.sdo-apis'> <title>SDO Application Programmer Interface</title> <section id='sdo.class.sdo-dataobject'> <title> <classname>SDO_DataObject</classname> </title> <para> The main interface through which data objects are manipulated. In addition to the methods below, SDO_DataObject extends the ArrayAccess, SDO_PropertyAccess (defines <function>__get</function> / <function>__set</function> methods for property access overloading), Iterator, and Countable interfaces </para> <section id='sdo.class.SDO_DataObject.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> <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 </para> </listitem> <listitem> <para> <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 </para> </listitem> <listitem> <para> <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 </para> </listitem> </itemizedlist> </section> </section> <section id='sdo.class.sdo-sequence'> <title> <classname>SDO_Sequence</classname> </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 down. In addition to the methods below, SDO_Sequence extends the ArrayAccess, Iterator and Countable interface. </para> <section id='sdo.class.SDO_Sequence.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> <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 </para> </listitem> <listitem> <para> <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 </para> </listitem> </itemizedlist> </section> </section> <section id='sdo.class.sdo-list'> <title> <classname>SDO_List</classname> </title> <para> The interface through which many-valued properties are manipulated. In addition to the method defined below, SDO_List extends ArrayAccess, Iterator and Coutable. SDO_List preserves contiguous indices and therefore inserting or removing elements may results in other elements shifted up or down. </para> <section id='sdo.class.SDO-List.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> <link linkend='function.SDO-List-insert'>insert</link> - insert a new value into the list </para> </listitem> </itemizedlist> </section> </section> <section id='sdo.class.sdo-datafactory'> <title> <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. </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 </para> </listitem> </itemizedlist> </section> </section> </section> <section id='sdo.class.sdo-das-spis'> <title> SDO Data Access Service Developer Interfaces </title> <section id='sdo.class.sdodas-dataobject'> <title> <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. </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 </para> </listitem> </itemizedlist> </section> </section> <section id='sdo.class.sdodas-changesummary'> <title> <classname>SDO_DAS_ChangeSummary</classname> </title> <para> The interface through which the change history of a data object is accessed. The change summary holds information for any modifications on a data object which occurred since logging was activated. In the case of deletions and modifications, the old values are also held in the change summary. </para> <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. This is useful when a set of changes have been written out by a DAS and the data object is to be reused. </para> <section id='sdo.class.SDO_DAS_ChangeSummary.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> <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 </para> </listitem> <listitem> <para> <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 </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 </para> </listitem> <listitem> <para> <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 </para> </listitem> </itemizedlist> </section> </section> <section id='sdo.class.sdodas-setting'> <title> <classname>SDO_DAS_Setting</classname> </title> <para> The interface through which the old value for a property is accessed. A list of settings is returned by the change summary method <link linkend='function.SDO-DAS-ChangeSummary-getOldValues'> <function>getOldValues</function> </link>.. </para> <section id='sdo.class.SDO_DAS_Setting.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> <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 </para> </listitem> <listitem> <para> <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 </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 </para> </listitem> </itemizedlist> </section> </section> <section id='sdo.class.sdodas-datafactory'> <title> <classname>SDO_DAS_DataFactory</classname> </title> <para> 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. 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> <section id='sdo.class.SDO_DAS_DataFactory.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> <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 </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 </para> </listitem> </itemizedlist> </section> </section> </section> </section> &reference.sdo.constants; </partintro> &reference.sdo.functions; </reference>