cvs: phpdoc /en/reference/sdo reference.xml /en/reference/sdo/functions SDO-DAS-ChangeSummary-getOldContainer.xml
SDO-DAS-ChangeSummary-getOldValues.xml SDO-DAS-DataFactory-addPropertyToType.xml SDO-DAS-DataFactory-addType.xml SDO-DataFactory-create.xml
SDO-DataObject-createDataObject.xml SDO-DataObject-getContainmentPropertyName.xml SDO-DataObject-getType.xml SDO-DataObject-getTypeName.xml
SDO-DataObject-getTypeNamespaceURI.xml SDO-Exception-getCause.xml SDO-Model-ReflectionDataObject-export.xml
SDO-Model-ReflectionDataObject-getContainmentProperty.xml SDO-Model-Type-isAbstractType.xml SDO-Model-Type-isInstance.xml SDO-Sequence-getProperty.xml
SDO-Sequence-getPropertyIndex.xml SDO-Sequence-getPropertyName.xml SDO-Sequence-insert.xml

cem Fri Feb 24 18:36:41 2006 UTC Added files: /phpdoc/en/reference/sdo/functions SDO-Sequence-getProperty.xml SDO-DataObject-getTypeNamespaceURI.xml SDO-DataObject-getTypeName.xml SDO-Model-Type-isAbstractType.xml SDO-Model-ReflectionDataObject-export.xml SDO-Exception-getCause.xml Removed files: /phpdoc/en/reference/sdo/functions SDO-Sequence-getPropertyIndex.xml SDO-DataObject-getContainmentPropertyName.xml SDO-Sequence-getPropertyName.xml SDO-DataObject-getType.xml Modified files: /phpdoc/en/reference/sdo/functions SDO-Model-ReflectionDataObject-getContainmentProperty.xml SDO-Sequence-insert.xml SDO-DAS-ChangeSummary-getOldValues.xml SDO-Model-Type-isInstance.xml SDO-DAS-ChangeSummary-getOldContainer.xml SDO-DAS-DataFactory-addType.xml SDO-DataFactory-create.xml SDO-DataObject-createDataObject.xml SDO-DAS-DataFactory-addPropertyToType.xml /phpdoc/en/reference/sdo reference.xml Log: Document the RELEASE_0_9_0 version

http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml:1.3 phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml:1.4 --- phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml:1.3 Fri Dec 16 22:39:37 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-getContainmentProperty.xml Fri Feb 24 18:36:40 2006 @@ -1,11 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Model-ReflectionDataObject-getContainmentProperty"> <refnamediv> <refname>SDO_Model_ReflectionDataObject::getContainmentProperty</refname> <refpurpose> - Get the parent's SDO_Model_Property which defines the containment relationship to the reflected data object + Get the property which defines the containment relationship to the data object </refpurpose> </refnamediv> <refsect1 role="description"> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.6 phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.7 --- phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml:1.6 Fri Dec 16 22:39:37 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-insert.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Sequence-insert"> <refnamediv> @@ -58,7 +58,8 @@ </term> <listitem> <para> - Either a property index or property name, + Either a property index, a property name, or an + <link linkend='sdo.class.sdomodel_property'>SDO_Model_Property</link>, used to identify a property in the sequence's corresponding SDO_DataObject. A value of NULL signifies unstructured text. http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml?r1=1.5&r2=1.6&diff_format=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.5 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.6 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml:1.5 Fri Dec 16 22:39:36 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldValues.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldValues"> <refnamediv> @@ -12,7 +12,7 @@ &reftitle.description; <methodsynopsis> <type>SDO_List</type><methodname>SDO_DAS_ChangeSummary::getOldValues</methodname> - <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> + <methodparam><type>SDO_DataObject</type><parameter>data_object</parameter></methodparam> </methodsynopsis> &warn.experimental.func; @@ -31,7 +31,7 @@ <variablelist> <varlistentry> <term> - <parameter>dataObject</parameter> + <parameter>data_object</parameter> </term> <listitem> <para> @@ -46,7 +46,9 @@ &reftitle.returnvalues; <para> A list of SDO_DAS_Settings describing the old values for the - changed properties of the SDO_DataObject + changed properties of the SDO_DataObject. + If the change type is SDO_DAS_ChangeSummary::ADDITION, this + list is empty. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Model-Type-isInstance.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/sdo/functions/SDO-Model-Type-isInstance.xml diff -u phpdoc/en/reference/sdo/functions/SDO-Model-Type-isInstance.xml:1.2 phpdoc/en/reference/sdo/functions/SDO-Model-Type-isInstance.xml:1.3 --- phpdoc/en/reference/sdo/functions/SDO-Model-Type-isInstance.xml:1.2 Fri Dec 16 22:39:37 2005 +++ phpdoc/en/reference/sdo/functions/SDO-Model-Type-isInstance.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.3. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Model-Type-isInstance"> <refnamediv> @@ -20,7 +20,7 @@ <para> Test for an SDO_DataObject being an instance of this SDO_Model_Type. Returns &true; if the SDO_DataObject provided is an instance of this - SDO_Model_Type, otherwise returns &false;. + SDO_Model_Type, or a derived type, otherwise returns &false;. </para> </refsect1> @@ -43,7 +43,7 @@ &reftitle.returnvalues; <para> Returns &true; if the SDO_DataObject provided is an instance of this - SDO_Model_Type, otherwise returns &false;. + SDO_Model_Type, or a derived type, otherwise returns &false;. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml?r1=1.5&r2=1.6&diff_format=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.5 phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.6 --- phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml:1.5 Fri Dec 16 22:39:36 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-ChangeSummary-getOldContainer.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-ChangeSummary-getOldContainer"> <refnamediv> @@ -12,7 +12,7 @@ &reftitle.description; <methodsynopsis> <type>SDO_DataObject</type><methodname>SDO_DAS_ChangeSummary::getOldContainer</methodname> - <methodparam><type>SDO_DataObject</type><parameter>dataObject</parameter></methodparam> + <methodparam><type>SDO_DataObject</type><parameter>data_object</parameter></methodparam> </methodsynopsis> &warn.experimental.func; @@ -29,7 +29,7 @@ <variablelist> <varlistentry> <term> - <parameter>dataObject</parameter> + <parameter>data_object</parameter> </term> <listitem> <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml?r1=1.6&r2=1.7&diff_format=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.6 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.7 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml:1.6 Fri Dec 16 22:39:36 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addType.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataFactory-addType"> <refnamediv> @@ -12,8 +12,9 @@ &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> + <methodparam><type>string</type><parameter>type_namespace_uri</parameter></methodparam> + <methodparam><type>string</type><parameter>type_name</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> &warn.experimental.func; @@ -32,7 +33,7 @@ <variablelist> <varlistentry> <term> - <parameter>namespaceURI</parameter> + <parameter>type_namespace_uri</parameter> </term> <listitem> <para> @@ -42,7 +43,7 @@ </varlistentry> <varlistentry> <term> - <parameter>typeName</parameter> + <parameter>type_name</parameter> </term> <listitem> <para> @@ -50,13 +51,62 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term> + <parameter>options</parameter> + </term> + <listitem><para> This array holds one or more key=&gt;value pairs to set attribute + values for the type. The optional keywords are:</para> + <variablelist> + <varlistentry> + <term><parameter>open</parameter></term> + <listitem> + <para>A flag to say whether the type is open. + An SDO_DataObject whose type is open can have properties added to + them which are not described by the type. This capability is used to + support working with XML documents whose schema support open content + such as that described by an &lt;xsd:any&gt; element. + The default value is 'false'. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>sequenced</parameter> + </term> + <listitem> + <para> A flag to say whether the type is sequenced. + Sequenced types can have the ordering across properties preserved + and can contain unstructured text. + The default value is 'false'. + For more information on sequenced types see the section on + <link linkend="sdo.sample.sequence">Working with Sequenced Data + Objects</link>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <parameter>basetype</parameter> + </term> + <listitem> + <para> If specified, an array of namespace URI and type name strings for the + type from which this type is derived. + An example of the use of base types is when a type derived in an XML + schema inherits from another type by using &lt;extension base="..."&gt;. + </para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - No values returned. + None. </para> </refsect1> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.5 phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.6 --- phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml:1.5 Fri Dec 16 22:39:36 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataFactory-create.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataFactory-create"> <refnamediv> @@ -12,8 +12,8 @@ &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> + <methodparam><type>string</type><parameter>type_namespace_uri</parameter></methodparam> + <methodparam><type>string</type><parameter>type_name</parameter></methodparam> </methodsynopsis> &warn.experimental.func; @@ -30,7 +30,7 @@ <variablelist> <varlistentry> <term> - <parameter>namespaceURI</parameter> + <parameter>type_namespace_uri</parameter> </term> <listitem> <para> @@ -40,7 +40,7 @@ </varlistentry> <varlistentry> <term> - <parameter>typeName</parameter> + <parameter>type_name</parameter> </term> <listitem> <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml diff -u phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.6 phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.7 --- phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml:1.6 Fri Dec 16 22:39:36 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-createDataObject.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-createDataObject"> <refnamediv> @@ -38,7 +38,8 @@ <para> Identifies the property for the data object type to be created. Can be either a property name (string), - or property index (int). + a property index (int), or an + <link linkend='sdo.class.sdomodel-property'>SDO_Model_Property</link>. </para> </listitem> </varlistentry> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml?r1=1.8&r2=1.9&diff_format=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.8 phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.9 --- phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.8 Fri Dec 16 22:39:36 2005 +++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml Fri Feb 24 18:36:40 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DAS-DataFactory-addPropertyToType"> <refnamediv> @@ -12,11 +12,11 @@ &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><type>string</type><parameter>parent_type_namespace_uri</parameter></methodparam> + <methodparam><type>string</type><parameter>parent_type_name</parameter></methodparam> + <methodparam><type>string</type><parameter>property_name</parameter></methodparam> + <methodparam><type>string</type><parameter>type_namespace_uri</parameter></methodparam> + <methodparam><type>string</type><parameter>type_name</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> @@ -36,7 +36,7 @@ <variablelist> <varlistentry> <term> - <parameter>parentNamespaceURI</parameter> + <parameter>parent_type_namespace_uri</parameter> </term> <listitem> <para> @@ -46,7 +46,7 @@ </varlistentry> <varlistentry> <term> - <parameter>parentTypeName</parameter> + <parameter>parent_type_name</parameter> </term> <listitem> <para> @@ -56,7 +56,7 @@ </varlistentry> <varlistentry> <term> - <parameter>propertyName</parameter> + <parameter>property_name</parameter> </term> <listitem> <para> @@ -66,7 +66,7 @@ </varlistentry> <varlistentry> <term> - <parameter>propertyNamespaceURI</parameter> + <parameter>type_namespace_uri</parameter> </term> <listitem> <para> @@ -76,7 +76,7 @@ </varlistentry> <varlistentry> <term> - <parameter>propertyTypeName</parameter> + <parameter>type_name</parameter> </term> <listitem> <para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/reference.xml?r1=1.20&r2=1.21&diff_format=u Index: phpdoc/en/reference/sdo/reference.xml diff -u phpdoc/en/reference/sdo/reference.xml:1.20 phpdoc/en/reference/sdo/reference.xml:1.21 --- phpdoc/en/reference/sdo/reference.xml:1.20 Fri Jan 13 14:42:06 2006 +++ phpdoc/en/reference/sdo/reference.xml Fri Feb 24 18:36:41 2006 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.20 $ --> +<!-- $Revision: 1.21 $ --> <!-- Purpose: database.abstract --> <!-- Membership: pecl --> <!-- State: experimental --> @@ -1171,6 +1171,18 @@ <link linkend='function.SDO-DataObject-getContainer'>getContainer</link> - get the container (also known as 'parent') of this data object </para> + </listitem> + <listitem> + <para> + <link linkend='function.SDO-DataObject-getTypeName'>getTypeName</link> + - get the name of the type for this data object + </para> + </listitem> + <listitem> + <para> + <link linkend='function.SDO-DataObject-getTypeNamespaceURI'>getTypeNamespaceURI</link> + - get the namespace URI of the type for this data object + </para> </listitem> </itemizedlist> </section> @@ -1194,14 +1206,8 @@ <itemizedlist> <listitem> <para> - <link linkend='function.SDO-Sequence-getPropertyIndex'>getPropertyIndex</link> - - get the property index for a given sequence index - </para> - </listitem> - <listitem> - <para> - <link linkend='function.SDO-Sequence-getPropertyName'>getPropertyName</link> - - get the property name for a given sequence index + <link linkend='function.SDO-Sequence-getProperty'>getProperty</link> + - get the property for a given sequence index </para> </listitem> <listitem> @@ -1268,6 +1274,66 @@ </itemizedlist> </section> </section> + + <section id='sdo.class.sdo-exception'> + <title> + <classname>SDO_Exception</classname> + </title> + <para> + An SDO_Exception is thrown when the caller's request cannot be completed. + The subclasses of SDO_Exception are: + <itemizedlist> + <listitem> + <para>SDO_PropertyNotSetException - + the property specified exists but has not been set or does not have a + default value + </para> + </listitem> + <listitem> + <para>SDO_PropertyNotFoundException - + the property specified is not part of the data object's type + </para> + </listitem> + <listitem> + <para>SDO_TypeNotFoundException - + the specified namespace URI or type name is unknown + </para> + </listitem> + <listitem> + <para>SDO_InvalidConversionException - + conversion between the types of the assignment is not possible + </para> + </listitem> + <listitem> + <para>SDO_IndexOutOfBoundsException - + the numeric index into a data object, sequence or list is not in the + valid range + </para> + </listitem> + <listitem> + <para>SDO_UnsupportedOperationException - + the request cannot be completed because it is not allowed, + for example an attempt to set a read-only property. + </para> + </listitem> + </itemizedlist> + </para> + <section id='sdo.class.SDO_Exception.methods'> &reftitle.methods; + <para>One method is added to those inherited from the built in + <link linkend='language.exceptions.extending'>Exception</link> class: + </para> + <itemizedlist> + <listitem> + <para> + <link linkend='function.SDO-Exception-getCause'>getCause</link> + - get the cause of this SDO_Exception + </para> + </listitem> + + </itemizedlist> + </section> + </section> + </section> @@ -1284,13 +1350,24 @@ to obtain its model type and property information. It is designed to follow the reflection pattern introduced in PHP 5. </para> + <section id='sdo.class.SDO_Model_ReflectionDataObject.constructor'> + &reftitle.constructor; + <itemizedlist> + <listitem> + <para> + <link linkend='function.SDO-Model-ReflectionDataObject-construct'>__construct</link> + - construct a new SDO_Model_ReflectionDataObject. + </para> + </listitem> + </itemizedlist> + </section> <section id='sdo.class.SDO_Model_ReflectionDataObject.methods'> &reftitle.methods; <itemizedlist> <listitem> <para> - <link linkend='function.SDO-Model-ReflectionDataObject-construct'>__construct</link> - - construct a new SDO_Model_ReflectionDataObject. + <link linkend='function.SDO-Model-ReflectionDataObject-export'>export</link> + - get a string describing the data object. </para> </listitem> <listitem> @@ -1310,8 +1387,7 @@ <para> <link linkend= 'function.SDO-Model-ReflectionDataObject-getContainmentProperty'>getContainmentProperty</link> - - get the parent's SDO_Model_Property which defines the - containment relationship to the reflected data object. + - get the property which defines the containment relationship to the data object. </para> </listitem> </itemizedlist> @@ -1380,6 +1456,12 @@ </listitem> <listitem> <para> + <link linkend='function.SDO-Model-Type-isAbstractType'>isAbstractType</link> + - test to see if this is an abstract type. + </para> + </listitem> + <listitem> + <para> <link linkend='function.SDO-Model-Type-getBaseType'>getBaseType</link> - get the base type of this type (if one exists). </para> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Sequence-getProperty.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/sdo/functions/SDO-Sequence-getProperty.xml +++ phpdoc/en/reference/sdo/functions/SDO-Sequence-getProperty.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Sequence-getProperty"> <refnamediv> <refname>SDO_Sequence::getProperty</refname> <refpurpose> Return the property for the specified sequence index. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>SDO_Model_Property</type><methodname>SDO_Sequence::getProperty</methodname> <methodparam><type>integer</type><parameter>sequence_index</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Return the property for the specified sequence index. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>sequence_index</parameter></term> <listitem> <para> The position of the element in the sequence. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> An SDO_Model_Property. A return value of NULL means the sequence element does not belong to a property and must therefore be unstructured text. </para> </refsect1> <refsect1 role="exceptions"> &reftitle.exceptions; <para> <variablelist> <varlistentry> <term> <parameter>SDO_IndexOutOfBoundsException</parameter> </term> <listitem> <para> Thrown if the sequence index is less than zero or greater than the size of the sequence. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <!-- 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> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_Sequence::getProperty</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> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DataObject-getTypeNamespaceURI.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getTypeNamespaceURI.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getTypeNamespaceURI.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getTypeNamespaceURI"> <refnamediv> <refname>SDO_DataObject::getTypeNamespaceURI</refname> <refpurpose> Return the namespace URI of the type for a data object. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>SDO_DataObject::getTypeNamespaceURI</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Return the namespace URI of the type for a data object. A convenience method corresponding to SDO_Model_ReflectionDataObject::getType().getNamespaceURI(). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The namespace URI of the type for the data object. </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> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_DataObject::getTypeNamespaceURI</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> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-DataObject-getTypeName.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/sdo/functions/SDO-DataObject-getTypeName.xml +++ phpdoc/en/reference/sdo/functions/SDO-DataObject-getTypeName.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-DataObject-getTypeName"> <refnamediv> <refname>SDO_DataObject::getTypeName</refname> <refpurpose> Return the name of the type for a data object. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>string</type><methodname>SDO_DataObject::getTypeName</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Return the name of the type for a data object. A convenience method corresponding to SDO_Model_ReflectionDataObject::getType().getName(). </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> The name of the type for the data object. </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> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_DataObject::getTypeName</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> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Model-Type-isAbstractType.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/sdo/functions/SDO-Model-Type-isAbstractType.xml +++ phpdoc/en/reference/sdo/functions/SDO-Model-Type-isAbstractType.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Model-Type-isAbstractType"> <refnamediv> <refname>SDO_Model_Type::isAbstractType</refname> <refpurpose> Test to see if this SDO_Model_Type is an abstract data type </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>boolean</type><methodname>SDO_Model_Type::isAbstractType</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Test to see if this SDO_Model_Type is an abstract data type. Returns &true; if this type is abstract, that is, no SDO_DataObject of this type can be instantiated, though other types may inherit from it. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns &true; if this type is an abstract data type, otherwise returns &false;. </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> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_Model_Type::isAbstractType</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> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-export.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-export.xml +++ phpdoc/en/reference/sdo/functions/SDO-Model-ReflectionDataObject-export.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Model-ReflectionDataObject-export"> <refnamediv> <refname>SDO_Model_ReflectionDataObject::export</refname> <refpurpose> Get a string describing the SDO_DataObject. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>SDO_Model_ReflectionDataObject::export</methodname> <methodparam><type>SDO_Model_ReflectionDataObject</type><parameter>rdo</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>return</parameter></methodparam> </methodsynopsis> &warn.experimental.func; <para> Get a string describing the SDO_DataObject. The default behaviour is to print the output, but if &true; is specified for return, it is returned as a string. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> <variablelist> <varlistentry> <term><parameter>rdo</parameter></term> <listitem> <para> An SDO_Model_ReflectionDataObject. </para> </listitem> </varlistentry> <varlistentry> <term><parameter>return</parameter></term> <listitem> <para> If &true;, return the output as a string, otherwise print it. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the output if TRUE is specified for return, otherwise NULL. </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> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_Model_ReflectionDataObject::export</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> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewcvs.cgi/phpdoc/en/reference/sdo/functions/SDO-Exception-getCause.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/sdo/functions/SDO-Exception-getCause.xml +++ phpdoc/en/reference/sdo/functions/SDO-Exception-getCause.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.SDO-Exception-getCause"> <refnamediv> <refname>SDO_Exception::getCause</refname> <refpurpose> Get the cause of the exception. </refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>SDO_Exception::getCause</methodname> <void/> </methodsynopsis> &warn.experimental.func; <para> Returns the cause of this exception or NULL if the cause is nonexistent or unknown. Typically the cause will be an SDO_CPPException object, which may be used to obtain additional diagnostic information. </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; <para> None. </para> </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> Returns the cause of this exception or NULL if the cause is nonexistent or unknown. </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> <entry>Description of change</entry> </row> </tbody> </tgroup> </informaltable> </para> </refsect1> --> <!-- Use when examples exist <refsect1 role="examples"> &reftitle.examples; <para> <example> <title>A <function>SDO_Exception::getCause</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> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->