Better to start more than a year late than never... (?)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@22922 c90b9560-bf6c-de11-be94-00142212c4b1

functions/ibase.xml

@@ -29,9 +29,23 @@
      <paramdef>string 
       <parameter><optional>password</optional></parameter>
      </paramdef>
+     <paramdef>string 
+      <parameter><optional>charset</optional></parameter>
+     </paramdef>
+     <paramdef>string 
+      <parameter><optional>role</optional></parameter>
+     </paramdef>
     </funcsynopsis>
     <para>
-     Opens a connection to an InterBase database.
+     Establishes a connection to a InterBase server. The database argument
+     has to be a valid path to database file. Username and password can also
+     be specified with PHP configuration directives ibase.default_user and
+     ibase.default_password. In case a second call is made to
+     <function>ibase_connect</function> with the same arguments, no new link
+     will be established, but instead, the link identifier of the already opened
+     link will be returned. The link to the server will be closed as soon as the
+     execution of the script ends, unless it's closed earlier by explicitly calling
+     <function>ibase_close</function>. 
      <example>
       <title><function>Ibase_connect</function> example</title>
       <programlisting role="php">
@@ -45,6 +59,12 @@ ibase_close ($dbh);
       </programlisting>
      </example>
     </para>
+    <note>
+     <para>
+      <parameter>role</parameter> was added in PHP4-RC2. It is functional
+       only with InterBase 5 and versions higher than that.
+     </para>
+    </note>
     <para>
      See also: <function>ibase_pconnect</function>.
     </para>
@@ -69,12 +89,29 @@ ibase_close ($dbh);
      <paramdef>string 
       <parameter><optional>password</optional></parameter>
      </paramdef>
+     <paramdef>string 
+      <parameter><optional>charset</optional></parameter>
+     </paramdef>
+     <paramdef>string 
+      <parameter><optional>role</optional></parameter>
+     </paramdef>
     </funcsynopsis>
-    <simpara>
-     Opens a persistent connection to an Interbase database.
-    </simpara>
     <para>
-     See also <function>ibase_connect</function>.
+     <function>ibase_pconnect</function> acts very much like
+     <function>ibase_connect</function> with two major differences.
+     First, when connecting, the function will first try to find a
+     (persistent) link that's already opened with the same parameters.
+     If one is found, an identifier for it will be returned instead of
+     opening a new connection. Second, the connection to the InterBase
+     server will not be closed when the execution of the script ends.
+     Instead, the link will remain open for future use
+     (<function>ibase_close</function> will not close links established
+     by <function>ibase_pconnect</function>). This type of link is
+     therefore called 'persistent'.
+    </para>
+    <para>
+     See also <function>ibase_connect</function> for the meaning of
+     parameters passed to this function. They are exactly the same.
     </para>
    </refsect1>
   </refentry>
@@ -95,8 +132,11 @@ ibase_close ($dbh);
      </paramdef>
     </funcsynopsis>
     <para>
-     Close a connection to an InterBase database.  This function takes
+     Closes the link to an InterBase database that's associated with
      a connection id returned from <function>ibase_connect</function>.
+     If the connection id is omitted, the last opened link is assumed.
+     Default transaction on link is committed, other transactions are
+     rolled back. 
     </para>
    </refsect1>
   </refentry>
@@ -119,11 +159,20 @@ ibase_close ($dbh);
      </paramdef>
     </funcsynopsis>
     <simpara>
-     Performs a query on a InterBase database, returning a result
+     Performs a query on an InterBase database, returning a result
      identifier for use with <function>ibase_fetch_row</function>,
      <function>ibase_free_result</function> and
      <function>ibase_free_query</function>.
     </simpara>
+    <note>
+     <para>
+      Although this function supports variable binding to parameter
+      placeholders, there is not very much meaning using this capability
+      with it. For real life use and an example, see
+      <function>ibase_prepare</function> and
+      <function>ibase_execute</function>.
+     </para>
+    </note>
    </refsect1>
   </refentry>
 
@@ -215,39 +264,12 @@ ibase_close ($dbh);
      <paramdef>string <parameter>query</parameter></paramdef>
     </funcsynopsis>
     <simpara>
-     Prepare a query for later binding of parameter placeholders (via
-     <function>ibase_bind</function>) and execution (via
-     <function>ibase_execute</function>).
+     Prepare a query for later binding of parameter placeholders and
+     execution (via <function>ibase_execute</function>).
     </simpara>
    </refsect1>
   </refentry>
 
-  <refentry id="function.ibase-bind">
-   <refnamediv>
-    <refname>ibase_bind</refname>
-    <refpurpose>
-     Bind placeholder parameters from a previously prepared query
-    </refpurpose>
-   </refnamediv>
-   <refsect1>
-    <title>Description</title>
-    <funcsynopsis>
-     <funcdef>int <function>ibase_bind</function></funcdef>
-     <paramdef>int <parameter>query</parameter></paramdef>
-    </funcsynopsis>
-    <simpara>
-     Bind Parameters from a query prepared by
-     <function>ibase_prepare</function>.
-    </simpara>
-    <note>
-     <para>
-      <function>Ibase_bind</function> is currently not functional in
-      PHP4 
-     </para>
-    </note>
-   </refsect1>
-  </refentry>
-
   <refentry id="function.ibase-execute">
    <refnamediv>
     <refname>ibase_execute</refname>