svn: /phpdoc/en/trunk/reference/oci8/ functions/oci-bind-array-by-name.xml functions/oci-client-version.xml functions/oci-server-version.xml
versions.xml

sixd Fri, 10 Jun 2011 17:43:15 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=312018 Log: Document new oci_client_version() function and tidy up oci_server_version() descriptions Changed paths: U phpdoc/en/trunk/reference/oci8/functions/oci-bind-array-by-name.xml A phpdoc/en/trunk/reference/oci8/functions/oci-client-version.xml U phpdoc/en/trunk/reference/oci8/functions/oci-server-version.xml U phpdoc/en/trunk/reference/oci8/versions.xml Modified: phpdoc/en/trunk/reference/oci8/functions/oci-bind-array-by-name.xml =================================================================== --- phpdoc/en/trunk/reference/oci8/functions/oci-bind-array-by-name.xml 2011-06-10 17:38:07 UTC (rev 312017) +++ phpdoc/en/trunk/reference/oci8/functions/oci-bind-array-by-name.xml 2011-06-10 17:43:15 UTC (rev 312018) @@ -211,15 +211,6 @@ </para> </refsect1> - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - This function is available since OCI8 release 1.2. - </para> - </note> - </refsect1> - </refentry> <!-- Keep this comment at the end of the file Added: phpdoc/en/trunk/reference/oci8/functions/oci-client-version.xml =================================================================== --- phpdoc/en/trunk/reference/oci8/functions/oci-client-version.xml (rev 0) +++ phpdoc/en/trunk/reference/oci8/functions/oci-client-version.xml 2011-06-10 17:43:15 UTC (rev 312018) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision: 297028 $ --> +<refentry xml:id="function.oci-client-version" xmlns="http://docbook.org/ns/docbook"> + <refnamediv> + <refname>oci_client_version</refname> + <refpurpose>Returns the Oracle client library version</refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>string</type><methodname>oci_client_version</methodname> + <void /> + </methodsynopsis> + <para> + Returns a string containing the version number of the Oracle C client library that PHP is linked with. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + None + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the version number as a string. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title><function>oci_client_version</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php + echo "Client Version: " . oci_client_version(); // Client version: 11.2.0.2 +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + Oracle libraries before 10gR2 do not have the underlying + functionality to get the client library version number. The + string "Unknown" will be returned in this case. + </para> + </note> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_server_version</function></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:"~/.phpdoc/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 +--> Modified: phpdoc/en/trunk/reference/oci8/functions/oci-server-version.xml =================================================================== --- phpdoc/en/trunk/reference/oci8/functions/oci-server-version.xml 2011-06-10 17:38:07 UTC (rev 312017) +++ phpdoc/en/trunk/reference/oci8/functions/oci-server-version.xml 2011-06-10 17:43:15 UTC (rev 312018) @@ -3,7 +3,7 @@ <refentry xml:id="function.oci-server-version" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>oci_server_version</refname> - <refpurpose>Returns server version</refpurpose> + <refpurpose>Returns the Oracle Database version</refpurpose> </refnamediv> <refsect1 role="description"> @@ -13,8 +13,7 @@ <methodparam><type>resource</type><parameter>connection</parameter></methodparam> </methodsynopsis> <para> - Returns a string with version information of the Oracle server, which uses - the provided <parameter>connection</parameter>. + Returns a string with the Oracle Database version and available options </para> </refsect1> @@ -50,7 +49,13 @@ <?php $conn = oci_connect("scott", "tiger"); echo "Server Version: " . oci_server_version($conn); + + // Displays: + // Server Version: Oracle Database 11g Enterprise Edition Release 11.2.0.1.0 - 64bit Production + // With the Partitioning, OLAP, Data Mining and Real Application Testing option + oci_close($conn); + ?> ]]> </programlisting> @@ -63,13 +68,20 @@ <note> <para> In PHP versions before 5.0.0 you must use <function>ociserverversion</function> instead. - This name still can be used, it was left as alias of - <function>oci_server_version</function> for downwards compatability. - This, however, is deprecated and not recommended. + This old name still can be used. However it is deprecated and not recommended. </para> </note> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>oci_client_version</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file Modified: phpdoc/en/trunk/reference/oci8/versions.xml =================================================================== --- phpdoc/en/trunk/reference/oci8/versions.xml 2011-06-10 17:38:07 UTC (rev 312017) +++ phpdoc/en/trunk/reference/oci8/versions.xml 2011-06-10 17:43:15 UTC (rev 312018) @@ -8,6 +8,7 @@ <function name='oci_bind_array_by_name' from='PHP 5 &gt;= 5.1.2, PECL OCI8 &gt;= 1.2.0'/> <function name='oci_bind_by_name' from='PHP 5, PECL OCI8 &gt;= 1.1.0'/> <function name='oci_cancel' from='PHP 5, PECL OCI8 &gt;= 1.1.0'/> + <function name='oci_client_version' from='PHP 5.3.7, PECL OCI8 &gt;= 1.4.6'/> <function name='oci_close' from='PHP 5, PECL OCI8 &gt;= 1.1.0'/> <function name='oci_collection_append' from='PHP 5, PECL OCI8 &gt;= 1.1.0'/> <function name='oci_collection_assign' from='PHP 5, PECL OCI8 &gt;= 1.1.0'/>