cem Fri Oct 7 04:17:42 2005 EDT
Modified files:
/phpdoc/en/reference/sdo/functions
SDO-DAS-DataFactory-addPropertyToType.xml
Log:
Signature change: optional parameters are now an array of key=>value pairs
http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml?r1=1.4&r2=1.5&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.4
phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.5
---
phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml:1.4
Thu Jul 21 05:27:07 2005
+++ phpdoc/en/reference/sdo/functions/SDO-DAS-DataFactory-addPropertyToType.xml
Fri Oct 7 04:17:41 2005
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc.
-->
<refentry id="function.SDO-DAS-DataFactory-addPropertyToType">
<refnamediv>
@@ -34,16 +34,8 @@
<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>
+ <type>array</type>
+ <parameter>options</parameter>
</methodparam>
</methodsynopsis>
@@ -113,41 +105,55 @@
</varlistentry>
<varlistentry>
<term>
- <parameter>many</parameter>
- </term>
- <listitem>
- <para>
- A flag to say whether the property is many-valued.
- A value of 'true' adds the property as a many-valued property
- (default is 'false')
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>readOnly</parameter>
+ <parameter>options</parameter>
</term>
- <listitem>
- <para>
- A flag to say whether the property is read-only.
- A value of 'true' means the property value cannot be modified
- through the SDO application APIs (default is 'false')
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <parameter>containment</parameter>
- </term>
- <listitem>
- <para>
- A flag to say whether the property is contained by the parent.
- A value of 'true' means the property is contained by the parent.
- A value of 'false' results in a non-containment reference
- (default is 'true').
- This flag is only interpreted when adding properties which
- are data object types, otherwise it is ignored.
- </para>
+ <listitem><para> This array holds one or more key=>value pairs to set
attribute
+ values for the property. The optional keywords are:</para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>many</parameter></term>
+ <listitem>
+ <para>A flag to say whether the property is many-valued. A value of
'true' adds the
+ property as a many-valued property (default is 'false').
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>readOnly</parameter>
+ </term>
+ <listitem>
+ <para> A flag to say whether the property is read-only. A value of
'true' means the
+ property value cannot be modified through the SDO application APIs
(default is
+ 'false').
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>containment</parameter>
+ </term>
+ <listitem>
+ <para> A flag to say whether the property is contained by the parent.
A value of
+ 'true' means the property is contained by the parent. A value of
'false' results
+ in a non-containment reference (default is 'true'). This flag is only
+ interpreted when adding properties which are data object types,
otherwise it is
+ ignored.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>default</parameter>
+ </term>
+ <listitem>
+ <para> A default value for the property. Omitting this key means that
the property
+ does not have a default value. A property can only have a default
value if it is a
+ single-valued data type (primitive).
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</listitem>
</varlistentry>
</variablelist>
@@ -199,16 +205,17 @@
<example>
<title>A
<function>SDO_DAS_DataFactory::addPropertyToType</function>
-example</title>
- <para>
-The following adds a 'name' property to a Person type. The person type is
identified by its namespace, 'PersonNS', and type name, 'PersonType'.
-The type of the 'name' property is an SDO data type (primitive) with namespace
'commonj.sdo' and type name 'String'.
+ example</title>
+ <para> The following adds an 'addressline' property to a Person type. The
person type is
+ identified by its namespace, 'PersonNS', and type name, 'PersonType'. The
type of the
+ 'addressline' property is a many-valued SDO data type (primitive) with
namespace
+ 'commonj.sdo' and type name 'String'.
</para>
<programlisting role="php">
<![CDATA[
<?php
$df->addPropertyToType('PersonNS', 'PersonType',
-'name', 'commonj.sdo', 'String');
+ 'addressline', 'commonj.sdo', 'String', array('many'=>true));
?>
]]>
</programlisting>
