cvs: phpdoc /en/reference/sdo constants.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: | Matthew Peters | Date: | Wed, 20 Jul 2005 14:01:04 +0000 |
| Subject: | cvs: phpdoc /en/reference/sdo constants.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-969369244@lists.php.net to get a copy of this message | ||
mfp Wed Jul 20 10:01:04 2005 EDT
Modified 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-Setting-getListIndex.xml
SDO-DAS-ChangeSummary-getChangedDataObjects.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 constants.xml
Log:
Substantial WS change to get one-space indentation.
No other changes of any sort.
http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml Wed Jul 20 10:01:03 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-Sequence-getPropertyIndex"> <refnamediv> @@ -11,16 +11,19 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>int</type><methodname>SDO_Sequence::getPropertyIndex</methodname> - <methodparam><type>int</type><parameter>sequenceIndex</parameter></methodparam> + <type>int</type> + <methodname>SDO_Sequence::getPropertyIndex</methodname> + <methodparam> + <type>int</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. + 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> @@ -29,13 +32,15 @@ <para> <variablelist> <varlistentry> - <term><parameter>sequenceIndex</parameter></term> + <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> + </varlistentry> </variablelist> </para> </refsect1> @@ -49,16 +54,18 @@ <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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml Wed Jul 20 10:01:03 2005 @@ -1,118 +1,117 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getContainmentPropertyName"> - <refnamediv> - <refname>SDO_DataObject::getContainmentPropertyName</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DataObject::getContainmentPropertyName</refname> + <refpurpose> Get the container's property name. - - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>string</type> - <methodname>SDO_DataObject::getContainmentPropertyName</methodname> - <void/> - </methodsynopsis> + <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> + <para> + Get the property name used to refer to this data object by its containing data object. + </para> - </refsect1> - <refsect1 role="parameters"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> + <para> None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + </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> - - <!-- - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - </para> - </refsect1> - --> - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; + <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> + + <!-- + <refsect1 role="exceptions"> + &reftitle.exceptions; <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> </para> - </refsect1> + </refsect1> --> - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DataObject::getContainmentPropertyName</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DataObject::getContainmentPropertyName</function> example</title> + <para> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out + </para> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml Wed Jul 20 10:01:03 2005 @@ -1,119 +1,119 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-endLogging"> - <refnamediv> - <refname>SDO_DAS_ChangeSummary::endLogging</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_ChangeSummary::endLogging</refname> + <refpurpose> End change logging. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>void</type> - <methodname>SDO_DAS_ChangeSummary::endLogging</methodname> - <void/> - </methodsynopsis> + <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> + <para> + End logging changes made to an SDO_DataObject. + </para> - </refsect1> - <refsect1 role="parameters"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <para> + None. + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <para> None. - </para> - </refsect1> + </para> + </refsect1> - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_ChangeSummary::endLogging</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_ChangeSummary::endLogging</function> example</title> + <para> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out + </para> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml Wed Jul 20 10:01:03 2005 @@ -1,150 +1,157 @@ <?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-Sequence-move"> - <refnamediv> - <refname>SDO_Sequence::move</refname> - <refpurpose> + <refnamediv> + <refname>SDO_Sequence::move</refname> + <refpurpose> Move an item to another sequence position. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>void</type><methodname>SDO_Sequence::move</methodname> - <methodparam><type>int</type><parameter>toIndex</parameter></methodparam> - <methodparam><type>int</type><parameter>fromIndex</parameter></methodparam> - </methodsynopsis> + <methodsynopsis> + <type>void</type> + <methodname>SDO_Sequence::move</methodname> + <methodparam> + <type>int</type> + <parameter>toIndex</parameter> + </methodparam> + <methodparam> + <type>int</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> + <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"> + </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"> + <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> + <para> + None. + </para> + </refsect1> - <refsect1 role="exceptions"> + <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> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_Sequence::move</function> example</title> <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> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_Sequence::move</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldContainer"> <refnamediv> @@ -11,15 +11,19 @@ <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> + <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> + <para> + Get the old container (SDO_DataObject) for a deleted SDO_DataObject. + </para> </refsect1> @@ -28,10 +32,12 @@ <para> <variablelist> <varlistentry> - <term><parameter>dataObject</parameter></term> + <term> + <parameter>dataObject</parameter> + </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> @@ -41,7 +47,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -The old containing data object of the deleted SDO_DataObject. + The old containing data object of the deleted SDO_DataObject. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml Wed Jul 20 10:01:03 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-clear"> <refnamediv> @@ -11,7 +11,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>void</type><methodname>SDO_DataObject::clear</methodname> + <type>void</type> + <methodname>SDO_DataObject::clear</methodname> <void/> </methodsynopsis> @@ -26,14 +27,14 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - No return values. - </para> + No return values. + </para> </refsect1> <!-- Use when EXCEPTIONS exist http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml Wed Jul 20 10:01:03 2005 @@ -1,28 +1,34 @@ <?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-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> + <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 type name. - The type becomes part of the model of data objects that the data factory can create. -</para> + <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. + </para> </refsect1> <refsect1 role="parameters"> @@ -30,18 +36,22 @@ <para> <variablelist> <varlistentry> - <term><parameter>namespaceURI</parameter></term> + <term> + <parameter>namespaceURI</parameter> + </term> <listitem> <para> -The namespace of the type. + The namespace of the type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>typeName</parameter></term> + <term> + <parameter>typeName</parameter> + </term> <listitem> <para> -The name of the type. + The name of the type. </para> </listitem> </varlistentry> @@ -51,8 +61,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - No values returned. - </para> + No values returned. + </para> </refsect1> <!-- Use when EXCEPTIONS exist @@ -94,13 +104,15 @@ &reftitle.examples; <para> <example> - <title>A <function>SDO_DAS_DataFactory::addType</function> example</title> - <para> + <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> + </para> <programlisting role="php"> -<![CDATA[ + <![CDATA[ <?php $df->addType('CompanyNS', 'CompanyType'); ?> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml Wed Jul 20 10:01:03 2005 @@ -1,125 +1,124 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-Setting-getValue"> - <refnamediv> - <refname>SDO_DAS_Setting::getValue</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_Setting::getValue</refname> + <refpurpose> Get the old value for the changed property. - - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>mixed</type> - <methodname>SDO_DAS_Setting::getValue</methodname> - <void/> - </methodsynopsis> + <methodsynopsis> + <type>mixed</type> + <methodname>SDO_DAS_Setting::getValue</methodname> + <void/> + </methodsynopsis> &warn.experimental.func; - <para> + <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. + 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> + </para> - </refsect1> + </refsect1> - <refsect1 role="parameters"> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <para> + None. + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; + <para> + Returns the old value of the changed property. + </para> + </refsect1> + + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_Setting::getValue</function> example</title> <para> -Returns the old value of the changed property. + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_Setting::getValue</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.2 Tue Jul 19 04:57:52 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml Wed Jul 20 10:01:03 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-getChangeType"> <refnamediv> @@ -11,15 +11,19 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>int</type><methodname>SDO_DAS_ChangeSummary::getChangeType</methodname> - <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> + <type>int</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> + <para> + Get the type of change which has been made to the supplied SDO_DataObject. + </para> </refsect1> <refsect1 role="parameters"> @@ -27,10 +31,12 @@ <para> <variablelist> <varlistentry> - <term><parameter>dataObject</parameter></term> + <term> + <parameter>dataObject</parameter> + </term> <listitem> <para> -The SDO_DataObject which has been changed. + The SDO_DataObject which has been changed. </para> </listitem> </varlistentry> @@ -40,31 +46,30 @@ <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> + 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> <!-- Use when EXCEPTIONS exist http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml Wed Jul 20 10:01:03 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-isLogging"> <refnamediv> @@ -11,7 +11,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>SDO_DAS_ChangeSummary::isLogging</methodname> + <type>bool</type> + <methodname>SDO_DAS_ChangeSummary::isLogging</methodname> <void/> </methodsynopsis> @@ -25,7 +26,7 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + None. </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml Wed Jul 20 10:01:03 2005 @@ -1,38 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <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> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The property index for a changed property. + The property index for a changed property. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml Wed Jul 20 10:01:03 2005 @@ -1,122 +1,123 @@ <?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-getListIndex"> - <refnamediv> - <refname>SDO_DAS_Setting::getListIndex</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_Setting::getListIndex</refname> + <refpurpose> Get the list index for a changed many-valued property. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>SDO_DAS_Setting::getListIndex</methodname> - <void/> - </methodsynopsis> + <methodsynopsis> + <type>int</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> + <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"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <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> + + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_Setting::getListIndex</function> example</title> <para> - The list index for the element of the many-valued property which has been changed. + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_Setting::getListIndex</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getChangedDataObjects"> <refnamediv> @@ -11,28 +11,29 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_List</type><methodname>SDO_DAS_ChangeSummary::getChangedDataObjects</methodname> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns an SDO_List of SDO_DataObjects. + Returns an SDO_List of SDO_DataObjects. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml Wed Jul 20 10:01:03 2005 @@ -1,25 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getContainer"> <refnamediv> <refname>SDO_DataObject::getContainer</refname> <refpurpose> - Get a data object's container. - + Get a data object's container. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DataObject</type><methodname>SDO_DataObject::getContainer</methodname> + <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> + Get the data object which contains this data object. </para> @@ -27,14 +27,14 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + 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). + 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.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml Wed Jul 20 10:01:03 2005 @@ -1,18 +1,18 @@ <?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-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>bool</type><methodname>SDO_DAS_Setting::isSet</methodname> + <type>bool</type> + <methodname>SDO_DAS_Setting::isSet</methodname> <void/> </methodsynopsis> @@ -27,7 +27,7 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + None. </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml Wed Jul 20 10:01:03 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-createDataObject"> <refnamediv> @@ -11,16 +11,20 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DataObject</type><methodname>SDO_DataObject::createDataObject</methodname> - <methodparam><type>mixed</type><parameter>identifier</parameter></methodparam> + <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> + <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> @@ -29,11 +33,13 @@ <para> <variablelist> <varlistentry> - <term><parameter>identifier</parameter></term> + <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). + 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> @@ -43,25 +49,25 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns the newly created SDO_DataObject. + 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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml Wed Jul 20 10:01:03 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-Sequence-insert"> <refnamediv> @@ -11,17 +11,27 @@ <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>int</type><parameter>sequenceIndex</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter>propertyIdentifier</parameter></methodparam> + <type>void</type> + <methodname>SDO_Sequence::insert</methodname> + <methodparam> + <type>mixed</type> + <parameter>value</parameter> + </methodparam> + <methodparam choice="opt"> + <type>int</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> + <para> + Insert a new element at a specified position in the sequence. All subsequent sequence items are moved up. + </para> </refsect1> <refsect1 role="parameters"> @@ -29,30 +39,36 @@ <para> <variablelist> <varlistentry> - <term><parameter>value</parameter></term> + <term> + <parameter>value</parameter> + </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> <varlistentry> - <term><parameter>sequenceIndex</parameter></term> + <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. + 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> + <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. + 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> + </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> @@ -66,24 +82,28 @@ &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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml Wed Jul 20 10:01:03 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-Sequence-getPropertyName"> <refnamediv> @@ -11,17 +11,20 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>string</type><methodname>SDO_Sequence::getPropertyName</methodname> - <methodparam><type>int</type><parameter>sequenceIndex</parameter></methodparam> + <type>string</type> + <methodname>SDO_Sequence::getPropertyName</methodname> + <methodparam> + <type>int</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> + <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> @@ -30,36 +33,40 @@ <para> <variablelist> <varlistentry> - <term><parameter>sequenceIndex</parameter></term> + <term> + <parameter>sequenceIndex</parameter> + </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> </variablelist> - </para> + </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. + 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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldValues"> <refnamediv> @@ -11,15 +11,19 @@ <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> + <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> + 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> @@ -29,10 +33,12 @@ <para> <variablelist> <varlistentry> - <term><parameter>dataObject</parameter></term> + <term> + <parameter>dataObject</parameter> + </term> <listitem> <para> -The data object which has been changed. + The data object which has been changed. </para> </listitem> </varlistentry> @@ -42,7 +48,7 @@ <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.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getSequence"> <refnamediv> @@ -11,31 +11,32 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_Sequence</type><methodname>SDO_DataObject::getSequence</methodname> + <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> + 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> + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + 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. + 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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-List-insert.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-List-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-List-insert.xml Wed Jul 20 10:01:03 2005 @@ -1,158 +1,166 @@ <?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-List-insert"> - <refnamediv> - <refname>SDO_List::insert</refname> - <refpurpose> + <refnamediv> + <refname>SDO_List::insert</refname> + <refpurpose> Insert into a list. - - - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </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>int</type><parameter>index</parameter></methodparam> - </methodsynopsis> + <methodsynopsis> + <type>void</type> + <methodname>SDO_List::insert</methodname> + <methodparam> + <type>mixed</type> + <parameter>value</parameter> + </methodparam> + <methodparam choice="opt"> + <type>int</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> + <para> + Insert a new element at a specified position in the list. All subsequent list items are moved up. + </para> - </refsect1> - <refsect1 role="parameters"> + </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"> + <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> + <para> + None. + </para> + </refsect1> - <refsect1 role="exceptions"> + <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> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_List::insert</function> example</title> <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> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_List::insert</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataFactory-getDataFactory"> <refnamediv> @@ -12,32 +12,32 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DAS_DataFactory</type><methodname>SDO_DAS_DataFactory::getDataFactory</methodname> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns an SDO_DAS_DataFactory. + Returns an SDO_DAS_DataFactory. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml Wed Jul 20 10:01:03 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-getType"> <refnamediv> @@ -11,7 +11,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>array</type><methodname>SDO_DataObject::getType</methodname> + <type>array</type> + <methodname>SDO_DataObject::getType</methodname> <void/> </methodsynopsis> @@ -27,14 +28,14 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + 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> + An array containing the namespace URI string and the type name string for the data object. + </para> </refsect1> <!-- Use when EXCEPTIONS exist @@ -76,14 +77,16 @@ &reftitle.examples; <para> <example> - <title>A <function>SDO_DataObject::getType</function> example</title> + <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[ + <![CDATA[ <?php $do_type = $company_do->getType(); echo "Namespace: $do_type[0], Type Name: $do_type[1]"; @@ -92,7 +95,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-DAS-ChangeSummary-beginLogging.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml Wed Jul 20 10:01:03 2005 @@ -1,119 +1,119 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-beginLogging"> - <refnamediv> - <refname>SDO_DAS_ChangeSummary::beginLogging</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_ChangeSummary::beginLogging</refname> + <refpurpose> Begin change logging. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>void</type> - <methodname>SDO_DAS_ChangeSummary::beginLogging</methodname> - <void/> - </methodsynopsis> + <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> + <para> + Begin logging changes made to the SDO_DataObject. + </para> - </refsect1> - <refsect1 role="parameters"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <para> + None. + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; + <para> + None. + </para> + </refsect1> + + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_ChangeSummary::beginLogging</function> example</title> <para> - None. + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_ChangeSummary::beginLogging</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataFactory-create"> <refnamediv> @@ -11,16 +11,23 @@ <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> + <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> + <para> + Create a new SDO_DataObject given the data object's namespace URI and type name. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,18 +35,22 @@ <para> <variablelist> <varlistentry> - <term><parameter>namespaceURI</parameter></term> + <term> + <parameter>namespaceURI</parameter> + </term> <listitem> <para> -The namespace of the type. + The namespace of the type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>typeName</parameter></term> + <term> + <parameter>typeName</parameter> + </term> <listitem> <para> -The name of the type. + The name of the type. </para> </listitem> </varlistentry> @@ -49,25 +60,25 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns the newly created SDO_DataObject. + 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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataObject-getChangeSummary"> <refnamediv> @@ -11,27 +11,28 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DAS_ChangeSummary</type><methodname>SDO_DAS_DataObject::getChangeSummary</methodname> + <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> + <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. + 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. + 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.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml Wed Jul 20 10:01:03 2005 @@ -1,38 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <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> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -The property name for a changed property. + The property name for a changed property. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml Wed Jul 20 10:01:03 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-addPropertyToType"> <refnamediv> @@ -11,25 +11,50 @@ <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>bool</type><parameter>many</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>readOnly</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>containment</parameter></methodparam> + <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>bool</type> + <parameter>many</parameter> + </methodparam> + <methodparam choice="opt"> + <type>bool</type> + <parameter>readOnly</parameter> + </methodparam> + <methodparam choice="opt"> + <type>bool</type> + <parameter>containment</parameter> + </methodparam> </methodsynopsis> &warn.experimental.func; -<para> + <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> + 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"> @@ -37,71 +62,87 @@ <para> <variablelist> <varlistentry> - <term><parameter>parentNamespaceURI</parameter></term> + <term> + <parameter>parentNamespaceURI</parameter> + </term> <listitem> <para> -The namespace URI for the parent type. + The namespace URI for the parent type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>parentTypeName</parameter></term> + <term> + <parameter>parentTypeName</parameter> + </term> <listitem> <para> -The type name for the parent type. + The type name for the parent type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>propertyName</parameter></term> + <term> + <parameter>propertyName</parameter> + </term> <listitem> <para> -The name of by which the property will be known in the parent type. + The name by which the property will be known in the parent type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>propertyNamespaceURI</parameter></term> + <term> + <parameter>propertyNamespaceURI</parameter> + </term> <listitem> <para> -The namespace URI for the type of the property. + The namespace URI for the type of the property. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>propertyTypeName</parameter></term> + <term> + <parameter>propertyTypeName</parameter> + </term> <listitem> <para> -The type name for the type of the property + The type name for the type of the property </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>many</parameter></term> + <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') + 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> + <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') + 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> + <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. + 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> @@ -111,7 +152,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - None. + None. </para> </refsect1> @@ -152,13 +193,15 @@ &reftitle.examples; <para> <example> - <title>A <function>SDO_DAS_DataFactory::addPropertyToType</function> example</title> + <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 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[ + <![CDATA[ <?php $df->addPropertyToType('PersonNS', 'PersonType', 'name', 'commonj.sdo', 'String'); http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/constants.xml diff -u phpdoc/en/reference/sdo/constants.xml:1.1 phpdoc/en/reference/sdo/constants.xml:1.2 --- phpdoc/en/reference/sdo/constants.xml:1.1 Mon Jul 18 16:42:58 2005 +++ phpdoc/en/reference/sdo/constants.xml Wed Jul 20 10:01:04 2005 @@ -1,21 +1,21 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <section id="sdo.constants"> &reftitle.constants; &extension.constants; <variablelist> - <varlistentry> - <term> - <constant>SDO_DAS_ChangeSummary::NONE=0</constant> + <varlistentry> + <term> + <constant>SDO_DAS_ChangeSummary::NONE=0</constant> (<type>integer</type>) - </term> - <listitem> - <simpara> - Represents a change type of 'none'. - </simpara> - </listitem> - </varlistentry> + </term> + <listitem> + <simpara> + Represents a change type of 'none'. + </simpara> + </listitem> + </varlistentry> <varlistentry> <term> <constant>SDO_DAS_ChangeSummary::MODIFICATION=1</constant>
http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyIndex.xml Wed Jul 20 10:01:03 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-Sequence-getPropertyIndex"> <refnamediv> @@ -11,16 +11,19 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>int</type><methodname>SDO_Sequence::getPropertyIndex</methodname> - <methodparam><type>int</type><parameter>sequenceIndex</parameter></methodparam> + <type>int</type> + <methodname>SDO_Sequence::getPropertyIndex</methodname> + <methodparam> + <type>int</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. + 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> @@ -29,13 +32,15 @@ <para> <variablelist> <varlistentry> - <term><parameter>sequenceIndex</parameter></term> + <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> + </varlistentry> </variablelist> </para> </refsect1> @@ -49,16 +54,18 @@ <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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainmentPropertyName.xml Wed Jul 20 10:01:03 2005 @@ -1,118 +1,117 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getContainmentPropertyName"> - <refnamediv> - <refname>SDO_DataObject::getContainmentPropertyName</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DataObject::getContainmentPropertyName</refname> + <refpurpose> Get the container's property name. - - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>string</type> - <methodname>SDO_DataObject::getContainmentPropertyName</methodname> - <void/> - </methodsynopsis> + <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> + <para> + Get the property name used to refer to this data object by its containing data object. + </para> - </refsect1> - <refsect1 role="parameters"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> + <para> None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + </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> - - <!-- - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - </para> - </refsect1> - --> - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; + <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> + + <!-- + <refsect1 role="exceptions"> + &reftitle.exceptions; <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> </para> - </refsect1> + </refsect1> --> - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DataObject::getContainmentPropertyName</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DataObject::getContainmentPropertyName</function> example</title> + <para> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out + </para> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-endLogging.xml Wed Jul 20 10:01:03 2005 @@ -1,119 +1,119 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-endLogging"> - <refnamediv> - <refname>SDO_DAS_ChangeSummary::endLogging</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_ChangeSummary::endLogging</refname> + <refpurpose> End change logging. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>void</type> - <methodname>SDO_DAS_ChangeSummary::endLogging</methodname> - <void/> - </methodsynopsis> + <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> + <para> + End logging changes made to an SDO_DataObject. + </para> - </refsect1> - <refsect1 role="parameters"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <para> + None. + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <para> + <para> None. - </para> - </refsect1> + </para> + </refsect1> - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_ChangeSummary::endLogging</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_ChangeSummary::endLogging</function> example</title> + <para> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out + </para> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-move.xml Wed Jul 20 10:01:03 2005 @@ -1,150 +1,157 @@ <?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-Sequence-move"> - <refnamediv> - <refname>SDO_Sequence::move</refname> - <refpurpose> + <refnamediv> + <refname>SDO_Sequence::move</refname> + <refpurpose> Move an item to another sequence position. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>void</type><methodname>SDO_Sequence::move</methodname> - <methodparam><type>int</type><parameter>toIndex</parameter></methodparam> - <methodparam><type>int</type><parameter>fromIndex</parameter></methodparam> - </methodsynopsis> + <methodsynopsis> + <type>void</type> + <methodname>SDO_Sequence::move</methodname> + <methodparam> + <type>int</type> + <parameter>toIndex</parameter> + </methodparam> + <methodparam> + <type>int</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> + <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"> + </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"> + <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> + <para> + None. + </para> + </refsect1> - <refsect1 role="exceptions"> + <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> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_Sequence::move</function> example</title> <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> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_Sequence::move</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldContainer"> <refnamediv> @@ -11,15 +11,19 @@ <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> + <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> + <para> + Get the old container (SDO_DataObject) for a deleted SDO_DataObject. + </para> </refsect1> @@ -28,10 +32,12 @@ <para> <variablelist> <varlistentry> - <term><parameter>dataObject</parameter></term> + <term> + <parameter>dataObject</parameter> + </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> @@ -41,7 +47,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -The old containing data object of the deleted SDO_DataObject. + The old containing data object of the deleted SDO_DataObject. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-clear.xml Wed Jul 20 10:01:03 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-clear"> <refnamediv> @@ -11,7 +11,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>void</type><methodname>SDO_DataObject::clear</methodname> + <type>void</type> + <methodname>SDO_DataObject::clear</methodname> <void/> </methodsynopsis> @@ -26,14 +27,14 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - No return values. - </para> + No return values. + </para> </refsect1> <!-- Use when EXCEPTIONS exist http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml Wed Jul 20 10:01:03 2005 @@ -1,28 +1,34 @@ <?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-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> + <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 type name. - The type becomes part of the model of data objects that the data factory can create. -</para> + <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. + </para> </refsect1> <refsect1 role="parameters"> @@ -30,18 +36,22 @@ <para> <variablelist> <varlistentry> - <term><parameter>namespaceURI</parameter></term> + <term> + <parameter>namespaceURI</parameter> + </term> <listitem> <para> -The namespace of the type. + The namespace of the type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>typeName</parameter></term> + <term> + <parameter>typeName</parameter> + </term> <listitem> <para> -The name of the type. + The name of the type. </para> </listitem> </varlistentry> @@ -51,8 +61,8 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - No values returned. - </para> + No values returned. + </para> </refsect1> <!-- Use when EXCEPTIONS exist @@ -94,13 +104,15 @@ &reftitle.examples; <para> <example> - <title>A <function>SDO_DAS_DataFactory::addType</function> example</title> - <para> + <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> + </para> <programlisting role="php"> -<![CDATA[ + <![CDATA[ <?php $df->addType('CompanyNS', 'CompanyType'); ?> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getValue.xml Wed Jul 20 10:01:03 2005 @@ -1,125 +1,124 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-Setting-getValue"> - <refnamediv> - <refname>SDO_DAS_Setting::getValue</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_Setting::getValue</refname> + <refpurpose> Get the old value for the changed property. - - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>mixed</type> - <methodname>SDO_DAS_Setting::getValue</methodname> - <void/> - </methodsynopsis> + <methodsynopsis> + <type>mixed</type> + <methodname>SDO_DAS_Setting::getValue</methodname> + <void/> + </methodsynopsis> &warn.experimental.func; - <para> + <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. + 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> + </para> - </refsect1> + </refsect1> - <refsect1 role="parameters"> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <para> + None. + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; + <para> + Returns the old value of the changed property. + </para> + </refsect1> + + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_Setting::getValue</function> example</title> <para> -Returns the old value of the changed property. + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_Setting::getValue</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml:1.2 Tue Jul 19 04:57:52 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangeType.xml Wed Jul 20 10:01:03 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-getChangeType"> <refnamediv> @@ -11,15 +11,19 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>int</type><methodname>SDO_DAS_ChangeSummary::getChangeType</methodname> - <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> + <type>int</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> + <para> + Get the type of change which has been made to the supplied SDO_DataObject. + </para> </refsect1> <refsect1 role="parameters"> @@ -27,10 +31,12 @@ <para> <variablelist> <varlistentry> - <term><parameter>dataObject</parameter></term> + <term> + <parameter>dataObject</parameter> + </term> <listitem> <para> -The SDO_DataObject which has been changed. + The SDO_DataObject which has been changed. </para> </listitem> </varlistentry> @@ -40,31 +46,30 @@ <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> + 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> <!-- Use when EXCEPTIONS exist http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-isLogging.xml Wed Jul 20 10:01:03 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-isLogging"> <refnamediv> @@ -11,7 +11,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>bool</type><methodname>SDO_DAS_ChangeSummary::isLogging</methodname> + <type>bool</type> + <methodname>SDO_DAS_ChangeSummary::isLogging</methodname> <void/> </methodsynopsis> @@ -25,7 +26,7 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + None. </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyIndex.xml Wed Jul 20 10:01:03 2005 @@ -1,38 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <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> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - The property index for a changed property. + The property index for a changed property. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getListIndex.xml Wed Jul 20 10:01:03 2005 @@ -1,122 +1,123 @@ <?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-getListIndex"> - <refnamediv> - <refname>SDO_DAS_Setting::getListIndex</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_Setting::getListIndex</refname> + <refpurpose> Get the list index for a changed many-valued property. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>SDO_DAS_Setting::getListIndex</methodname> - <void/> - </methodsynopsis> + <methodsynopsis> + <type>int</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> + <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"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <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> + + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_Setting::getListIndex</function> example</title> <para> - The list index for the element of the many-valued property which has been changed. + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_Setting::getListIndex</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getChangedDataObjects.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getChangedDataObjects"> <refnamediv> @@ -11,28 +11,29 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_List</type><methodname>SDO_DAS_ChangeSummary::getChangedDataObjects</methodname> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns an SDO_List of SDO_DataObjects. + Returns an SDO_List of SDO_DataObjects. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getContainer.xml Wed Jul 20 10:01:03 2005 @@ -1,25 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getContainer"> <refnamediv> <refname>SDO_DataObject::getContainer</refname> <refpurpose> - Get a data object's container. - + Get a data object's container. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DataObject</type><methodname>SDO_DataObject::getContainer</methodname> + <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> + Get the data object which contains this data object. </para> @@ -27,14 +27,14 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + 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). + 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.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-isSet.xml Wed Jul 20 10:01:03 2005 @@ -1,18 +1,18 @@ <?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-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>bool</type><methodname>SDO_DAS_Setting::isSet</methodname> + <type>bool</type> + <methodname>SDO_DAS_Setting::isSet</methodname> <void/> </methodsynopsis> @@ -27,7 +27,7 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + None. </para> </refsect1> <refsect1 role="returnvalues"> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml Wed Jul 20 10:01:03 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-createDataObject"> <refnamediv> @@ -11,16 +11,20 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DataObject</type><methodname>SDO_DataObject::createDataObject</methodname> - <methodparam><type>mixed</type><parameter>identifier</parameter></methodparam> + <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> + <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> @@ -29,11 +33,13 @@ <para> <variablelist> <varlistentry> - <term><parameter>identifier</parameter></term> + <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). + 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> @@ -43,25 +49,25 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns the newly created SDO_DataObject. + 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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml Wed Jul 20 10:01:03 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-Sequence-insert"> <refnamediv> @@ -11,17 +11,27 @@ <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>int</type><parameter>sequenceIndex</parameter></methodparam> - <methodparam choice="opt"><type>mixed</type><parameter>propertyIdentifier</parameter></methodparam> + <type>void</type> + <methodname>SDO_Sequence::insert</methodname> + <methodparam> + <type>mixed</type> + <parameter>value</parameter> + </methodparam> + <methodparam choice="opt"> + <type>int</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> + <para> + Insert a new element at a specified position in the sequence. All subsequent sequence items are moved up. + </para> </refsect1> <refsect1 role="parameters"> @@ -29,30 +39,36 @@ <para> <variablelist> <varlistentry> - <term><parameter>value</parameter></term> + <term> + <parameter>value</parameter> + </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> <varlistentry> - <term><parameter>sequenceIndex</parameter></term> + <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. + 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> + <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. + 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> + </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> @@ -66,24 +82,28 @@ &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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getPropertyName.xml Wed Jul 20 10:01:03 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-Sequence-getPropertyName"> <refnamediv> @@ -11,17 +11,20 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>string</type><methodname>SDO_Sequence::getPropertyName</methodname> - <methodparam><type>int</type><parameter>sequenceIndex</parameter></methodparam> + <type>string</type> + <methodname>SDO_Sequence::getPropertyName</methodname> + <methodparam> + <type>int</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> + <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> @@ -30,36 +33,40 @@ <para> <variablelist> <varlistentry> - <term><parameter>sequenceIndex</parameter></term> + <term> + <parameter>sequenceIndex</parameter> + </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> </variablelist> - </para> + </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. + 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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldValues"> <refnamediv> @@ -11,15 +11,19 @@ <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> + <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> + 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> @@ -29,10 +33,12 @@ <para> <variablelist> <varlistentry> - <term><parameter>dataObject</parameter></term> + <term> + <parameter>dataObject</parameter> + </term> <listitem> <para> -The data object which has been changed. + The data object which has been changed. </para> </listitem> </varlistentry> @@ -42,7 +48,7 @@ <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.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getSequence.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getSequence"> <refnamediv> @@ -11,31 +11,32 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_Sequence</type><methodname>SDO_DataObject::getSequence</methodname> + <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> + 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> + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + 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. + 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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-List-insert.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-List-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-List-insert.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-List-insert.xml Wed Jul 20 10:01:03 2005 @@ -1,158 +1,166 @@ <?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-List-insert"> - <refnamediv> - <refname>SDO_List::insert</refname> - <refpurpose> + <refnamediv> + <refname>SDO_List::insert</refname> + <refpurpose> Insert into a list. - - - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </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>int</type><parameter>index</parameter></methodparam> - </methodsynopsis> + <methodsynopsis> + <type>void</type> + <methodname>SDO_List::insert</methodname> + <methodparam> + <type>mixed</type> + <parameter>value</parameter> + </methodparam> + <methodparam choice="opt"> + <type>int</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> + <para> + Insert a new element at a specified position in the list. All subsequent list items are moved up. + </para> - </refsect1> - <refsect1 role="parameters"> + </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"> + <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> + <para> + None. + </para> + </refsect1> - <refsect1 role="exceptions"> + <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> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_List::insert</function> example</title> <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> + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_List::insert</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-getDataFactory.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataFactory-getDataFactory"> <refnamediv> @@ -12,32 +12,32 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DAS_DataFactory</type><methodname>SDO_DAS_DataFactory::getDataFactory</methodname> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns an SDO_DAS_DataFactory. + Returns an SDO_DAS_DataFactory. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getType.xml Wed Jul 20 10:01:03 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-getType"> <refnamediv> @@ -11,7 +11,8 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>array</type><methodname>SDO_DataObject::getType</methodname> + <type>array</type> + <methodname>SDO_DataObject::getType</methodname> <void/> </methodsynopsis> @@ -27,14 +28,14 @@ <refsect1 role="parameters"> &reftitle.parameters; <para> - None. + 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> + An array containing the namespace URI string and the type name string for the data object. + </para> </refsect1> <!-- Use when EXCEPTIONS exist @@ -76,14 +77,16 @@ &reftitle.examples; <para> <example> - <title>A <function>SDO_DataObject::getType</function> example</title> + <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[ + <![CDATA[ <?php $do_type = $company_do->getType(); echo "Namespace: $do_type[0], Type Name: $do_type[1]"; @@ -92,7 +95,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-DAS-ChangeSummary-beginLogging.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-beginLogging.xml Wed Jul 20 10:01:03 2005 @@ -1,119 +1,119 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-beginLogging"> - <refnamediv> - <refname>SDO_DAS_ChangeSummary::beginLogging</refname> - <refpurpose> + <refnamediv> + <refname>SDO_DAS_ChangeSummary::beginLogging</refname> + <refpurpose> Begin change logging. - </refpurpose> - </refnamediv> - <refsect1 role="description"> + </refpurpose> + </refnamediv> + <refsect1 role="description"> &reftitle.description; - <methodsynopsis> - <type>void</type> - <methodname>SDO_DAS_ChangeSummary::beginLogging</methodname> - <void/> - </methodsynopsis> + <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> + <para> + Begin logging changes made to the SDO_DataObject. + </para> - </refsect1> - <refsect1 role="parameters"> + </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; - <para> - None. - </para> - </refsect1> - <refsect1 role="returnvalues"> + <para> + None. + </para> + </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; + <para> + None. + </para> + </refsect1> + + <!-- Use when EXCEPTIONS exist + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + When does this function throw exceptions? + </para> + </refsect1> + --> + + + <!-- Use when a CHANGELOG exists + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Enter the PHP version of change here + <entry>Description of change + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + --> + + + <!-- Use when examples exist + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>A <function>SDO_DAS_ChangeSummary::beginLogging</function> example</title> <para> - None. + Any text that describes the purpose of the example, or + what goes on in the example should go here (inside the + <example> tag, not out </para> - </refsect1> - - <!-- Use when EXCEPTIONS exist - <refsect1 role="exceptions"> - &reftitle.exceptions; - <para> - When does this function throw exceptions? - </para> - </refsect1> - --> - - - <!-- Use when a CHANGELOG exists - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Enter the PHP version of change here - <entry>Description of change - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> - --> - - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>SDO_DAS_ChangeSummary::beginLogging</function> example</title> - <para> - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - <example> tag, not out - </para> - <programlisting role="php"> - <![CDATA[ - <?php - if ($anexample === true) { - echo 'Use the PEAR Coding Standards'; - } - ?> - ]]> - </programlisting> - &example.outputs; - <screen> - <![CDATA[ - Use the PEAR Coding Standards - ]]> - </screen> - </example> - </para> - </refsect1> - --> - - - <!-- Use when adding See Also links - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> - </simplelist> - </para> - </refsect1> - --> + <programlisting role="php"> +<![CDATA[ +<?php +if ($anexample === true) { + echo 'Use the PEAR Coding Standards'; +} +?> +]]> + </programlisting> + &example.outputs; + <screen> +<![CDATA[ +Use the PEAR Coding Standards +]]> + </screen> + </example> + </para> + </refsect1> + --> + + + <!-- Use when adding See Also links + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function></function></member> + <member>Or <link linkend="somethingelse">something else</link></member> + </simplelist> + </para> + </refsect1> + --> </refentry> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.1 phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataFactory-create"> <refnamediv> @@ -11,16 +11,23 @@ <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> + <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> + <para> + Create a new SDO_DataObject given the data object's namespace URI and type name. + </para> </refsect1> <refsect1 role="parameters"> @@ -28,18 +35,22 @@ <para> <variablelist> <varlistentry> - <term><parameter>namespaceURI</parameter></term> + <term> + <parameter>namespaceURI</parameter> + </term> <listitem> <para> -The namespace of the type. + The namespace of the type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>typeName</parameter></term> + <term> + <parameter>typeName</parameter> + </term> <listitem> <para> -The name of the type. + The name of the type. </para> </listitem> </varlistentry> @@ -49,25 +60,25 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -Returns the newly created SDO_DataObject. + 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> + <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> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml?r1=1.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataObject-getChangeSummary.xml Wed Jul 20 10:01:03 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataObject-getChangeSummary"> <refnamediv> @@ -11,27 +11,28 @@ <refsect1 role="description"> &reftitle.description; <methodsynopsis> - <type>SDO_DAS_ChangeSummary</type><methodname>SDO_DAS_DataObject::getChangeSummary</methodname> + <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> + <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. + 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. + 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.1&r2=1.2&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.1 phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.2 --- phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml:1.1 Mon Jul 18 16:42:57 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-Setting-getPropertyName.xml Wed Jul 20 10:01:03 2005 @@ -1,38 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <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> + <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> + <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. + None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> -The property name for a changed property. + The property name for a changed property. </para> </refsect1> http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml?r1=1.2&r2=1.3&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.2 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.2 Tue Jul 19 04:57:53 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml Wed Jul 20 10:01:03 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-addPropertyToType"> <refnamediv> @@ -11,25 +11,50 @@ <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>bool</type><parameter>many</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>readOnly</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>containment</parameter></methodparam> + <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>bool</type> + <parameter>many</parameter> + </methodparam> + <methodparam choice="opt"> + <type>bool</type> + <parameter>readOnly</parameter> + </methodparam> + <methodparam choice="opt"> + <type>bool</type> + <parameter>containment</parameter> + </methodparam> </methodsynopsis> &warn.experimental.func; -<para> + <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> + 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"> @@ -37,71 +62,87 @@ <para> <variablelist> <varlistentry> - <term><parameter>parentNamespaceURI</parameter></term> + <term> + <parameter>parentNamespaceURI</parameter> + </term> <listitem> <para> -The namespace URI for the parent type. + The namespace URI for the parent type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>parentTypeName</parameter></term> + <term> + <parameter>parentTypeName</parameter> + </term> <listitem> <para> -The type name for the parent type. + The type name for the parent type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>propertyName</parameter></term> + <term> + <parameter>propertyName</parameter> + </term> <listitem> <para> -The name of by which the property will be known in the parent type. + The name by which the property will be known in the parent type. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>propertyNamespaceURI</parameter></term> + <term> + <parameter>propertyNamespaceURI</parameter> + </term> <listitem> <para> -The namespace URI for the type of the property. + The namespace URI for the type of the property. </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>propertyTypeName</parameter></term> + <term> + <parameter>propertyTypeName</parameter> + </term> <listitem> <para> -The type name for the type of the property + The type name for the type of the property </para> </listitem> </varlistentry> <varlistentry> - <term><parameter>many</parameter></term> + <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') + 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> + <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') + 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> + <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. + 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> @@ -111,7 +152,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - None. + None. </para> </refsect1> @@ -152,13 +193,15 @@ &reftitle.examples; <para> <example> - <title>A <function>SDO_DAS_DataFactory::addPropertyToType</function> example</title> + <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 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[ + <![CDATA[ <?php $df->addPropertyToType('PersonNS', 'PersonType', 'name', 'commonj.sdo', 'String'); http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/constants.xml?r1=1.1&r2=1.2&ty=u Index: phpdoc/en/reference/sdo/constants.xml diff -u phpdoc/en/reference/sdo/constants.xml:1.1 phpdoc/en/reference/sdo/constants.xml:1.2 --- phpdoc/en/reference/sdo/constants.xml:1.1 Mon Jul 18 16:42:58 2005 +++ phpdoc/en/reference/sdo/constants.xml Wed Jul 20 10:01:04 2005 @@ -1,21 +1,21 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <section id="sdo.constants"> &reftitle.constants; &extension.constants; <variablelist> - <varlistentry> - <term> - <constant>SDO_DAS_ChangeSummary::NONE=0</constant> + <varlistentry> + <term> + <constant>SDO_DAS_ChangeSummary::NONE=0</constant> (<type>integer</type>) - </term> - <listitem> - <simpara> - Represents a change type of 'none'. - </simpara> - </listitem> - </varlistentry> + </term> + <listitem> + <simpara> + Represents a change type of 'none'. + </simpara> + </listitem> + </varlistentry> <varlistentry> <term> <constant>SDO_DAS_ChangeSummary::MODIFICATION=1</constant>