From 2c7a373a36cba15317f68c47e7078f3ede7cb23a Mon Sep 17 00:00:00 2001
From: Marcus Boerger <helly@php.net>
Date: Thu, 13 Nov 2003 09:40:08 +0000
Subject: [PATCH] Update inifile and new function dba_key_split()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@144265 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/dba/functions/dba-fetch.xml     | 13 +++++-
 reference/dba/functions/dba-firstkey.xml  |  4 +-
 reference/dba/functions/dba-key-split.xml | 56 +++++++++++++++++++++++
 reference/dba/functions/dba-nextkey.xml   |  4 +-
 reference/dba/reference.xml               | 16 ++++++-
 5 files changed, 86 insertions(+), 7 deletions(-)
 create mode 100755 reference/dba/functions/dba-key-split.xml

diff --git a/reference/dba/functions/dba-fetch.xml b/reference/dba/functions/dba-fetch.xml
index 4be39a8a19..6c3bea3ec4 100644
--- a/reference/dba/functions/dba-fetch.xml
+++ b/reference/dba/functions/dba-fetch.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
   <refentry id="function.dba-fetch">
    <refnamediv>
@@ -44,7 +44,7 @@
     <para>
      See also: <function>dba_exists</function>,
      <function>dba_delete</function>, <function>dba_insert</function>,
-     and <function>dba_replace</function>.
+     <function>dba_replace</function> and <function>dba_key_split</function>.
     </para>
     <para>
      <note>
@@ -54,6 +54,15 @@
       </simpara>
      </note>
     </para>
+    <para>
+     <note>
+      <simpara>
+       When working with inifiles this function accepts arrays as keys
+       where index 0 is the group and index 1 is the value name. See:
+       <function>dba_key_split</function>.
+      </simpara>
+     </note>
+    </para>
    </refsect1>
   </refentry>
 
diff --git a/reference/dba/functions/dba-firstkey.xml b/reference/dba/functions/dba-firstkey.xml
index 3be4a9fd57..028e992ecf 100644
--- a/reference/dba/functions/dba-firstkey.xml
+++ b/reference/dba/functions/dba-firstkey.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
   <refentry id="function.dba-firstkey">
    <refnamediv>
@@ -28,7 +28,7 @@
     </para>
     <para>
      See also:
-     <function>dba_nextkey</function>
+     <function>dba_firstkey</function>, <function>dba_key_split</function>
      and example 2 in the <link linkend="dba.examples">DBA examples</link>
     </para>
    </refsect1>
diff --git a/reference/dba/functions/dba-key-split.xml b/reference/dba/functions/dba-key-split.xml
new file mode 100755
index 0000000000..d5a0df94f4
--- /dev/null
+++ b/reference/dba/functions/dba-key-split.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+<!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
+  <refentry id="function.dba-key-split">
+   <refnamediv>
+    <refname>dba_key_split</refname>
+    <refpurpose>Splits a key in string representation into array representation</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>array|false</type><methodname>dba_key_split</methodname>
+      <methodparam><type>string|false</type><parameter>key</parameter></methodparam>
+     </methodsynopsis>
+    <para>
+     <function>dba_key_split</function> returns &false; if key is NULL of
+     &false; or an array of the form array(0=>group,1=>value_name).
+    </para>
+    <para>
+     <parameter>key</parameter> the key in string representation.
+    </para>
+    <para>
+     See also:
+     <function>dba_firstkey</function>, <function>dba_nextkey</function>
+     and <function>dba_fetch</function>.
+    </para>
+    <para>
+     <note>
+      <simpara>
+       This function is available since PHP 5.0.0.
+      </simpara>
+     </note>
+    </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
+-->
diff --git a/reference/dba/functions/dba-nextkey.xml b/reference/dba/functions/dba-nextkey.xml
index 4981a27cee..9639f3781d 100644
--- a/reference/dba/functions/dba-nextkey.xml
+++ b/reference/dba/functions/dba-nextkey.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/dba.xml, last change in rev 1.2 -->
   <refentry id="function.dba-nextkey">
    <refnamediv>
@@ -27,7 +27,7 @@
     </para>
     <para>
      See also:
-     <function>dba_firstkey</function>
+     <function>dba_firstkey</function>, <function>dba_key_split</function>
      and example 2 in the <link linkend="dba.examples">DBA examples</link>
     </para>
    </refsect1>
diff --git a/reference/dba/reference.xml b/reference/dba/reference.xml
index b8c02fd8e3..07874e1723 100644
--- a/reference/dba/reference.xml
+++ b/reference/dba/reference.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
  <reference id="ref.dba">
   <title>Database (dbm-style) abstraction layer functions</title>
   <titleabbrev>dba</titleabbrev>
@@ -122,6 +122,20 @@
         </entry>
        </row>
 
+       <row>
+        <entry><literal>flatfile</literal></entry>
+        <entry>
+         This is available since PHP 4.3.3 to be able to modify php.ini files 
+         from within php scripts. When working with ini files you can pass arrays 
+         of the form array(0=>group,1=>value_name) or strings of the form 
+         "[group]value_name" where group is optional. As the functions 
+         <function>dba_firstkey</function> and <function>dba_nextkey</function>
+         return string representations of the key there is a new function
+         <function>dba_key_split</function> available since PHP 5 which allows
+         to convert the string keys into array keys without loosing &false;.
+        </entry>
+       </row>
+
       </tbody>
      </tgroup>
     </table>