mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
Added description of data object reflection support.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@201905 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Graham Charters
parent
e093051b21
commit
5dd579b932
48 changed files with 3193 additions and 152 deletions
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. F
|
||||
ound in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-ChangeSummary-getChangeType">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_ChangeSummary::getChangeType</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-ChangeSummary-getChangedDataObjects">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_ChangeSummary::getChangedDataObjects</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-ChangeSummary-getOldContainer">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_ChangeSummary::getOldContainer</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-ChangeSummary-getOldValues">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_ChangeSummary::getOldValues</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-ChangeSummary-isLogging">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_ChangeSummary::isLogging</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-DataFactory-addPropertyToType">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_DataFactory::addPropertyToType</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-DataFactory-getDataFactory">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_DataFactory::getDataFactory</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DAS-DataObject-getChangeSummary">
|
||||
<refnamediv>
|
||||
<refname>SDO_DAS_DataObject::getChangeSummary</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DataFactory-create">
|
||||
<refnamediv>
|
||||
<refname>SDO_DataFactory::create</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DataObject-clear">
|
||||
<refnamediv>
|
||||
<refname>SDO_DataObject::clear</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DataObject-createDataObject">
|
||||
<refnamediv>
|
||||
<refname>SDO_DataObject::createDataObject</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-DataObject-getSequence">
|
||||
<refnamediv>
|
||||
<refname>SDO_DataObject::getSequence</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
139
reference/sdo/functions/SDO-Model-Property-getContainingType.xml
Normal file
139
reference/sdo/functions/SDO-Model-Property-getContainingType.xml
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Property-getContainingType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Property::getContainingType</refname>
|
||||
<refpurpose>Get the SDO_Model_Type which contains this property.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_Type</type>
|
||||
<methodname>SDO_Model_Property::getContainingType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Returns the SDO_Model_Type which contains this property.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the SDO_Model_Type which contains this 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>
|
||||
<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_Property::getContainingType</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
|
||||
-->
|
||||
140
reference/sdo/functions/SDO-Model-Property-getDefault.xml
Normal file
140
reference/sdo/functions/SDO-Model-Property-getDefault.xml
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Property-getDefault">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Property::getDefault</refname>
|
||||
<refpurpose>Get the default value for the property</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>mixed</type>
|
||||
<methodname>SDO_Model_Property::getDefault</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Returns the default value for the property.
|
||||
Only primitive data type properties can have default values.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the default value for the 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>
|
||||
<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_Property::getDefault</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
|
||||
-->
|
||||
139
reference/sdo/functions/SDO-Model-Property-getName.xml
Normal file
139
reference/sdo/functions/SDO-Model-Property-getName.xml
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Property-getName">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Property::getName</refname>
|
||||
<refpurpose>Get the name of the SDO_Model_Property.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type>
|
||||
<methodname>SDO_Model_Property::getName</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Returns the name of the SDO_Model_Property.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the name of the SDO_Model_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>
|
||||
<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_Property::getName</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
|
||||
-->
|
||||
142
reference/sdo/functions/SDO-Model-Property-getType.xml
Normal file
142
reference/sdo/functions/SDO-Model-Property-getType.xml
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Property-getType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Property::getType</refname>
|
||||
<refpurpose>Get the SDO_Model_Type of the property.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_Type</type>
|
||||
<methodname>SDO_Model_Property::getType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Get the SDO_Model_Type of the property.
|
||||
The SDO_Model_Type describes the type information for the property, such
|
||||
as its type name, namespace URI, whether it is a primitive data type,
|
||||
and so on.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the SDO_Model_Type describing the property's type information.
|
||||
</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_Property::getType</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
|
||||
-->
|
||||
144
reference/sdo/functions/SDO-Model-Property-isContainment.xml
Normal file
144
reference/sdo/functions/SDO-Model-Property-isContainment.xml
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Property-isContainment">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Property::isContainment</refname>
|
||||
<refpurpose>
|
||||
Test to see if the property defines a containment relationship.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>boolean</type>
|
||||
<methodname>SDO_Model_Property::isContainment</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Test to see if the property corresponds to a containment relationship.
|
||||
Returns &true; if the property defines a containment relationship,
|
||||
or &false; if it is reference.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if the property defines a containment relationship,
|
||||
or &false; if it is reference.
|
||||
</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_Property::isContainment</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
|
||||
-->
|
||||
142
reference/sdo/functions/SDO-Model-Property-isMany.xml
Normal file
142
reference/sdo/functions/SDO-Model-Property-isMany.xml
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Property-isMany">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Property::isMany</refname>
|
||||
<refpurpose>Test to see if the property is many-valued.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>boolean</type>
|
||||
<methodname>SDO_Model_Property::isMany</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Test to see if the property is many-valued.
|
||||
Returns &true; if this is a many-valued property, otherwise returns
|
||||
&false;.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if this is a many-valued property, 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_Property::isMany</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
|
||||
-->
|
||||
|
|
@ -0,0 +1,156 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-ReflectionDataObject-construct">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_ReflectionDataObject::__construct</refname>
|
||||
<refpurpose>Construct an SDO_Model_ReflectionDataObject.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_ReflectionDataObject</type>
|
||||
<methodname>SDO_Model_ReflectionDataObject::__construct</methodname>
|
||||
<methodparam>
|
||||
<type>SDO_DataObject</type><parameter>data_object</parameter>
|
||||
</methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Construct an SDO_Model_ReflectionDataObject to reflect on an
|
||||
SDO_DataObject. Reflecting on an SDO_DataObject gives access to
|
||||
information about its model. The model contains information such as
|
||||
the data object's type, and whether that type is sequenced
|
||||
(preserves ordering across properties) or open (each instance can have
|
||||
its model extended). The model also holds information about the data
|
||||
object's properties, any default values they may have, and so on.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>data_object</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The SDO_DataObject being reflected upon.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</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>
|
||||
<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::__construct</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
|
||||
-->
|
||||
|
|
@ -0,0 +1,146 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- 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.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_Property</type>
|
||||
<methodname>
|
||||
SDO_Model_ReflectionDataObject::getContainmentProperty
|
||||
</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Get the SDO_Model_Property that contains the SDO_DataObject.
|
||||
This method is used to navigate up to the parent's property which
|
||||
contains the data object which has been reflected upon.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the container's SDO_Model_Property which references the
|
||||
SDO_DataObject,
or &null; if it is a root SDO_DataObject.
|
||||
</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::getContainmentProperty</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
|
||||
-->
|
||||
|
|
@ -0,0 +1,144 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-ReflectionDataObject-getInstanceProperties">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_ReflectionDataObject::getInstanceProperties</refname>
|
||||
<refpurpose>Get the instance properties of the SDO_DataObject.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type>
|
||||
<methodname>
|
||||
SDO_Model_ReflectionDataObject::getInstanceProperties
|
||||
</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Get the instance properties for the SDO_DataObject. The instance
|
||||
properties consist of all the properties defined on the data object's
|
||||
type, plus any instance properties from open content (if the data object
|
||||
is an open type).
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
An array of SDO_Model_Property objects.
|
||||
</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::getInstanceProperties</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
|
||||
-->
|
||||
|
|
@ -0,0 +1,141 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-ReflectionDataObject-getType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_ReflectionDataObject::getType</refname>
|
||||
<refpurpose>Get the SDO_Model_Type for the SDO_DataObject.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_Type</type>
|
||||
<methodname>SDO_Model_ReflectionDataObject::getType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Returns the SDO_Model_Type for the SDO_DataObject. The SDO_Model_Type
|
||||
holds all the information about the data object's type, such as namespace
|
||||
URI, type name, whether it is a primitive data type, and so on.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the SDO_Model_Type for the SDO_DataObject.
|
||||
</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::getType</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
|
||||
-->
|
||||
144
reference/sdo/functions/SDO-Model-Type-getBaseType.xml
Normal file
144
reference/sdo/functions/SDO-Model-Type-getBaseType.xml
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-getBaseType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::getBaseType</refname>
|
||||
<refpurpose>Get the base type for this type.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_Type</type>
|
||||
<methodname>SDO_Model_Type::getBaseType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Get the base type for this type.
|
||||
Returns the SDO_Model_Type for the base type if this type inherits from
|
||||
another, otherwise returns &null;. An example of when base types occur
|
||||
is when a type defined in XML schema inherits from another type by using
|
||||
<![CDATA[ <extension base="..."> ]]>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the SDO_Model_Type for the base type if this type inherits from
|
||||
another, otherwise returns &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_Type::getBaseType</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
|
||||
-->
|
||||
139
reference/sdo/functions/SDO-Model-Type-getName.xml
Normal file
139
reference/sdo/functions/SDO-Model-Type-getName.xml
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-getName">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::getName</refname>
|
||||
<refpurpose>Get the name of the type.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>SDO_Model_Type::getName</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Returns the name of the type. The combination of type name and namespace
|
||||
URI is used to uniquely identify the type.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the name of the type.
|
||||
</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::getName</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
|
||||
-->
|
||||
140
reference/sdo/functions/SDO-Model-Type-getNamespaceURI.xml
Normal file
140
reference/sdo/functions/SDO-Model-Type-getNamespaceURI.xml
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-getNamespaceURI">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::getNamespaceURI</refname>
|
||||
<refpurpose>Get the namespace URI of the type.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>string</type>
|
||||
<methodname>SDO_Model_Type::getNamespaceURI</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Returns the namespace URI of the type. The combination of namespace URI
|
||||
and type name is used to uniquely identify the type.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the namespace URI of the type.
|
||||
</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::getNamespaceURI</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
|
||||
-->
|
||||
142
reference/sdo/functions/SDO-Model-Type-getProperties.xml
Normal file
142
reference/sdo/functions/SDO-Model-Type-getProperties.xml
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-getProperties">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::getProperties</refname>
|
||||
<refpurpose>
|
||||
Get the SDO_Model_Property objects defined for the type.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>array</type><methodname>SDO_Model_Type::getProperties</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Get an array of SDO_Model_Property objects describing the properties
|
||||
defined for the SDO_Model_Type. Each SDO_Model_Property holds
|
||||
information such as the property name, default value, and so on.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns an array of SDO_Model_Property objects.
|
||||
</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::getProperties</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
|
||||
-->
|
||||
151
reference/sdo/functions/SDO-Model-Type-getProperty.xml
Normal file
151
reference/sdo/functions/SDO-Model-Type-getProperty.xml
Normal file
|
|
@ -0,0 +1,151 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-getProperty">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::getProperty</refname>
|
||||
<refpurpose>Get an SDO_Model_Property of the type.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>SDO_Model_Property</type>
|
||||
<methodname>SDO_Model_Type::getProperty</methodname>
|
||||
<methodparam>
|
||||
<type>mixed</type><parameter>identifier</parameter>
|
||||
</methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Get an SDO_Model_Property of the type, identified by its property index
|
||||
or property name.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>identifier</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The property index or property name.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns the SDO_Model_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>
|
||||
<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::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
|
||||
-->
|
||||
143
reference/sdo/functions/SDO-Model-Type-isDataType.xml
Normal file
143
reference/sdo/functions/SDO-Model-Type-isDataType.xml
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-isDataType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::isDataType</refname>
|
||||
<refpurpose>
|
||||
Test to see if this SDO_Model_Type is a primitive data type.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>boolean</type><methodname>SDO_Model_Type::isDataType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Test to see if this SDO_Model_Type is a primitive data type.
|
||||
Returns &true; if this type is a primitive data type, otherwise returns
|
||||
&false;.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if this type is a primitive 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::isDataType</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
|
||||
-->
|
||||
154
reference/sdo/functions/SDO-Model-Type-isInstance.xml
Normal file
154
reference/sdo/functions/SDO-Model-Type-isInstance.xml
Normal file
|
|
@ -0,0 +1,154 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-isInstance">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::isInstance</refname>
|
||||
<refpurpose>
|
||||
Test for an SDO_DataObject being an instance of this SDO_Model_Type.
|
||||
</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>boolean</type><methodname>SDO_Model_Type::isInstance</methodname>
|
||||
<methodparam>
|
||||
<type>SDO_DataObject</type><parameter>data_object</parameter>
|
||||
</methodparam>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<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;.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>data_object</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The SDO_DataObject to be tested.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if the SDO_DataObject provided is an instance of this
|
||||
SDO_Model_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::isInstance</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
|
||||
-->
|
||||
144
reference/sdo/functions/SDO-Model-Type-isOpenType.xml
Normal file
144
reference/sdo/functions/SDO-Model-Type-isOpenType.xml
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-isOpenType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::isOpenType</refname>
|
||||
<refpurpose>Test to see if this type is an open type.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>boolean</type>
|
||||
<methodname>SDO_Model_Type::isOpenType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Test to see if this type is open.
|
||||
Returns &true; if this type is open, otherwise returns &false;. 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
|
||||
defined by an <![CDATA[ <xsd:any> ]]> element.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if this type is open, 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::isOpenType</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
|
||||
-->
|
||||
145
reference/sdo/functions/SDO-Model-Type-isSequencedType.xml
Normal file
145
reference/sdo/functions/SDO-Model-Type-isSequencedType.xml
Normal file
|
|
@ -0,0 +1,145 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<!-- Generated by xml_proto.php v2.3.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Model-Type-isSequencedType">
|
||||
<refnamediv>
|
||||
<refname>SDO_Model_Type::isSequencedType</refname>
|
||||
<refpurpose>Test to see if this is a sequenced type.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>boolean</type>
|
||||
<methodname>SDO_Model_Type::isSequencedType</methodname>
|
||||
<void/>
|
||||
</methodsynopsis>
|
||||
|
||||
&warn.experimental.func;
|
||||
|
||||
<para>
|
||||
Test to see if this is a sequenced type. Returns &true; if this type is
|
||||
sequence, otherwise returns &false;.
|
||||
Sequenced types can have the ordering across properties preserved and can
|
||||
contain unstructured text. For more information on sequenced types see
|
||||
the section on
|
||||
<link linkend="sdo.sample.sequence">Working with Sequenced Data Objects
|
||||
</link>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
None.
|
||||
</para>
|
||||
</refsect1>
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns &true; if this type is sequence, otherwise return &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::isSequencedType</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
|
||||
-->
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Sequence-getPropertyIndex">
|
||||
<refnamediv>
|
||||
<refname>SDO_Sequence::getPropertyIndex</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Sequence-getPropertyName">
|
||||
<refnamediv>
|
||||
<refname>SDO_Sequence::getPropertyName</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2.
|
||||
Found in /scripts directory of phpdoc. -->
|
||||
<refentry id="function.SDO-Sequence-insert">
|
||||
<refnamediv>
|
||||
<refname>SDO_Sequence::insert</refname>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.4 $ -->
|
||||
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
||||
<!-- $Revision: 1.5 $ -->
|
||||
<!-- 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>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.17 $ -->
|
||||
<!-- $Revision: 1.18 $ -->
|
||||
<!-- Purpose: database.abstract -->
|
||||
<!-- Membership: pecl -->
|
||||
<!-- State: experimental -->
|
||||
|
|
@ -50,12 +50,12 @@
|
|||
<title>The Structure of a Service Data Object</title>
|
||||
<para>
|
||||
A Service Data Object instance is made up of a tree of data objects.
|
||||
The tree is defined by containment references between the data objects.
|
||||
For example, a Company data object might consist of a number of
|
||||
Department data objects and therefore the Company would have
|
||||
a containment reference to the Departments.
|
||||
Deleting a data object which has a containment reference to another
|
||||
data object will delete the referenced data object. For example,
|
||||
The tree is defined by containment relationships between the data
|
||||
objects. For example, a Company data object might consist of a number
|
||||
of Department data objects and therefore the Company would have
|
||||
a containment relationship to the Departments.
|
||||
Deleting a data object which has a containment relationship to another
|
||||
data object will also delete the contained data object. For example,
|
||||
deleting the Company data object will also delete the Departments.
|
||||
</para>
|
||||
<para>
|
||||
|
|
@ -121,10 +121,11 @@
|
|||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The latest DLLs for the SDO core and the XML DAS can be downloaded from
|
||||
<ulink url='&url.pecl.win.ext;php_sdo.dll'>php_sdo
|
||||
The latest DLLs for the SDO core and the XML DAS can be
|
||||
downloaded from
|
||||
<ulink url='&url.pecl.win.ext;php_sdo.dll'>php_sdo
|
||||
</ulink> and
|
||||
<ulink url='&url.pecl.win.ext;php_sdo_das_xml.dll'>php_sdo_das_xml
|
||||
<ulink url='&url.pecl.win.ext;php_sdo_das_xml.dll'>php_sdo_das_xml
|
||||
</ulink> respectively.
|
||||
</para>
|
||||
</listitem>
|
||||
|
|
@ -207,8 +208,8 @@
|
|||
<varname>sdo-0.5.2</varname>, in the command above.
|
||||
</para>
|
||||
<para>
|
||||
This command will build the SDO and XML shared libraries as well as
|
||||
installing the PHP files that make the Relational DAS.
|
||||
This command will build the SDO and XML shared libraries as well
|
||||
as installing the PHP files that make the Relational DAS.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
|
@ -370,11 +371,6 @@ extension=sdo_das_xml.so
|
|||
Read-only properties.
|
||||
</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Model introspection.
|
||||
</para>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
XMLHelper/XSDHelper (the XML DAS provide a lot of this functionality)
|
||||
|
|
@ -416,14 +412,16 @@ extension=sdo_das_xml.so
|
|||
<xsd:element name="company" type="company:CompanyType"/>
|
||||
<xsd:complexType name="CompanyType">
|
||||
<xsd:sequence>
|
||||
<xsd:element name="departments" type="company:DepartmentType" maxOccurs="unbounded"/>
|
||||
<xsd:element name="departments" type="company:DepartmentType"
|
||||
maxOccurs="unbounded"/>
|
||||
</xsd:sequence>
|
||||
<xsd:attribute name="name" type="xsd:string"/>
|
||||
<xsd:attribute name="employeeOfTheMonth" type="xsd:IDREF"
|
||||
sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
||||
<xsd:complexType name="DepartmentType">
|
||||
<xsd:sequence>
|
||||
<xsd:element name="employees" type="company:EmployeeType" maxOccurs="unbounded"/>
|
||||
<xsd:element name="employees" type="company:EmployeeType"
|
||||
maxOccurs="unbounded"/>
|
||||
</xsd:sequence>
|
||||
<xsd:attribute name="name" type="xsd:string"/>
|
||||
<xsd:attribute name="location" type="xsd:string"/>
|
||||
|
|
@ -452,7 +450,8 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
<programlisting role="xml">
|
||||
<![CDATA[
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<company xmlns="companyNS" name="MegaCorp" employeeOfTheMonth="#/departments.0/employees.1">
|
||||
<company xmlns="companyNS" name="MegaCorp"
|
||||
employeeOfTheMonth="#/departments.0/employees.1">
|
||||
<departments name="Advanced Technologies" location="NY" number="123">
|
||||
<employees name="John Jones" SN="E0001"/>
|
||||
<employees name="Jane Doe" SN="E0003"/>
|
||||
|
|
@ -677,7 +676,8 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
<programlisting role="php" id="sdo.examples.xpathquery">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$ad_tech_mgr = $company["departments[name=\"Advanced Technologies\"]/employees[manager=\"true\"]"];
|
||||
$ad_tech_mgr =
|
||||
$company["departments[name=\"Advanced Technologies\"]/employees[manager=\"true\"]"];
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
|
|
@ -717,7 +717,7 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
</para>
|
||||
<para>
|
||||
The following removes the 'employeeOfTheMonth' from the company.
|
||||
If this were a containment reference then the
|
||||
If this were a containment relationship then the
|
||||
employee would be removed from the company
|
||||
(probably not a good idea to sack your best employee each month!),
|
||||
but since this is a non-containment reference,
|
||||
|
|
@ -1026,16 +1026,116 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
|
||||
</section>
|
||||
|
||||
|
||||
<section id="sdo.sample.reflection">
|
||||
<title>Reflecting on Service Data Objects</title>
|
||||
<para>
|
||||
SDOs have a knowledge of the structure they have been created to
|
||||
represent (the model). For example, a Company SDO created using
|
||||
<link linkend="sdo.examples">the Company XML schema</link> above
|
||||
would only be permitted to contain DepartmentType data objects
|
||||
which in turn could only contain EmployeeType data objects.
|
||||
</para>
|
||||
<para>
|
||||
Sometimes it is useful to be able to access this model information at
|
||||
runtime. For example, this could be used to automatically generate
|
||||
a user interface for populating a data object. The model information
|
||||
is accessed using reflection.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<example>
|
||||
<title>Reflecting on a Data Object</title>
|
||||
<para>
|
||||
The following example shows how we can reflect on an empty Employee
|
||||
data object.
|
||||
</para>
|
||||
<programlisting role="php" id="sdo.examples.reflection">
|
||||
<![CDATA[
|
||||
<?php
|
||||
// Create the employee data object (e.g. from an XML Data Access Service)
|
||||
$employee = ...;
|
||||
$reflection = new SDO_Model_ReflectionDataObject($employee);
|
||||
print($reflection);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
|
||||
<screen>
|
||||
<![CDATA[
|
||||
object(SDO_Model_ReflectionDataObject)#4 { - ROOT OBJECT - Type {
|
||||
companyNS:EmployeeType[3] { commonj.sdo:String $name;
|
||||
commonj.sdo:String $SN; commonj.sdo:Boolean $manager; } }
|
||||
]]>
|
||||
</screen>
|
||||
<para>
|
||||
Using print on the SDO_Model_ReflectionDataObject writes out the data
|
||||
object's model. We can see from the output how the type
|
||||
companyNS:EmployeeType has three properties and we can see the names
|
||||
of the properties along with their types. Note, the primitive types
|
||||
are listed as SDO types (e.g. commonj.sdo namespace, String type).
|
||||
It is worth noting that this is the SDO model and when these are
|
||||
surfaced to an application they can be treated as the PHP equivalent
|
||||
types (e.g. string and boolean).
|
||||
</para>
|
||||
</example>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<example>
|
||||
<title>Accessing the type information</title>
|
||||
<para>
|
||||
We can query the type information of a data object using reflection.
|
||||
The following example checks the type corresponds to a data object
|
||||
rather than a primitive and then iterates through the properties of
|
||||
the type, writing out the name of each property ($type and $property
|
||||
are SDO_Model_Type and SDO_Model_Property objects, respectively).
|
||||
</para>
|
||||
<programlisting role="php" id="sdo.examples.reflection.type">
|
||||
<![CDATA[
|
||||
<?php
|
||||
// Create the employee data object (e.g. from an XML Data Access Service)
|
||||
$employee = ...;
|
||||
$reflection = new SDO_Model_ReflectionDataObject($employee);
|
||||
$type = $reflection->getType();
|
||||
if (! $type->isDataType()) {
|
||||
foreach ($type->getProperties() as $property) {
|
||||
print $property->getName() . "\n";
|
||||
}
|
||||
}
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
name
|
||||
SN
|
||||
manager
|
||||
]]>
|
||||
</screen>
|
||||
</example>
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<!-- class definition section -->
|
||||
<section id='sdo.classes'>
|
||||
&reftitle.classes;
|
||||
<para>
|
||||
SDO consists of two sets of interfaces. The first set covers those
|
||||
interfaces for use by SDO client applications. These are identified by
|
||||
the package prefix 'SDO_'. The second set is those for use by Data
|
||||
Access Service implementations and are identified by the package prefix
|
||||
'SDO_DAS_'. The majority of SDO users will not need to use or understand
|
||||
the 'SDO_DAS_' interfaces.
|
||||
SDO consists of three sets of interfaces. The first set covers those
|
||||
interfaces for use by typical SDO applications. These are identified
|
||||
by the package prefix 'SDO_'. The second set is those used to reflect
|
||||
on, and work with, the model of a data object. These are identified
|
||||
by the package prefix 'SDO_Model_'. Finally, the third set are those
|
||||
use by Data Access Service implementations and are identified by the
|
||||
package prefix 'SDO_DAS_'. The majority of SDO users will not need to
|
||||
use or understand the 'SDO_Model_ and 'SDO_DAS_' interfaces.
|
||||
</para>
|
||||
|
||||
<section id='sdo.class.sdo-apis'>
|
||||
|
|
@ -1054,12 +1154,6 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
</para>
|
||||
<section id='sdo.class.SDO_DataObject.methods'> &reftitle.methods;
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-DataObject-getType'>getType</link>
|
||||
- get the type of a data object
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-DataObject-getSequence'>
|
||||
|
|
@ -1088,14 +1182,6 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
- get the container (also known as 'parent') of this data object
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-DataObject-getContainmentPropertyName'>
|
||||
getContainmentPropertyName
|
||||
</link>
|
||||
- get the name by which the parent refers to this data object
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</section>
|
||||
|
|
@ -1198,6 +1284,200 @@ sdoxml:propertyType="company:EmployeeType"/> </xsd:complexType>
|
|||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
<section id='sdo.class.sdo-model-apis'>
|
||||
<title>SDO Reflection Application Programmer Interfaces</title>
|
||||
|
||||
<section id='sdo.class.sdo-reflectiondataobject'>
|
||||
<title>
|
||||
<classname>SDO_Model_ReflectionDataObject</classname>
|
||||
</title>
|
||||
<para>
|
||||
The main interface used to reflect on a data object instance
|
||||
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.methods'>
|
||||
&reftitle.methods;
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-ReflectionDataObject-construct'>
|
||||
__construct
|
||||
</link> - construct a new SDO_Model_ReflectionDataObject.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-ReflectionDataObject-getType'>
|
||||
getType
|
||||
</link> - get the SDO_Model_Type for the data object.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend=
|
||||
'function.SDO-Model-ReflectionDataObject-getInstanceProperties'>
|
||||
getInstanceProperties
|
||||
</link> - get the instance properties of the data object.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<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.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id='sdo.class.sdo-type'>
|
||||
<title>
|
||||
<classname>SDO_Model_Type</classname>
|
||||
</title>
|
||||
<para>
|
||||
The interface through which a data object's type information can be
|
||||
retrieved. This interface can be used to find out the type name and
|
||||
namespace URI of the type, whether the type allow open content, and so
|
||||
on.
|
||||
</para>
|
||||
<section id='sdo.class.SDO_Model_Type.methods'> &reftitle.methods;
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-getName'>
|
||||
getName
|
||||
</link> - get the name of the type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-getNamespaceURI'>
|
||||
getNamespaceURI
|
||||
</link> - get the namespace URI of the type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-isInstance'>
|
||||
isInstance
|
||||
</link> - test for a data object being an instance of the type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-getProperties'>
|
||||
getProperties
|
||||
</link> - get the properties of the type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-getProperty'>
|
||||
getProperty
|
||||
</link> - get a property of the type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-isDataType'>
|
||||
isDataType
|
||||
</link> - test to see if this type is a primitive scalar type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-isSequencedType'>
|
||||
isSequencedType
|
||||
</link> - test to see if this is a sequenced type.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Type-isOpenType'>
|
||||
isOpenType
|
||||
</link> - test to see if this is an open 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>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id='sdo.class.sdo-property'>
|
||||
<title>
|
||||
<classname>SDO_Model_Property</classname>
|
||||
</title>
|
||||
<para>
|
||||
The interface through which a data object's property information can
|
||||
be retrieved. This interface can be used to find out the type of a
|
||||
property, whether a property has a default value, whether the
|
||||
property is contained or reference by its parent, its cardinality,
|
||||
and so on.
|
||||
</para>
|
||||
<section id='sdo.class.SDO_Model_Property.methods'> &reftitle.methods;
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Property-getName'>
|
||||
getName
|
||||
</link> - get the name of the property.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Property-getType'>
|
||||
getType
|
||||
</link> - get the type of the property.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Property-isMany'>
|
||||
isMany
|
||||
</link> - test to see if the property is many-valued..
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Property-isContainment'>
|
||||
isContainment
|
||||
</link> - test to see if the property describes a containment relationship.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Property-getContainingType'>
|
||||
getContainingType
|
||||
</link> - get the type which contains this property.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<link linkend='function.SDO-Model-Property-getDefault'>
|
||||
getDefault
|
||||
</link> - get the default value for a property.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
</section>
|
||||
|
||||
<section id='sdo.class.sdo-das-spis'>
|
||||
<title>
|
||||
SDO Data Access Service Developer Interfaces
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.12 $ -->
|
||||
<!-- $Revision: 1.13 $ -->
|
||||
<!-- Purpose: xml -->
|
||||
<!-- Membership: pecl -->
|
||||
<!-- State: experimental -->
|
||||
|
|
@ -386,20 +386,19 @@ try {
|
|||
try {
|
||||
$xmldas = SDO_DAS_XML::create("letter.xsd");
|
||||
try {
|
||||
$do = $xmldas->createDataObject("http://letterSchema", "FormLetter");
|
||||
$seq = $do->getSequence();
|
||||
$seq->insert("April 09, 2005", NULL, 'date');
|
||||
$seq->insert("Acme Inc. ", NULL, NULL);
|
||||
$seq->insert("United Kingdom. ");
|
||||
$seq->insert("Dear", NULL, NULL);
|
||||
$seq->insert("Tarun", NULL, "firstName");
|
||||
$seq->insert("Nayaraaa", NULL, "lastName");
|
||||
$do->lastName = "Nayar";
|
||||
$seq->insert("Please note that your order number ");
|
||||
$seq->insert(12345);
|
||||
$seq->insert(" has been dispatched today. Thanks for your business with us.");
|
||||
$type = $do->getType();
|
||||
print($xmldas->saveDataObjectToString($do, $type[0], $type[1]));
|
||||
$letter = $xmldas->createDataObject("http://letterSchema", "FormLetter");
|
||||
$letter_seq = $letter->getSequence();
|
||||
$letter_seq->insert("April 09, 2005", NULL, 'date');
|
||||
$letter_seq->insert("Acme Inc. ", NULL, NULL);
|
||||
$letter_seq->insert("United Kingdom. ");
|
||||
$letter_seq->insert("Dear", NULL, NULL);
|
||||
$letter_seq->insert("Tarun", NULL, "firstName");
|
||||
$letter_seq->insert("Nayaraaa", NULL, "lastName");
|
||||
$letter->lastName = "Nayar";
|
||||
$letter_seq->insert("Please note that your order number ");
|
||||
$letter_seq->insert(12345);
|
||||
$letter_seq->insert(" has been dispatched today. Thanks for your business with us.");
|
||||
print($xmldas->saveDataObjectToString($letter, "http://letterSchema", "FormLetter"));
|
||||
} catch (SDO_Exception $e) {
|
||||
print($e);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!-- $Revision: 1.17 $ -->
|
||||
<!-- $Revision: 1.18 $ -->
|
||||
<!-- Purpose: database.abstract -->
|
||||
<!-- Membership: pecl -->
|
||||
<!-- State: experimental -->
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
the mapping between the database entities
|
||||
- tables, columns, primary keys and foreign keys -
|
||||
and the elements of the SDO model
|
||||
- types, properties, containment properties and so on.
|
||||
- types, properties, containment relationships and so on.
|
||||
You specify this information as metadata when you
|
||||
construct the Relational DAS.
|
||||
</para>
|
||||
|
|
@ -76,7 +76,7 @@
|
|||
is a normalised data graph containing all the data from the result set.
|
||||
For a query that returns data obtained from a number of tables,
|
||||
this graph will contain a number of data objects,
|
||||
linked by SDO containment references.
|
||||
linked by SDO containment relationships.
|
||||
There may also be SDO non-containment references within the data.
|
||||
</para>
|
||||
|
||||
|
|
@ -248,10 +248,10 @@ require_once 'SDO/DAS/Relational.php';
|
|||
<para>
|
||||
Only two types of SDO relationship. The metadata described below
|
||||
allows the Relational DAS to model just two types of SDO relationship:
|
||||
multi-valued containment properties and single-valued
|
||||
non-containment properties. In SDO, whether a property is
|
||||
single- or multi-valued, and whether it is containment or
|
||||
non-containment, are independent. The full range of possibilities
|
||||
multi-valued containment relationships and single-valued
|
||||
non-containment references. In SDO, whether a property describes a
|
||||
single- or multi-valued relationship, and whether it is containment
|
||||
or non-containment, are independent. The full range of possibilities
|
||||
that SDO allows cannot all be defined. There may be relationships
|
||||
that it would be useful to model but which the current implementation
|
||||
cannot manage.
|
||||
|
|
@ -619,8 +619,8 @@ create table employee ( \
|
|||
metadata in the third argument to the constructor that defines
|
||||
the SDO containment relationships.
|
||||
A discussion of this is therefore deferred until the section on
|
||||
<link linkend="sdo.das.rel.metadata.crefs">
|
||||
SDO containment references
|
||||
<link linkend="sdo.das.rel.metadata.crels">
|
||||
SDO containment relationships
|
||||
</link>
|
||||
below.
|
||||
</para>
|
||||
|
|
@ -640,8 +640,8 @@ create table employee ( \
|
|||
</para>
|
||||
</section>
|
||||
|
||||
<section id='sdo.das.rel.metadata.crefs'>
|
||||
<title>Specifying the SDO containment references</title>
|
||||
<section id='sdo.das.rel.metadata.crels'>
|
||||
<title>Specifying the SDO containment relationships</title>
|
||||
|
||||
<para>
|
||||
The third argument to the constructor defines how the types in the
|
||||
|
|
@ -655,38 +655,38 @@ create table employee ( \
|
|||
The metadata is an array containing one or more associative arrays,
|
||||
each of which identifies a parent and a child. The example below shows
|
||||
a parent-child relationship from company to department, and another
|
||||
from department to employee. Each of these will become an SDO
|
||||
multi-valued containment property in the SDO model.
|
||||
from department to employee. Each of these will become an SDO property
|
||||
defining a multi-valued containment relationship in the SDO model.
|
||||
|
||||
</para>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
$department_reference = array( 'parent' => 'company', 'child' => 'department');
|
||||
$employee_reference = array( 'parent' => 'department', 'child' => 'employee');
|
||||
$department_containment = array( 'parent' => 'company', 'child' => 'department');
|
||||
$employee_containment = array( 'parent' => 'department', 'child' => 'employee');
|
||||
|
||||
$SDO_reference_metadata = array($department_reference, $employee_reference);
|
||||
$SDO_containment_metadata = array($department_containment, $employee_containment);
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
|
||||
<para>
|
||||
Foreign keys in the database metadata are interpreted as either
|
||||
multi-valued containment properties or single-valued non-containment
|
||||
properties, depending on whether they have a corresponding SDO
|
||||
containment reference specified in the metadata. In the example here,
|
||||
the foreign keys from department to company (the
|
||||
Foreign keys in the database metadata are interpreted as properties
|
||||
with either multi-valued containment relationships or single-valued
|
||||
non-containment references, depending on whether they have a
|
||||
corresponding SDO containment relationship specified in the metadata.
|
||||
In the example here, the foreign keys from department to company (the
|
||||
<varname>co_id</varname>
|
||||
column in the department table)
|
||||
and from employee to department (the
|
||||
<varname>dept_id</varname>
|
||||
column in the employee table) are interpreted as supporting the
|
||||
SDO containment references.
|
||||
Each containment reference mentioned in the SDO containment references
|
||||
SDO containment relationships.
|
||||
Each containment relationship mentioned in the SDO containment relationships
|
||||
metadata must have a corresponding foreign key present in the
|
||||
database and defined in the database metadata. The values of the
|
||||
foreign key columns for containment references do not appear in the
|
||||
data objects, instead they are represented by the containment reference
|
||||
foreign key columns for containment relationships do not appear in the
|
||||
data objects, instead each is represented by a containment relationship
|
||||
from the parent to the child. So the
|
||||
<varname>co_id</varname>
|
||||
column in the department row in the database, for example, does not
|
||||
|
|
@ -705,14 +705,14 @@ $SDO_reference_metadata = array($department_reference, $employee_reference);
|
|||
<varname>employee_of_the_month</varname>
|
||||
,
|
||||
is handled differently.
|
||||
This is not mentioned in the SDO containment references metadata.
|
||||
This is not mentioned in the SDO containment relationships metadata.
|
||||
As a consequence this is interpreted in the second way: it becomes
|
||||
a single-valued non-containment reference on the company object, to
|
||||
which can be assigned references to SDO data objects of the employee
|
||||
type. It does appear as a property on the company type. The way to
|
||||
assign a value to it in the SDO data graph is to have a graph that
|
||||
contains an employee object through the containment references, and to
|
||||
assign the object to it. This is illustrated in the later examples
|
||||
contains an employee object through the containment relationships, and
|
||||
to assign the object to it. This is illustrated in the later examples
|
||||
below.
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -781,7 +781,7 @@ require_once 'company_metadata.inc.php';
|
|||
/**************************************************************
|
||||
* Construct the DAS with the metadata
|
||||
***************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
/**************************************************************
|
||||
* Obtain a root object and create a company object underneath.
|
||||
|
|
@ -834,7 +834,7 @@ require_once 'company_metadata.inc.php';
|
|||
/**************************************************************
|
||||
* Construct the DAS with the metadata
|
||||
***************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
/**************************************************************
|
||||
* Get a database connection
|
||||
|
|
@ -893,7 +893,7 @@ require_once 'company_metadata.inc.php';
|
|||
/**************************************************************
|
||||
* Construct the DAS with the metadata
|
||||
***************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
/**************************************************************
|
||||
* Get a database connection
|
||||
|
|
@ -934,7 +934,8 @@ $das->applyChanges($dbh,$root);
|
|||
|
||||
<para>
|
||||
In this example they are all deleted in one go by unsetting the
|
||||
containing reference. It is also possible to delete them individually.
|
||||
containing property (the property defining the containment
|
||||
relationship). It is also possible to delete them individually.
|
||||
</para>
|
||||
<programlisting role="php" id="sdo.das.rel.examples.1c-RD">
|
||||
<![CDATA[
|
||||
|
|
@ -945,7 +946,7 @@ require_once 'company_metadata.inc.php';
|
|||
/**************************************************************
|
||||
* Construct the DAS with the metadata
|
||||
***************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
/**************************************************************
|
||||
* Get a database connection
|
||||
|
|
@ -1046,7 +1047,7 @@ $rows_affected = $pdo_stmt->execute();
|
|||
* Create a company with name Acme and one department, the Shoe department
|
||||
***************************************************************/
|
||||
$dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
$root = $das -> createRootDataObject();
|
||||
|
||||
|
|
@ -1121,7 +1122,7 @@ require_once 'company_metadata.inc.php';
|
|||
* Retrieve the company and Shoe department, then delete Shoe and add IT
|
||||
***************************************************************/
|
||||
$dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
$root = $das->executeQuery($dbh,
|
||||
'select c.id, c.name, d.id, d.name from company c, department d where d.co_id = c.id',
|
||||
|
|
@ -1154,8 +1155,8 @@ $das -> applyChanges($dbh, $root);
|
|||
<para>
|
||||
Note the way that the company object is actually deleted using the
|
||||
PHP unset call. The unset has to be performed on the containing
|
||||
reference which in this case is
|
||||
the company reference on the special
|
||||
property which in this case is
|
||||
the company property on the special
|
||||
root object. You must use:
|
||||
<programlisting role="php" id="sdo.das.rel.examples.1cd-CRUD.good-delete">
|
||||
<![CDATA[
|
||||
|
|
@ -1188,7 +1189,7 @@ require_once 'company_metadata.inc.php';
|
|||
* Retrieve the company and IT department, then delete the whole company
|
||||
***************************************************************/
|
||||
$dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
|
||||
$root = $das->executeQuery($dbh,
|
||||
'select c.id, c.name, d.id, d.name from company c, department d where d.co_id = c.id',
|
||||
|
|
@ -1246,7 +1247,7 @@ $das -> applyChanges($dbh, $root);
|
|||
property.
|
||||
The closure rule for SDO data graphs requires that any object pointed
|
||||
at by a non-containment reference must also be reachable by
|
||||
containment references.
|
||||
containment relationships.
|
||||
</para>
|
||||
<para>
|
||||
When it comes to inserting the graph into the database, the procedure
|
||||
|
|
@ -1255,7 +1256,7 @@ $das -> applyChanges($dbh, $root);
|
|||
<varname>employee_of_the_month</varname>
|
||||
introduces an extra complexity.
|
||||
The Relational DAS needs to insert the objects working down the tree
|
||||
formed by containment references, so company, then department, then
|
||||
formed by containment relationships, so company, then department, then
|
||||
employee. This is necessary so that it always has the auto-generated
|
||||
primary key of a parent on hand to include in a child row. But when
|
||||
the company row is inserted the employee who is employee of the month
|
||||
|
|
@ -1288,7 +1289,7 @@ $rows_affected = $pdo_stmt->execute();
|
|||
* There is one employee, Sue.
|
||||
* The employee of the month is Sue.
|
||||
*************************************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
$dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD);
|
||||
|
||||
$root = $das -> createRootDataObject();
|
||||
|
|
@ -1337,7 +1338,7 @@ require_once 'company_metadata.inc.php';
|
|||
* Add a second department and a new employee.
|
||||
* Change the employee of the month.
|
||||
*************************************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
$dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD);
|
||||
|
||||
$root = $das->executeQuery($dbh,
|
||||
|
|
@ -1396,7 +1397,7 @@ require_once 'company_metadata.inc.php';
|
|||
* care is needed to keep closure - you cannot delete the employee who is eotm without
|
||||
* reassigning. For safety here we delete the company all in one go.
|
||||
*************************************************************************************/
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_reference_metadata);
|
||||
$das = new SDO_DAS_Relational ($database_metadata,'company',$SDO_containment_metadata);
|
||||
$dbh = new PDO(PDO_DSN,DATABASE_USER,DATABASE_PASSWORD);
|
||||
|
||||
$root = $das->executeQuery($dbh,
|
||||
|
|
|
|||
Loading…
Reference in a new issue