cvs: phpdoc /en/reference/sdo reference.xml

ansriniv Sun Jul 24 16:50:02 2005 EDT Modified files: /phpdoc/en/reference/sdo reference.xml Log: Changes in installation instructions. http://cvs.php.net/diff.php/phpdoc/en/reference/sdo/reference.xml?r1=1.5&r2=1.6&ty=u Index: phpdoc/en/reference/sdo/reference.xml diff -u phpdoc/en/reference/sdo/reference.xml:1.5 phpdoc/en/reference/sdo/reference.xml:1.6 --- phpdoc/en/reference/sdo/reference.xml:1.5 Sat Jul 23 07:08:35 2005 +++ phpdoc/en/reference/sdo/reference.xml Sun Jul 24 16:49:59 2005 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. --> <reference id="ref.sdo"> <title>SDO Functions</title> @@ -65,40 +65,31 @@ </para> <para> SDO - <link linkend="ref.sdo-das-xml">XML Data Access Service</link>, - which is built as part of this extension, requires libxml2 + <link linkend="ref.sdo-das-xml">XML Data Access Service</link> + , which is built as part of this extension, requires libxml2 (Tested with libxml2 2.6.19) which can be downloaded from - <ulink url='&url.libxml;'>&url.libxml;</ulink>. + <ulink url='&url.libxml;'>&url.libxml;</ulink> + . </para> </section> <section id="sdo.installation"> &reftitle.install; - <warning> <para> - An automated installation process using PEAR will be - supplied soon. - Meanwhile, you can build the extension manually using the - steps below. + SDO extension can be installed using pear. However as it is + still in it's beta you need set <command>pear</command> option 'preferred_state' to beta. + like <command> pear -D preferred_state=beta install sdo </command>. + If you want to install this extension manually on Linux, you + can do so by following steps described below. </para> - </warning> <procedure id='sdo.installation.linux.steps'> <title>Linux intallation steps</title> <para> The following instructions describe how to install the - SDO extension - on Linux. - Note, these steps will also install the + SDO extension on Linux. Note, these steps will also install the <link linkend="ref.sdo-das-xml">XML Data Access Service</link> which is packaged as part of this extension. </para> - <para> - Note, if you built your PHP installation in a different location, using - <filename>--prefix</filename>, - then you will need to adjust the - <command>./configure</command> - steps below accordingly. - </para> <step> <para> Download the SDO extension from the pecl/sdo directory on CVS. @@ -106,79 +97,27 @@ </step> <step> <para> - The SDO and SDO_DAS_XML are implemented as a separate internal 'core' - C++ libraries which must be built before building the main extension. - This can be done by using the following steps: - </para> - <procedure id='sdo.installation.linux.substeps'> - <step> - <para> - Go to the core library directory: - <command>cd sdo/sdolib</command> - </para> - </step> - <step> - <para> - Run - <command>./configure</command> - </para> - </step> - <step> - <para> - The following step is required to ensure - <command>g++</command>, and NOT - <command>gcc</command> - is used to build the the libraries. - </para> - <para> - Open - <filename>libtool</filename> - created by the configure script and - change the line which says - <command>CC="gcc"</command> - to - <command>CC="g++"</command>. - </para> - </step> - <step> - <para> - Run - <command>make; make install</command> - </para> - </step> - </procedure> + Untar the downloaded image in your favourite folder. + </para> </step> <step> <para> Change to the main extension directory: - <command>cd ..</command> + <command>cd sdo-&lt version &gt </command> </para> </step> <step> <para> Run - <command>phpize</command>, - which will set up the environment to compile both SDO and the + <command>phpize</command> + , which will set up the environment to compile both SDO and the XML Data Access Service. </para> </step> <step> <para> Next run - <command>./configure; make; make install</command> - </para> - <para> - Note, the compilation process checks for internal 'core' library - which was installed in the previous build steps. - </para> - <para> - Note, if you used - <filename>--prefix</filename> - for the internal 'core' library build, then you will need to add - <filename>--with-sdolibs=...</filename> - to the - <command>./configure</command> - to point to the destination where the libraries were built. + <command>./configure; make; make install</command>. Please note, you may need to login as root to install the extension. </para> </step> <step> @@ -189,7 +128,7 @@ <command>extension=sdo_das_xml.so</command> to your <filename>php.ini</filename> - file. + file in the same order. </para> </step> </procedure> @@ -469,7 +408,7 @@ <![CDATA[ <?php foreach ($company as $name => $value) { - // ... + ... } ?> ]]> @@ -498,7 +437,7 @@ <![CDATA[ <?php foreach ($company->departments as $department) { - // ... + ... } ?> ]]> @@ -506,7 +445,8 @@ <para> Each iteration will assign the next department in the list to the variable - <command>$department</command>. + <command>$department</command> + . </para> </example> </para> @@ -675,7 +615,7 @@ <programlisting role="php" id="sdo.examples.unsetrefdo"> <![CDATA[ <?php - if (isset($company->employeeOfTheMonth)) { + if (isset($company->employeeOfTheMonth) { unset($company->employeeOfTheMonth); } ?> @@ -816,7 +756,8 @@ (shown in the table above). The following examples assume the letter instance has been loaded into a data object referenced by the variable - <command>$letter</command>. + <command>$letter</command> + . <example> <title>Getting the SDO_Sequence interface</title> <para> @@ -872,7 +813,7 @@ <![CDATA[ <?php foreach ($letter->getSequence() as $value) { - // ... + ... } ?> ]]> @@ -1168,7 +1109,9 @@ The interface through which a Data Access Service can access a data object's <link linkend='sdo.class.sdodas-changesummary'> - SDO_DAS_ChangeSummary</link>. + SDO_DAS_ChangeSummary + </link> + . The change summary is used by the Data Access Service to check for conflicts when applying changes back to a data source. </para>