From 5a47d0af3581d136ee0bc0ee0c11c6379cc6023b Mon Sep 17 00:00:00 2001
From: Dan Scott <dbs@php.net>
Date: Fri, 9 Dec 2005 23:40:16 +0000
Subject: [PATCH] Add PDO_INFORMIX documentation.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@202538 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pdo_informix/configure.xml |  46 +++++++++
 reference/pdo_informix/reference.xml | 139 +++++++++++++++++++++++++++
 2 files changed, 185 insertions(+)
 create mode 100644 reference/pdo_informix/configure.xml
 create mode 100644 reference/pdo_informix/reference.xml

diff --git a/reference/pdo_informix/configure.xml b/reference/pdo_informix/configure.xml
new file mode 100644
index 0000000000..fdd7aa49d2
--- /dev/null
+++ b/reference/pdo_informix/configure.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<section id="ref.pdo-informix.installation">
+ &reftitle.install;
+ <para>
+  To build the PDO_INFORMIX extension, the Informix Client SDK 2.81 UC1 or
+  higher must be installed on the same system as PHP. The Informix Client
+  SDK is available from the <ulink url="&url.informix.csdk;">IBM Informix
+  Support Site</ulink>.
+ </para>
+ <para>
+  PDO_INFORMIX is a <ulink url="&url.pecl;">PECL</ulink> extension, so
+  follow the instructions in <xref linkend='install.pecl' /> to install the
+  PDO_INFORMIX extension. Issue the <command>configure</command> command
+  to point to the location of your Informix Client SDK header files and
+  libraries as follows:
+  <screen>
+<![CDATA[
+   bash$ ./configure --with-pdo-informix=/path/to/SDK[,shared]
+]]>
+  </screen>
+  The <command>configure</command> command defaults to the value of the
+  <literal>INFORMIXDIR</literal> environment variable.
+ </para>
+</section>
+
+<!-- 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
+-->
diff --git a/reference/pdo_informix/reference.xml b/reference/pdo_informix/reference.xml
new file mode 100644
index 0000000000..dc92a17800
--- /dev/null
+++ b/reference/pdo_informix/reference.xml
@@ -0,0 +1,139 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+<!-- Purpose: database.vendors -->
+<!-- Membership: external, pecl -->
+
+ <reference id="ref.pdo-informix">
+  <title>Informix and DB2 functions (PDO_INFORMIX)</title>
+  <titleabbrev>Informix and DB2 (PDO)</titleabbrev>
+  <partintro>
+
+   <section id="pdo-informix.intro">
+    &reftitle.intro;
+    <para>
+     PDO_INFORMIX is a driver that implements the <link linkend="ref.pdo">PHP Data
+     Objects (PDO)</link> interface to enable access from PHP to Informix databases.
+    </para>
+   </section>
+
+   <!-- Information found in configure.xml -->
+   &reference.pdo-informix.configure;
+
+   <section id="ref.pdo-informix.features.cursors">
+    <title>Scrollable cursors</title>
+    <para>
+     PDO_INFORMIX supports scrollable cursors; however, they are not enabled
+     by default. To enable scrollable cursor support, you must either set
+     <userinput>ENABLESCROLLABLECURSORS=1</userinput> in the corresponding ODBC
+     connection settings in <filename>odbc.ini</filename> or pass
+     the <userinput>EnableScrollableCursors=1</userinput> clause in the DSN
+     connection string.
+    </para>
+   </section>
+
+  </partintro>
+
+  <refentry id="ref.pdo-informix.connection">
+   <refnamediv>
+    <refname>PDO_INFORMIX DSN</refname>
+    <refpurpose>Connecting to Informix databases</refpurpose>
+   </refnamediv>
+
+   <refsect1 role="description">
+    &reftitle.description;
+    <para>
+     The PDO_INFORMIX Data Source Name (DSN) is based on the Informix ODBC DSN
+     string. Details on configuring an Informix ODBC DSN are available from
+     the <ulink url="&url.informix.dsn;">Informix Dynamic Server Information
+      Center</ulink>. The major components of the PDO_INFORMIX DSN are:
+     <variablelist>
+      <varlistentry>
+       <term>DSN prefix</term>
+       <listitem>
+        <para>
+        The DSN prefix is <userinput>informix:</userinput>.
+        </para>
+       </listitem>
+      </varlistentry>
+      <varlistentry>
+       <term><constant>DSN</constant></term>
+       <listitem>
+        <para>
+         The DSN can be either a data source setup using
+         <filename>odbc.ini</filename> or a complete <ulink
+          url="&url.informix.connectionstring;">connection string</ulink>.
+        </para>
+       </listitem>
+      </varlistentry>
+     </variablelist>
+    </para>
+   </refsect1>
+   <refsect1 role="examples">
+    &reftitle.examples;
+    <para>
+     <example>
+      <title>PDO_INFORMIX DSN example using <filename>odbc.ini</filename></title>
+      <para>
+       The following example shows a PDO_INFORMIX DSN for connecting to
+       an Informix database cataloged as Infdrv33 in
+       <filename>odbc.ini</filename>:
+       <programlisting><![CDATA[
+$db = new PDO("informix:DSN=Infdrv33", "", "");
+]]></programlisting>
+       <programlisting><![CDATA[
+[ODBC Data Sources]
+Infdrv33=INFORMIX 3.3 32-BIT
+
+[Infdrv33]
+Driver=/opt/informix/csdk_2.81.UC1G2/lib/cli/iclis09b.so
+Description=INFORMIX 3.3 32-BIT
+Database=common_db
+LogonID=testuser
+pwd=testpass
+Servername=ids_server
+DB_LOCALE=en_US.819
+OPTIMIZEAUTOCOMMIT=1
+ENABLESCROLLABLECURSORS=1
+]]></programlisting>
+      </para>
+     </example>
+     <example>
+      <title>PDO_INFORMIX DSN example using a connection string</title>
+      <para>
+       The following example shows a PDO_INFORMIX DSN for connecting to
+       an Informix database named <userinput>common_db</userinput> using the
+       Informix connection string syntax.
+       <programlisting><![CDATA[
+$db = new PDO("informix:host=host.domain.com; service=9800;
+    database=common_db; server=ids_server; protocol=onsoctcp;
+    EnableScrollableCursors=1", "testuser", "tespass");
+]]>
+       </programlisting>
+      </para>
+     </example>
+    
+    </para>
+   </refsect1>
+  </refentry>
+
+ </reference>
+<!-- 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
+-->